]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - drivers/md/dm.c
9b3fe5be0cee5013d53bab2b2e5e5dea1cf7cc04
[karo-tx-linux.git] / drivers / md / dm.c
1 /*
2  * Copyright (C) 2001, 2002 Sistina Software (UK) Limited.
3  * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved.
4  *
5  * This file is released under the GPL.
6  */
7
8 #include "dm.h"
9 #include "dm-uevent.h"
10
11 #include <linux/init.h>
12 #include <linux/module.h>
13 #include <linux/mutex.h>
14 #include <linux/moduleparam.h>
15 #include <linux/blkpg.h>
16 #include <linux/bio.h>
17 #include <linux/mempool.h>
18 #include <linux/slab.h>
19 #include <linux/idr.h>
20 #include <linux/hdreg.h>
21 #include <linux/delay.h>
22 #include <linux/wait.h>
23 #include <linux/kthread.h>
24 #include <linux/ktime.h>
25 #include <linux/elevator.h> /* for rq_end_sector() */
26 #include <linux/blk-mq.h>
27
28 #include <trace/events/block.h>
29
30 #define DM_MSG_PREFIX "core"
31
32 #ifdef CONFIG_PRINTK
33 /*
34  * ratelimit state to be used in DMXXX_LIMIT().
35  */
36 DEFINE_RATELIMIT_STATE(dm_ratelimit_state,
37                        DEFAULT_RATELIMIT_INTERVAL,
38                        DEFAULT_RATELIMIT_BURST);
39 EXPORT_SYMBOL(dm_ratelimit_state);
40 #endif
41
42 /*
43  * Cookies are numeric values sent with CHANGE and REMOVE
44  * uevents while resuming, removing or renaming the device.
45  */
46 #define DM_COOKIE_ENV_VAR_NAME "DM_COOKIE"
47 #define DM_COOKIE_LENGTH 24
48
49 static const char *_name = DM_NAME;
50
51 static unsigned int major = 0;
52 static unsigned int _major = 0;
53
54 static DEFINE_IDR(_minor_idr);
55
56 static DEFINE_SPINLOCK(_minor_lock);
57
58 static void do_deferred_remove(struct work_struct *w);
59
60 static DECLARE_WORK(deferred_remove_work, do_deferred_remove);
61
62 static struct workqueue_struct *deferred_remove_workqueue;
63
64 /*
65  * For bio-based dm.
66  * One of these is allocated per bio.
67  */
68 struct dm_io {
69         struct mapped_device *md;
70         int error;
71         atomic_t io_count;
72         struct bio *bio;
73         unsigned long start_time;
74         spinlock_t endio_lock;
75         struct dm_stats_aux stats_aux;
76 };
77
78 /*
79  * For request-based dm.
80  * One of these is allocated per request.
81  */
82 struct dm_rq_target_io {
83         struct mapped_device *md;
84         struct dm_target *ti;
85         struct request *orig, *clone;
86         struct kthread_work work;
87         int error;
88         union map_info info;
89         struct dm_stats_aux stats_aux;
90         unsigned long duration_jiffies;
91         unsigned n_sectors;
92 };
93
94 /*
95  * For request-based dm - the bio clones we allocate are embedded in these
96  * structs.
97  *
98  * We allocate these with bio_alloc_bioset, using the front_pad parameter when
99  * the bioset is created - this means the bio has to come at the end of the
100  * struct.
101  */
102 struct dm_rq_clone_bio_info {
103         struct bio *orig;
104         struct dm_rq_target_io *tio;
105         struct bio clone;
106 };
107
108 union map_info *dm_get_rq_mapinfo(struct request *rq)
109 {
110         if (rq && rq->end_io_data)
111                 return &((struct dm_rq_target_io *)rq->end_io_data)->info;
112         return NULL;
113 }
114 EXPORT_SYMBOL_GPL(dm_get_rq_mapinfo);
115
116 #define MINOR_ALLOCED ((void *)-1)
117
118 /*
119  * Bits for the md->flags field.
120  */
121 #define DMF_BLOCK_IO_FOR_SUSPEND 0
122 #define DMF_SUSPENDED 1
123 #define DMF_FROZEN 2
124 #define DMF_FREEING 3
125 #define DMF_DELETING 4
126 #define DMF_NOFLUSH_SUSPENDING 5
127 #define DMF_DEFERRED_REMOVE 6
128 #define DMF_SUSPENDED_INTERNALLY 7
129
130 /*
131  * A dummy definition to make RCU happy.
132  * struct dm_table should never be dereferenced in this file.
133  */
134 struct dm_table {
135         int undefined__;
136 };
137
138 /*
139  * Work processed by per-device workqueue.
140  */
141 struct mapped_device {
142         struct srcu_struct io_barrier;
143         struct mutex suspend_lock;
144         atomic_t holders;
145         atomic_t open_count;
146
147         /*
148          * The current mapping.
149          * Use dm_get_live_table{_fast} or take suspend_lock for
150          * dereference.
151          */
152         struct dm_table __rcu *map;
153
154         struct list_head table_devices;
155         struct mutex table_devices_lock;
156
157         unsigned long flags;
158
159         struct request_queue *queue;
160         unsigned type;
161         /* Protect queue and type against concurrent access. */
162         struct mutex type_lock;
163
164         struct target_type *immutable_target_type;
165
166         struct gendisk *disk;
167         char name[16];
168
169         void *interface_ptr;
170
171         /*
172          * A list of ios that arrived while we were suspended.
173          */
174         atomic_t pending[2];
175         wait_queue_head_t wait;
176         struct work_struct work;
177         struct bio_list deferred;
178         spinlock_t deferred_lock;
179
180         /*
181          * Processing queue (flush)
182          */
183         struct workqueue_struct *wq;
184
185         /*
186          * io objects are allocated from here.
187          */
188         mempool_t *io_pool;
189         mempool_t *rq_pool;
190
191         struct bio_set *bs;
192
193         /*
194          * Event handling.
195          */
196         atomic_t event_nr;
197         wait_queue_head_t eventq;
198         atomic_t uevent_seq;
199         struct list_head uevent_list;
200         spinlock_t uevent_lock; /* Protect access to uevent_list */
201
202         /*
203          * freeze/thaw support require holding onto a super block
204          */
205         struct super_block *frozen_sb;
206         struct block_device *bdev;
207
208         /* forced geometry settings */
209         struct hd_geometry geometry;
210
211         /* kobject and completion */
212         struct dm_kobject_holder kobj_holder;
213
214         /* zero-length flush that will be cloned and submitted to targets */
215         struct bio flush_bio;
216
217         /* the number of internal suspends */
218         unsigned internal_suspend_count;
219
220         struct dm_stats stats;
221
222         struct kthread_worker kworker;
223         struct task_struct *kworker_task;
224
225         /* for request-based merge heuristic in dm_request_fn() */
226         unsigned seq_rq_merge_deadline_usecs;
227         int last_rq_rw;
228         sector_t last_rq_pos;
229         ktime_t last_rq_start_time;
230
231         /* for blk-mq request-based DM support */
232         struct blk_mq_tag_set tag_set;
233         bool use_blk_mq;
234 };
235
236 #ifdef CONFIG_DM_MQ_DEFAULT
237 static bool use_blk_mq = true;
238 #else
239 static bool use_blk_mq = false;
240 #endif
241
242 bool dm_use_blk_mq(struct mapped_device *md)
243 {
244         return md->use_blk_mq;
245 }
246
247 /*
248  * For mempools pre-allocation at the table loading time.
249  */
250 struct dm_md_mempools {
251         mempool_t *io_pool;
252         mempool_t *rq_pool;
253         struct bio_set *bs;
254 };
255
256 struct table_device {
257         struct list_head list;
258         atomic_t count;
259         struct dm_dev dm_dev;
260 };
261
262 #define RESERVED_BIO_BASED_IOS          16
263 #define RESERVED_REQUEST_BASED_IOS      256
264 #define RESERVED_MAX_IOS                1024
265 static struct kmem_cache *_io_cache;
266 static struct kmem_cache *_rq_tio_cache;
267 static struct kmem_cache *_rq_cache;
268
269 /*
270  * Bio-based DM's mempools' reserved IOs set by the user.
271  */
272 static unsigned reserved_bio_based_ios = RESERVED_BIO_BASED_IOS;
273
274 /*
275  * Request-based DM's mempools' reserved IOs set by the user.
276  */
277 static unsigned reserved_rq_based_ios = RESERVED_REQUEST_BASED_IOS;
278
279 static unsigned __dm_get_module_param(unsigned *module_param,
280                                       unsigned def, unsigned max)
281 {
282         unsigned param = ACCESS_ONCE(*module_param);
283         unsigned modified_param = 0;
284
285         if (!param)
286                 modified_param = def;
287         else if (param > max)
288                 modified_param = max;
289
290         if (modified_param) {
291                 (void)cmpxchg(module_param, param, modified_param);
292                 param = modified_param;
293         }
294
295         return param;
296 }
297
298 unsigned dm_get_reserved_bio_based_ios(void)
299 {
300         return __dm_get_module_param(&reserved_bio_based_ios,
301                                      RESERVED_BIO_BASED_IOS, RESERVED_MAX_IOS);
302 }
303 EXPORT_SYMBOL_GPL(dm_get_reserved_bio_based_ios);
304
305 unsigned dm_get_reserved_rq_based_ios(void)
306 {
307         return __dm_get_module_param(&reserved_rq_based_ios,
308                                      RESERVED_REQUEST_BASED_IOS, RESERVED_MAX_IOS);
309 }
310 EXPORT_SYMBOL_GPL(dm_get_reserved_rq_based_ios);
311
312 static int __init local_init(void)
313 {
314         int r = -ENOMEM;
315
316         /* allocate a slab for the dm_ios */
317         _io_cache = KMEM_CACHE(dm_io, 0);
318         if (!_io_cache)
319                 return r;
320
321         _rq_tio_cache = KMEM_CACHE(dm_rq_target_io, 0);
322         if (!_rq_tio_cache)
323                 goto out_free_io_cache;
324
325         _rq_cache = kmem_cache_create("dm_clone_request", sizeof(struct request),
326                                       __alignof__(struct request), 0, NULL);
327         if (!_rq_cache)
328                 goto out_free_rq_tio_cache;
329
330         r = dm_uevent_init();
331         if (r)
332                 goto out_free_rq_cache;
333
334         deferred_remove_workqueue = alloc_workqueue("kdmremove", WQ_UNBOUND, 1);
335         if (!deferred_remove_workqueue) {
336                 r = -ENOMEM;
337                 goto out_uevent_exit;
338         }
339
340         _major = major;
341         r = register_blkdev(_major, _name);
342         if (r < 0)
343                 goto out_free_workqueue;
344
345         if (!_major)
346                 _major = r;
347
348         return 0;
349
350 out_free_workqueue:
351         destroy_workqueue(deferred_remove_workqueue);
352 out_uevent_exit:
353         dm_uevent_exit();
354 out_free_rq_cache:
355         kmem_cache_destroy(_rq_cache);
356 out_free_rq_tio_cache:
357         kmem_cache_destroy(_rq_tio_cache);
358 out_free_io_cache:
359         kmem_cache_destroy(_io_cache);
360
361         return r;
362 }
363
364 static void local_exit(void)
365 {
366         flush_scheduled_work();
367         destroy_workqueue(deferred_remove_workqueue);
368
369         kmem_cache_destroy(_rq_cache);
370         kmem_cache_destroy(_rq_tio_cache);
371         kmem_cache_destroy(_io_cache);
372         unregister_blkdev(_major, _name);
373         dm_uevent_exit();
374
375         _major = 0;
376
377         DMINFO("cleaned up");
378 }
379
380 static int (*_inits[])(void) __initdata = {
381         local_init,
382         dm_target_init,
383         dm_linear_init,
384         dm_stripe_init,
385         dm_io_init,
386         dm_kcopyd_init,
387         dm_interface_init,
388         dm_statistics_init,
389 };
390
391 static void (*_exits[])(void) = {
392         local_exit,
393         dm_target_exit,
394         dm_linear_exit,
395         dm_stripe_exit,
396         dm_io_exit,
397         dm_kcopyd_exit,
398         dm_interface_exit,
399         dm_statistics_exit,
400 };
401
402 static int __init dm_init(void)
403 {
404         const int count = ARRAY_SIZE(_inits);
405
406         int r, i;
407
408         for (i = 0; i < count; i++) {
409                 r = _inits[i]();
410                 if (r)
411                         goto bad;
412         }
413
414         return 0;
415
416       bad:
417         while (i--)
418                 _exits[i]();
419
420         return r;
421 }
422
423 static void __exit dm_exit(void)
424 {
425         int i = ARRAY_SIZE(_exits);
426
427         while (i--)
428                 _exits[i]();
429
430         /*
431          * Should be empty by this point.
432          */
433         idr_destroy(&_minor_idr);
434 }
435
436 /*
437  * Block device functions
438  */
439 int dm_deleting_md(struct mapped_device *md)
440 {
441         return test_bit(DMF_DELETING, &md->flags);
442 }
443
444 static int dm_blk_open(struct block_device *bdev, fmode_t mode)
445 {
446         struct mapped_device *md;
447
448         spin_lock(&_minor_lock);
449
450         md = bdev->bd_disk->private_data;
451         if (!md)
452                 goto out;
453
454         if (test_bit(DMF_FREEING, &md->flags) ||
455             dm_deleting_md(md)) {
456                 md = NULL;
457                 goto out;
458         }
459
460         dm_get(md);
461         atomic_inc(&md->open_count);
462 out:
463         spin_unlock(&_minor_lock);
464
465         return md ? 0 : -ENXIO;
466 }
467
468 static void dm_blk_close(struct gendisk *disk, fmode_t mode)
469 {
470         struct mapped_device *md;
471
472         spin_lock(&_minor_lock);
473
474         md = disk->private_data;
475         if (WARN_ON(!md))
476                 goto out;
477
478         if (atomic_dec_and_test(&md->open_count) &&
479             (test_bit(DMF_DEFERRED_REMOVE, &md->flags)))
480                 queue_work(deferred_remove_workqueue, &deferred_remove_work);
481
482         dm_put(md);
483 out:
484         spin_unlock(&_minor_lock);
485 }
486
487 int dm_open_count(struct mapped_device *md)
488 {
489         return atomic_read(&md->open_count);
490 }
491
492 /*
493  * Guarantees nothing is using the device before it's deleted.
494  */
495 int dm_lock_for_deletion(struct mapped_device *md, bool mark_deferred, bool only_deferred)
496 {
497         int r = 0;
498
499         spin_lock(&_minor_lock);
500
501         if (dm_open_count(md)) {
502                 r = -EBUSY;
503                 if (mark_deferred)
504                         set_bit(DMF_DEFERRED_REMOVE, &md->flags);
505         } else if (only_deferred && !test_bit(DMF_DEFERRED_REMOVE, &md->flags))
506                 r = -EEXIST;
507         else
508                 set_bit(DMF_DELETING, &md->flags);
509
510         spin_unlock(&_minor_lock);
511
512         return r;
513 }
514
515 int dm_cancel_deferred_remove(struct mapped_device *md)
516 {
517         int r = 0;
518
519         spin_lock(&_minor_lock);
520
521         if (test_bit(DMF_DELETING, &md->flags))
522                 r = -EBUSY;
523         else
524                 clear_bit(DMF_DEFERRED_REMOVE, &md->flags);
525
526         spin_unlock(&_minor_lock);
527
528         return r;
529 }
530
531 static void do_deferred_remove(struct work_struct *w)
532 {
533         dm_deferred_remove();
534 }
535
536 sector_t dm_get_size(struct mapped_device *md)
537 {
538         return get_capacity(md->disk);
539 }
540
541 struct request_queue *dm_get_md_queue(struct mapped_device *md)
542 {
543         return md->queue;
544 }
545
546 struct dm_stats *dm_get_stats(struct mapped_device *md)
547 {
548         return &md->stats;
549 }
550
551 static int dm_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
552 {
553         struct mapped_device *md = bdev->bd_disk->private_data;
554
555         return dm_get_geometry(md, geo);
556 }
557
558 static int dm_get_live_table_for_ioctl(struct mapped_device *md,
559                 struct dm_target **tgt, struct block_device **bdev,
560                 fmode_t *mode, int *srcu_idx)
561 {
562         struct dm_table *map;
563         int r;
564
565 retry:
566         r = -ENOTTY;
567         map = dm_get_live_table(md, srcu_idx);
568         if (!map || !dm_table_get_size(map))
569                 goto out;
570
571         /* We only support devices that have a single target */
572         if (dm_table_get_num_targets(map) != 1)
573                 goto out;
574
575         *tgt = dm_table_get_target(map, 0);
576
577         if (!(*tgt)->type->prepare_ioctl)
578                 goto out;
579
580         if (dm_suspended_md(md)) {
581                 r = -EAGAIN;
582                 goto out;
583         }
584
585         r = (*tgt)->type->prepare_ioctl(*tgt, bdev, mode);
586         if (r < 0)
587                 goto out;
588
589         return r;
590
591 out:
592         dm_put_live_table(md, *srcu_idx);
593         if (r == -ENOTCONN) {
594                 msleep(10);
595                 goto retry;
596         }
597         return r;
598 }
599
600 static int dm_blk_ioctl(struct block_device *bdev, fmode_t mode,
601                         unsigned int cmd, unsigned long arg)
602 {
603         struct mapped_device *md = bdev->bd_disk->private_data;
604         struct dm_target *tgt;
605         int srcu_idx, r;
606
607         r = dm_get_live_table_for_ioctl(md, &tgt, &bdev, &mode, &srcu_idx);
608         if (r < 0)
609                 return r;
610
611         if (r > 0) {
612                 /*
613                  * Target determined this ioctl is being issued against
614                  * a logical partition of the parent bdev; so extra
615                  * validation is needed.
616                  */
617                 r = scsi_verify_blk_ioctl(NULL, cmd);
618                 if (r)
619                         goto out;
620         }
621
622         r =  __blkdev_driver_ioctl(bdev, mode, cmd, arg);
623 out:
624         dm_put_live_table(md, srcu_idx);
625         return r;
626 }
627
628 static struct dm_io *alloc_io(struct mapped_device *md)
629 {
630         return mempool_alloc(md->io_pool, GFP_NOIO);
631 }
632
633 static void free_io(struct mapped_device *md, struct dm_io *io)
634 {
635         mempool_free(io, md->io_pool);
636 }
637
638 static void free_tio(struct mapped_device *md, struct dm_target_io *tio)
639 {
640         bio_put(&tio->clone);
641 }
642
643 static struct dm_rq_target_io *alloc_rq_tio(struct mapped_device *md,
644                                             gfp_t gfp_mask)
645 {
646         return mempool_alloc(md->io_pool, gfp_mask);
647 }
648
649 static void free_rq_tio(struct dm_rq_target_io *tio)
650 {
651         mempool_free(tio, tio->md->io_pool);
652 }
653
654 static struct request *alloc_clone_request(struct mapped_device *md,
655                                            gfp_t gfp_mask)
656 {
657         return mempool_alloc(md->rq_pool, gfp_mask);
658 }
659
660 static void free_clone_request(struct mapped_device *md, struct request *rq)
661 {
662         mempool_free(rq, md->rq_pool);
663 }
664
665 static int md_in_flight(struct mapped_device *md)
666 {
667         return atomic_read(&md->pending[READ]) +
668                atomic_read(&md->pending[WRITE]);
669 }
670
671 static void start_io_acct(struct dm_io *io)
672 {
673         struct mapped_device *md = io->md;
674         struct bio *bio = io->bio;
675         int cpu;
676         int rw = bio_data_dir(bio);
677
678         io->start_time = jiffies;
679
680         cpu = part_stat_lock();
681         part_round_stats(cpu, &dm_disk(md)->part0);
682         part_stat_unlock();
683         atomic_set(&dm_disk(md)->part0.in_flight[rw],
684                 atomic_inc_return(&md->pending[rw]));
685
686         if (unlikely(dm_stats_used(&md->stats)))
687                 dm_stats_account_io(&md->stats, bio->bi_rw, bio->bi_iter.bi_sector,
688                                     bio_sectors(bio), false, 0, &io->stats_aux);
689 }
690
691 static void end_io_acct(struct dm_io *io)
692 {
693         struct mapped_device *md = io->md;
694         struct bio *bio = io->bio;
695         unsigned long duration = jiffies - io->start_time;
696         int pending;
697         int rw = bio_data_dir(bio);
698
699         generic_end_io_acct(rw, &dm_disk(md)->part0, io->start_time);
700
701         if (unlikely(dm_stats_used(&md->stats)))
702                 dm_stats_account_io(&md->stats, bio->bi_rw, bio->bi_iter.bi_sector,
703                                     bio_sectors(bio), true, duration, &io->stats_aux);
704
705         /*
706          * After this is decremented the bio must not be touched if it is
707          * a flush.
708          */
709         pending = atomic_dec_return(&md->pending[rw]);
710         atomic_set(&dm_disk(md)->part0.in_flight[rw], pending);
711         pending += atomic_read(&md->pending[rw^0x1]);
712
713         /* nudge anyone waiting on suspend queue */
714         if (!pending)
715                 wake_up(&md->wait);
716 }
717
718 /*
719  * Add the bio to the list of deferred io.
720  */
721 static void queue_io(struct mapped_device *md, struct bio *bio)
722 {
723         unsigned long flags;
724
725         spin_lock_irqsave(&md->deferred_lock, flags);
726         bio_list_add(&md->deferred, bio);
727         spin_unlock_irqrestore(&md->deferred_lock, flags);
728         queue_work(md->wq, &md->work);
729 }
730
731 /*
732  * Everyone (including functions in this file), should use this
733  * function to access the md->map field, and make sure they call
734  * dm_put_live_table() when finished.
735  */
736 struct dm_table *dm_get_live_table(struct mapped_device *md, int *srcu_idx) __acquires(md->io_barrier)
737 {
738         *srcu_idx = srcu_read_lock(&md->io_barrier);
739
740         return srcu_dereference(md->map, &md->io_barrier);
741 }
742
743 void dm_put_live_table(struct mapped_device *md, int srcu_idx) __releases(md->io_barrier)
744 {
745         srcu_read_unlock(&md->io_barrier, srcu_idx);
746 }
747
748 void dm_sync_table(struct mapped_device *md)
749 {
750         synchronize_srcu(&md->io_barrier);
751         synchronize_rcu_expedited();
752 }
753
754 /*
755  * A fast alternative to dm_get_live_table/dm_put_live_table.
756  * The caller must not block between these two functions.
757  */
758 static struct dm_table *dm_get_live_table_fast(struct mapped_device *md) __acquires(RCU)
759 {
760         rcu_read_lock();
761         return rcu_dereference(md->map);
762 }
763
764 static void dm_put_live_table_fast(struct mapped_device *md) __releases(RCU)
765 {
766         rcu_read_unlock();
767 }
768
769 /*
770  * Open a table device so we can use it as a map destination.
771  */
772 static int open_table_device(struct table_device *td, dev_t dev,
773                              struct mapped_device *md)
774 {
775         static char *_claim_ptr = "I belong to device-mapper";
776         struct block_device *bdev;
777
778         int r;
779
780         BUG_ON(td->dm_dev.bdev);
781
782         bdev = blkdev_get_by_dev(dev, td->dm_dev.mode | FMODE_EXCL, _claim_ptr);
783         if (IS_ERR(bdev))
784                 return PTR_ERR(bdev);
785
786         r = bd_link_disk_holder(bdev, dm_disk(md));
787         if (r) {
788                 blkdev_put(bdev, td->dm_dev.mode | FMODE_EXCL);
789                 return r;
790         }
791
792         td->dm_dev.bdev = bdev;
793         return 0;
794 }
795
796 /*
797  * Close a table device that we've been using.
798  */
799 static void close_table_device(struct table_device *td, struct mapped_device *md)
800 {
801         if (!td->dm_dev.bdev)
802                 return;
803
804         bd_unlink_disk_holder(td->dm_dev.bdev, dm_disk(md));
805         blkdev_put(td->dm_dev.bdev, td->dm_dev.mode | FMODE_EXCL);
806         td->dm_dev.bdev = NULL;
807 }
808
809 static struct table_device *find_table_device(struct list_head *l, dev_t dev,
810                                               fmode_t mode) {
811         struct table_device *td;
812
813         list_for_each_entry(td, l, list)
814                 if (td->dm_dev.bdev->bd_dev == dev && td->dm_dev.mode == mode)
815                         return td;
816
817         return NULL;
818 }
819
820 int dm_get_table_device(struct mapped_device *md, dev_t dev, fmode_t mode,
821                         struct dm_dev **result) {
822         int r;
823         struct table_device *td;
824
825         mutex_lock(&md->table_devices_lock);
826         td = find_table_device(&md->table_devices, dev, mode);
827         if (!td) {
828                 td = kmalloc(sizeof(*td), GFP_KERNEL);
829                 if (!td) {
830                         mutex_unlock(&md->table_devices_lock);
831                         return -ENOMEM;
832                 }
833
834                 td->dm_dev.mode = mode;
835                 td->dm_dev.bdev = NULL;
836
837                 if ((r = open_table_device(td, dev, md))) {
838                         mutex_unlock(&md->table_devices_lock);
839                         kfree(td);
840                         return r;
841                 }
842
843                 format_dev_t(td->dm_dev.name, dev);
844
845                 atomic_set(&td->count, 0);
846                 list_add(&td->list, &md->table_devices);
847         }
848         atomic_inc(&td->count);
849         mutex_unlock(&md->table_devices_lock);
850
851         *result = &td->dm_dev;
852         return 0;
853 }
854 EXPORT_SYMBOL_GPL(dm_get_table_device);
855
856 void dm_put_table_device(struct mapped_device *md, struct dm_dev *d)
857 {
858         struct table_device *td = container_of(d, struct table_device, dm_dev);
859
860         mutex_lock(&md->table_devices_lock);
861         if (atomic_dec_and_test(&td->count)) {
862                 close_table_device(td, md);
863                 list_del(&td->list);
864                 kfree(td);
865         }
866         mutex_unlock(&md->table_devices_lock);
867 }
868 EXPORT_SYMBOL(dm_put_table_device);
869
870 static void free_table_devices(struct list_head *devices)
871 {
872         struct list_head *tmp, *next;
873
874         list_for_each_safe(tmp, next, devices) {
875                 struct table_device *td = list_entry(tmp, struct table_device, list);
876
877                 DMWARN("dm_destroy: %s still exists with %d references",
878                        td->dm_dev.name, atomic_read(&td->count));
879                 kfree(td);
880         }
881 }
882
883 /*
884  * Get the geometry associated with a dm device
885  */
886 int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo)
887 {
888         *geo = md->geometry;
889
890         return 0;
891 }
892
893 /*
894  * Set the geometry of a device.
895  */
896 int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo)
897 {
898         sector_t sz = (sector_t)geo->cylinders * geo->heads * geo->sectors;
899
900         if (geo->start > sz) {
901                 DMWARN("Start sector is beyond the geometry limits.");
902                 return -EINVAL;
903         }
904
905         md->geometry = *geo;
906
907         return 0;
908 }
909
910 /*-----------------------------------------------------------------
911  * CRUD START:
912  *   A more elegant soln is in the works that uses the queue
913  *   merge fn, unfortunately there are a couple of changes to
914  *   the block layer that I want to make for this.  So in the
915  *   interests of getting something for people to use I give
916  *   you this clearly demarcated crap.
917  *---------------------------------------------------------------*/
918
919 static int __noflush_suspending(struct mapped_device *md)
920 {
921         return test_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
922 }
923
924 /*
925  * Decrements the number of outstanding ios that a bio has been
926  * cloned into, completing the original io if necc.
927  */
928 static void dec_pending(struct dm_io *io, int error)
929 {
930         unsigned long flags;
931         int io_error;
932         struct bio *bio;
933         struct mapped_device *md = io->md;
934
935         /* Push-back supersedes any I/O errors */
936         if (unlikely(error)) {
937                 spin_lock_irqsave(&io->endio_lock, flags);
938                 if (!(io->error > 0 && __noflush_suspending(md)))
939                         io->error = error;
940                 spin_unlock_irqrestore(&io->endio_lock, flags);
941         }
942
943         if (atomic_dec_and_test(&io->io_count)) {
944                 if (io->error == DM_ENDIO_REQUEUE) {
945                         /*
946                          * Target requested pushing back the I/O.
947                          */
948                         spin_lock_irqsave(&md->deferred_lock, flags);
949                         if (__noflush_suspending(md))
950                                 bio_list_add_head(&md->deferred, io->bio);
951                         else
952                                 /* noflush suspend was interrupted. */
953                                 io->error = -EIO;
954                         spin_unlock_irqrestore(&md->deferred_lock, flags);
955                 }
956
957                 io_error = io->error;
958                 bio = io->bio;
959                 end_io_acct(io);
960                 free_io(md, io);
961
962                 if (io_error == DM_ENDIO_REQUEUE)
963                         return;
964
965                 if ((bio->bi_rw & REQ_FLUSH) && bio->bi_iter.bi_size) {
966                         /*
967                          * Preflush done for flush with data, reissue
968                          * without REQ_FLUSH.
969                          */
970                         bio->bi_rw &= ~REQ_FLUSH;
971                         queue_io(md, bio);
972                 } else {
973                         /* done with normal IO or empty flush */
974                         trace_block_bio_complete(md->queue, bio, io_error);
975                         bio->bi_error = io_error;
976                         bio_endio(bio);
977                 }
978         }
979 }
980
981 static void disable_write_same(struct mapped_device *md)
982 {
983         struct queue_limits *limits = dm_get_queue_limits(md);
984
985         /* device doesn't really support WRITE SAME, disable it */
986         limits->max_write_same_sectors = 0;
987 }
988
989 static void clone_endio(struct bio *bio)
990 {
991         int error = bio->bi_error;
992         int r = error;
993         struct dm_target_io *tio = container_of(bio, struct dm_target_io, clone);
994         struct dm_io *io = tio->io;
995         struct mapped_device *md = tio->io->md;
996         dm_endio_fn endio = tio->ti->type->end_io;
997
998         if (endio) {
999                 r = endio(tio->ti, bio, error);
1000                 if (r < 0 || r == DM_ENDIO_REQUEUE)
1001                         /*
1002                          * error and requeue request are handled
1003                          * in dec_pending().
1004                          */
1005                         error = r;
1006                 else if (r == DM_ENDIO_INCOMPLETE)
1007                         /* The target will handle the io */
1008                         return;
1009                 else if (r) {
1010                         DMWARN("unimplemented target endio return value: %d", r);
1011                         BUG();
1012                 }
1013         }
1014
1015         if (unlikely(r == -EREMOTEIO && (bio->bi_rw & REQ_WRITE_SAME) &&
1016                      !bdev_get_queue(bio->bi_bdev)->limits.max_write_same_sectors))
1017                 disable_write_same(md);
1018
1019         free_tio(md, tio);
1020         dec_pending(io, error);
1021 }
1022
1023 /*
1024  * Partial completion handling for request-based dm
1025  */
1026 static void end_clone_bio(struct bio *clone)
1027 {
1028         struct dm_rq_clone_bio_info *info =
1029                 container_of(clone, struct dm_rq_clone_bio_info, clone);
1030         struct dm_rq_target_io *tio = info->tio;
1031         struct bio *bio = info->orig;
1032         unsigned int nr_bytes = info->orig->bi_iter.bi_size;
1033
1034         bio_put(clone);
1035
1036         if (tio->error)
1037                 /*
1038                  * An error has already been detected on the request.
1039                  * Once error occurred, just let clone->end_io() handle
1040                  * the remainder.
1041                  */
1042                 return;
1043         else if (bio->bi_error) {
1044                 /*
1045                  * Don't notice the error to the upper layer yet.
1046                  * The error handling decision is made by the target driver,
1047                  * when the request is completed.
1048                  */
1049                 tio->error = bio->bi_error;
1050                 return;
1051         }
1052
1053         /*
1054          * I/O for the bio successfully completed.
1055          * Notice the data completion to the upper layer.
1056          */
1057
1058         /*
1059          * bios are processed from the head of the list.
1060          * So the completing bio should always be rq->bio.
1061          * If it's not, something wrong is happening.
1062          */
1063         if (tio->orig->bio != bio)
1064                 DMERR("bio completion is going in the middle of the request");
1065
1066         /*
1067          * Update the original request.
1068          * Do not use blk_end_request() here, because it may complete
1069          * the original request before the clone, and break the ordering.
1070          */
1071         blk_update_request(tio->orig, 0, nr_bytes);
1072 }
1073
1074 static struct dm_rq_target_io *tio_from_request(struct request *rq)
1075 {
1076         return (rq->q->mq_ops ? blk_mq_rq_to_pdu(rq) : rq->special);
1077 }
1078
1079 static void rq_end_stats(struct mapped_device *md, struct request *orig)
1080 {
1081         if (unlikely(dm_stats_used(&md->stats))) {
1082                 struct dm_rq_target_io *tio = tio_from_request(orig);
1083                 tio->duration_jiffies = jiffies - tio->duration_jiffies;
1084                 dm_stats_account_io(&md->stats, orig->cmd_flags, blk_rq_pos(orig),
1085                                     tio->n_sectors, true, tio->duration_jiffies,
1086                                     &tio->stats_aux);
1087         }
1088 }
1089
1090 /*
1091  * Don't touch any member of the md after calling this function because
1092  * the md may be freed in dm_put() at the end of this function.
1093  * Or do dm_get() before calling this function and dm_put() later.
1094  */
1095 static void rq_completed(struct mapped_device *md, int rw, bool run_queue)
1096 {
1097         atomic_dec(&md->pending[rw]);
1098
1099         /* nudge anyone waiting on suspend queue */
1100         if (!md_in_flight(md))
1101                 wake_up(&md->wait);
1102
1103         /*
1104          * Run this off this callpath, as drivers could invoke end_io while
1105          * inside their request_fn (and holding the queue lock). Calling
1106          * back into ->request_fn() could deadlock attempting to grab the
1107          * queue lock again.
1108          */
1109         if (run_queue) {
1110                 if (md->queue->mq_ops)
1111                         blk_mq_run_hw_queues(md->queue, true);
1112                 else
1113                         blk_run_queue_async(md->queue);
1114         }
1115
1116         /*
1117          * dm_put() must be at the end of this function. See the comment above
1118          */
1119         dm_put(md);
1120 }
1121
1122 static void free_rq_clone(struct request *clone)
1123 {
1124         struct dm_rq_target_io *tio = clone->end_io_data;
1125         struct mapped_device *md = tio->md;
1126
1127         blk_rq_unprep_clone(clone);
1128
1129         if (md->type == DM_TYPE_MQ_REQUEST_BASED)
1130                 /* stacked on blk-mq queue(s) */
1131                 tio->ti->type->release_clone_rq(clone);
1132         else if (!md->queue->mq_ops)
1133                 /* request_fn queue stacked on request_fn queue(s) */
1134                 free_clone_request(md, clone);
1135         /*
1136          * NOTE: for the blk-mq queue stacked on request_fn queue(s) case:
1137          * no need to call free_clone_request() because we leverage blk-mq by
1138          * allocating the clone at the end of the blk-mq pdu (see: clone_rq)
1139          */
1140
1141         if (!md->queue->mq_ops)
1142                 free_rq_tio(tio);
1143 }
1144
1145 /*
1146  * Complete the clone and the original request.
1147  * Must be called without clone's queue lock held,
1148  * see end_clone_request() for more details.
1149  */
1150 static void dm_end_request(struct request *clone, int error)
1151 {
1152         int rw = rq_data_dir(clone);
1153         struct dm_rq_target_io *tio = clone->end_io_data;
1154         struct mapped_device *md = tio->md;
1155         struct request *rq = tio->orig;
1156
1157         if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
1158                 rq->errors = clone->errors;
1159                 rq->resid_len = clone->resid_len;
1160
1161                 if (rq->sense)
1162                         /*
1163                          * We are using the sense buffer of the original
1164                          * request.
1165                          * So setting the length of the sense data is enough.
1166                          */
1167                         rq->sense_len = clone->sense_len;
1168         }
1169
1170         free_rq_clone(clone);
1171         rq_end_stats(md, rq);
1172         if (!rq->q->mq_ops)
1173                 blk_end_request_all(rq, error);
1174         else
1175                 blk_mq_end_request(rq, error);
1176         rq_completed(md, rw, true);
1177 }
1178
1179 static void dm_unprep_request(struct request *rq)
1180 {
1181         struct dm_rq_target_io *tio = tio_from_request(rq);
1182         struct request *clone = tio->clone;
1183
1184         if (!rq->q->mq_ops) {
1185                 rq->special = NULL;
1186                 rq->cmd_flags &= ~REQ_DONTPREP;
1187         }
1188
1189         if (clone)
1190                 free_rq_clone(clone);
1191 }
1192
1193 /*
1194  * Requeue the original request of a clone.
1195  */
1196 static void old_requeue_request(struct request *rq)
1197 {
1198         struct request_queue *q = rq->q;
1199         unsigned long flags;
1200
1201         spin_lock_irqsave(q->queue_lock, flags);
1202         blk_requeue_request(q, rq);
1203         blk_run_queue_async(q);
1204         spin_unlock_irqrestore(q->queue_lock, flags);
1205 }
1206
1207 static void dm_requeue_original_request(struct mapped_device *md,
1208                                         struct request *rq)
1209 {
1210         int rw = rq_data_dir(rq);
1211
1212         dm_unprep_request(rq);
1213
1214         rq_end_stats(md, rq);
1215         if (!rq->q->mq_ops)
1216                 old_requeue_request(rq);
1217         else {
1218                 blk_mq_requeue_request(rq);
1219                 blk_mq_kick_requeue_list(rq->q);
1220         }
1221
1222         rq_completed(md, rw, false);
1223 }
1224
1225 static void old_stop_queue(struct request_queue *q)
1226 {
1227         unsigned long flags;
1228
1229         if (blk_queue_stopped(q))
1230                 return;
1231
1232         spin_lock_irqsave(q->queue_lock, flags);
1233         blk_stop_queue(q);
1234         spin_unlock_irqrestore(q->queue_lock, flags);
1235 }
1236
1237 static void stop_queue(struct request_queue *q)
1238 {
1239         if (!q->mq_ops)
1240                 old_stop_queue(q);
1241         else
1242                 blk_mq_stop_hw_queues(q);
1243 }
1244
1245 static void old_start_queue(struct request_queue *q)
1246 {
1247         unsigned long flags;
1248
1249         spin_lock_irqsave(q->queue_lock, flags);
1250         if (blk_queue_stopped(q))
1251                 blk_start_queue(q);
1252         spin_unlock_irqrestore(q->queue_lock, flags);
1253 }
1254
1255 static void start_queue(struct request_queue *q)
1256 {
1257         if (!q->mq_ops)
1258                 old_start_queue(q);
1259         else
1260                 blk_mq_start_stopped_hw_queues(q, true);
1261 }
1262
1263 static void dm_done(struct request *clone, int error, bool mapped)
1264 {
1265         int r = error;
1266         struct dm_rq_target_io *tio = clone->end_io_data;
1267         dm_request_endio_fn rq_end_io = NULL;
1268
1269         if (tio->ti) {
1270                 rq_end_io = tio->ti->type->rq_end_io;
1271
1272                 if (mapped && rq_end_io)
1273                         r = rq_end_io(tio->ti, clone, error, &tio->info);
1274         }
1275
1276         if (unlikely(r == -EREMOTEIO && (clone->cmd_flags & REQ_WRITE_SAME) &&
1277                      !clone->q->limits.max_write_same_sectors))
1278                 disable_write_same(tio->md);
1279
1280         if (r <= 0)
1281                 /* The target wants to complete the I/O */
1282                 dm_end_request(clone, r);
1283         else if (r == DM_ENDIO_INCOMPLETE)
1284                 /* The target will handle the I/O */
1285                 return;
1286         else if (r == DM_ENDIO_REQUEUE)
1287                 /* The target wants to requeue the I/O */
1288                 dm_requeue_original_request(tio->md, tio->orig);
1289         else {
1290                 DMWARN("unimplemented target endio return value: %d", r);
1291                 BUG();
1292         }
1293 }
1294
1295 /*
1296  * Request completion handler for request-based dm
1297  */
1298 static void dm_softirq_done(struct request *rq)
1299 {
1300         bool mapped = true;
1301         struct dm_rq_target_io *tio = tio_from_request(rq);
1302         struct request *clone = tio->clone;
1303         int rw;
1304
1305         if (!clone) {
1306                 rq_end_stats(tio->md, rq);
1307                 rw = rq_data_dir(rq);
1308                 if (!rq->q->mq_ops) {
1309                         blk_end_request_all(rq, tio->error);
1310                         rq_completed(tio->md, rw, false);
1311                         free_rq_tio(tio);
1312                 } else {
1313                         blk_mq_end_request(rq, tio->error);
1314                         rq_completed(tio->md, rw, false);
1315                 }
1316                 return;
1317         }
1318
1319         if (rq->cmd_flags & REQ_FAILED)
1320                 mapped = false;
1321
1322         dm_done(clone, tio->error, mapped);
1323 }
1324
1325 /*
1326  * Complete the clone and the original request with the error status
1327  * through softirq context.
1328  */
1329 static void dm_complete_request(struct request *rq, int error)
1330 {
1331         struct dm_rq_target_io *tio = tio_from_request(rq);
1332
1333         tio->error = error;
1334         blk_complete_request(rq);
1335 }
1336
1337 /*
1338  * Complete the not-mapped clone and the original request with the error status
1339  * through softirq context.
1340  * Target's rq_end_io() function isn't called.
1341  * This may be used when the target's map_rq() or clone_and_map_rq() functions fail.
1342  */
1343 static void dm_kill_unmapped_request(struct request *rq, int error)
1344 {
1345         rq->cmd_flags |= REQ_FAILED;
1346         dm_complete_request(rq, error);
1347 }
1348
1349 /*
1350  * Called with the clone's queue lock held (for non-blk-mq)
1351  */
1352 static void end_clone_request(struct request *clone, int error)
1353 {
1354         struct dm_rq_target_io *tio = clone->end_io_data;
1355
1356         if (!clone->q->mq_ops) {
1357                 /*
1358                  * For just cleaning up the information of the queue in which
1359                  * the clone was dispatched.
1360                  * The clone is *NOT* freed actually here because it is alloced
1361                  * from dm own mempool (REQ_ALLOCED isn't set).
1362                  */
1363                 __blk_put_request(clone->q, clone);
1364         }
1365
1366         /*
1367          * Actual request completion is done in a softirq context which doesn't
1368          * hold the clone's queue lock.  Otherwise, deadlock could occur because:
1369          *     - another request may be submitted by the upper level driver
1370          *       of the stacking during the completion
1371          *     - the submission which requires queue lock may be done
1372          *       against this clone's queue
1373          */
1374         dm_complete_request(tio->orig, error);
1375 }
1376
1377 /*
1378  * Return maximum size of I/O possible at the supplied sector up to the current
1379  * target boundary.
1380  */
1381 static sector_t max_io_len_target_boundary(sector_t sector, struct dm_target *ti)
1382 {
1383         sector_t target_offset = dm_target_offset(ti, sector);
1384
1385         return ti->len - target_offset;
1386 }
1387
1388 static sector_t max_io_len(sector_t sector, struct dm_target *ti)
1389 {
1390         sector_t len = max_io_len_target_boundary(sector, ti);
1391         sector_t offset, max_len;
1392
1393         /*
1394          * Does the target need to split even further?
1395          */
1396         if (ti->max_io_len) {
1397                 offset = dm_target_offset(ti, sector);
1398                 if (unlikely(ti->max_io_len & (ti->max_io_len - 1)))
1399                         max_len = sector_div(offset, ti->max_io_len);
1400                 else
1401                         max_len = offset & (ti->max_io_len - 1);
1402                 max_len = ti->max_io_len - max_len;
1403
1404                 if (len > max_len)
1405                         len = max_len;
1406         }
1407
1408         return len;
1409 }
1410
1411 int dm_set_target_max_io_len(struct dm_target *ti, sector_t len)
1412 {
1413         if (len > UINT_MAX) {
1414                 DMERR("Specified maximum size of target IO (%llu) exceeds limit (%u)",
1415                       (unsigned long long)len, UINT_MAX);
1416                 ti->error = "Maximum size of target IO is too large";
1417                 return -EINVAL;
1418         }
1419
1420         ti->max_io_len = (uint32_t) len;
1421
1422         return 0;
1423 }
1424 EXPORT_SYMBOL_GPL(dm_set_target_max_io_len);
1425
1426 /*
1427  * A target may call dm_accept_partial_bio only from the map routine.  It is
1428  * allowed for all bio types except REQ_FLUSH.
1429  *
1430  * dm_accept_partial_bio informs the dm that the target only wants to process
1431  * additional n_sectors sectors of the bio and the rest of the data should be
1432  * sent in a next bio.
1433  *
1434  * A diagram that explains the arithmetics:
1435  * +--------------------+---------------+-------+
1436  * |         1          |       2       |   3   |
1437  * +--------------------+---------------+-------+
1438  *
1439  * <-------------- *tio->len_ptr --------------->
1440  *                      <------- bi_size ------->
1441  *                      <-- n_sectors -->
1442  *
1443  * Region 1 was already iterated over with bio_advance or similar function.
1444  *      (it may be empty if the target doesn't use bio_advance)
1445  * Region 2 is the remaining bio size that the target wants to process.
1446  *      (it may be empty if region 1 is non-empty, although there is no reason
1447  *       to make it empty)
1448  * The target requires that region 3 is to be sent in the next bio.
1449  *
1450  * If the target wants to receive multiple copies of the bio (via num_*bios, etc),
1451  * the partially processed part (the sum of regions 1+2) must be the same for all
1452  * copies of the bio.
1453  */
1454 void dm_accept_partial_bio(struct bio *bio, unsigned n_sectors)
1455 {
1456         struct dm_target_io *tio = container_of(bio, struct dm_target_io, clone);
1457         unsigned bi_size = bio->bi_iter.bi_size >> SECTOR_SHIFT;
1458         BUG_ON(bio->bi_rw & REQ_FLUSH);
1459         BUG_ON(bi_size > *tio->len_ptr);
1460         BUG_ON(n_sectors > bi_size);
1461         *tio->len_ptr -= bi_size - n_sectors;
1462         bio->bi_iter.bi_size = n_sectors << SECTOR_SHIFT;
1463 }
1464 EXPORT_SYMBOL_GPL(dm_accept_partial_bio);
1465
1466 static void __map_bio(struct dm_target_io *tio)
1467 {
1468         int r;
1469         sector_t sector;
1470         struct mapped_device *md;
1471         struct bio *clone = &tio->clone;
1472         struct dm_target *ti = tio->ti;
1473
1474         clone->bi_end_io = clone_endio;
1475
1476         /*
1477          * Map the clone.  If r == 0 we don't need to do
1478          * anything, the target has assumed ownership of
1479          * this io.
1480          */
1481         atomic_inc(&tio->io->io_count);
1482         sector = clone->bi_iter.bi_sector;
1483         r = ti->type->map(ti, clone);
1484         if (r == DM_MAPIO_REMAPPED) {
1485                 /* the bio has been remapped so dispatch it */
1486
1487                 trace_block_bio_remap(bdev_get_queue(clone->bi_bdev), clone,
1488                                       tio->io->bio->bi_bdev->bd_dev, sector);
1489
1490                 generic_make_request(clone);
1491         } else if (r < 0 || r == DM_MAPIO_REQUEUE) {
1492                 /* error the io and bail out, or requeue it if needed */
1493                 md = tio->io->md;
1494                 dec_pending(tio->io, r);
1495                 free_tio(md, tio);
1496         } else if (r != DM_MAPIO_SUBMITTED) {
1497                 DMWARN("unimplemented target map return value: %d", r);
1498                 BUG();
1499         }
1500 }
1501
1502 struct clone_info {
1503         struct mapped_device *md;
1504         struct dm_table *map;
1505         struct bio *bio;
1506         struct dm_io *io;
1507         sector_t sector;
1508         unsigned sector_count;
1509 };
1510
1511 static void bio_setup_sector(struct bio *bio, sector_t sector, unsigned len)
1512 {
1513         bio->bi_iter.bi_sector = sector;
1514         bio->bi_iter.bi_size = to_bytes(len);
1515 }
1516
1517 /*
1518  * Creates a bio that consists of range of complete bvecs.
1519  */
1520 static void clone_bio(struct dm_target_io *tio, struct bio *bio,
1521                       sector_t sector, unsigned len)
1522 {
1523         struct bio *clone = &tio->clone;
1524
1525         __bio_clone_fast(clone, bio);
1526
1527         if (bio_integrity(bio))
1528                 bio_integrity_clone(clone, bio, GFP_NOIO);
1529
1530         bio_advance(clone, to_bytes(sector - clone->bi_iter.bi_sector));
1531         clone->bi_iter.bi_size = to_bytes(len);
1532
1533         if (bio_integrity(bio))
1534                 bio_integrity_trim(clone, 0, len);
1535 }
1536
1537 static struct dm_target_io *alloc_tio(struct clone_info *ci,
1538                                       struct dm_target *ti,
1539                                       unsigned target_bio_nr)
1540 {
1541         struct dm_target_io *tio;
1542         struct bio *clone;
1543
1544         clone = bio_alloc_bioset(GFP_NOIO, 0, ci->md->bs);
1545         tio = container_of(clone, struct dm_target_io, clone);
1546
1547         tio->io = ci->io;
1548         tio->ti = ti;
1549         tio->target_bio_nr = target_bio_nr;
1550
1551         return tio;
1552 }
1553
1554 static void __clone_and_map_simple_bio(struct clone_info *ci,
1555                                        struct dm_target *ti,
1556                                        unsigned target_bio_nr, unsigned *len)
1557 {
1558         struct dm_target_io *tio = alloc_tio(ci, ti, target_bio_nr);
1559         struct bio *clone = &tio->clone;
1560
1561         tio->len_ptr = len;
1562
1563         __bio_clone_fast(clone, ci->bio);
1564         if (len)
1565                 bio_setup_sector(clone, ci->sector, *len);
1566
1567         __map_bio(tio);
1568 }
1569
1570 static void __send_duplicate_bios(struct clone_info *ci, struct dm_target *ti,
1571                                   unsigned num_bios, unsigned *len)
1572 {
1573         unsigned target_bio_nr;
1574
1575         for (target_bio_nr = 0; target_bio_nr < num_bios; target_bio_nr++)
1576                 __clone_and_map_simple_bio(ci, ti, target_bio_nr, len);
1577 }
1578
1579 static int __send_empty_flush(struct clone_info *ci)
1580 {
1581         unsigned target_nr = 0;
1582         struct dm_target *ti;
1583
1584         BUG_ON(bio_has_data(ci->bio));
1585         while ((ti = dm_table_get_target(ci->map, target_nr++)))
1586                 __send_duplicate_bios(ci, ti, ti->num_flush_bios, NULL);
1587
1588         return 0;
1589 }
1590
1591 static void __clone_and_map_data_bio(struct clone_info *ci, struct dm_target *ti,
1592                                      sector_t sector, unsigned *len)
1593 {
1594         struct bio *bio = ci->bio;
1595         struct dm_target_io *tio;
1596         unsigned target_bio_nr;
1597         unsigned num_target_bios = 1;
1598
1599         /*
1600          * Does the target want to receive duplicate copies of the bio?
1601          */
1602         if (bio_data_dir(bio) == WRITE && ti->num_write_bios)
1603                 num_target_bios = ti->num_write_bios(ti, bio);
1604
1605         for (target_bio_nr = 0; target_bio_nr < num_target_bios; target_bio_nr++) {
1606                 tio = alloc_tio(ci, ti, target_bio_nr);
1607                 tio->len_ptr = len;
1608                 clone_bio(tio, bio, sector, *len);
1609                 __map_bio(tio);
1610         }
1611 }
1612
1613 typedef unsigned (*get_num_bios_fn)(struct dm_target *ti);
1614
1615 static unsigned get_num_discard_bios(struct dm_target *ti)
1616 {
1617         return ti->num_discard_bios;
1618 }
1619
1620 static unsigned get_num_write_same_bios(struct dm_target *ti)
1621 {
1622         return ti->num_write_same_bios;
1623 }
1624
1625 typedef bool (*is_split_required_fn)(struct dm_target *ti);
1626
1627 static bool is_split_required_for_discard(struct dm_target *ti)
1628 {
1629         return ti->split_discard_bios;
1630 }
1631
1632 static int __send_changing_extent_only(struct clone_info *ci,
1633                                        get_num_bios_fn get_num_bios,
1634                                        is_split_required_fn is_split_required)
1635 {
1636         struct dm_target *ti;
1637         unsigned len;
1638         unsigned num_bios;
1639
1640         do {
1641                 ti = dm_table_find_target(ci->map, ci->sector);
1642                 if (!dm_target_is_valid(ti))
1643                         return -EIO;
1644
1645                 /*
1646                  * Even though the device advertised support for this type of
1647                  * request, that does not mean every target supports it, and
1648                  * reconfiguration might also have changed that since the
1649                  * check was performed.
1650                  */
1651                 num_bios = get_num_bios ? get_num_bios(ti) : 0;
1652                 if (!num_bios)
1653                         return -EOPNOTSUPP;
1654
1655                 if (is_split_required && !is_split_required(ti))
1656                         len = min((sector_t)ci->sector_count, max_io_len_target_boundary(ci->sector, ti));
1657                 else
1658                         len = min((sector_t)ci->sector_count, max_io_len(ci->sector, ti));
1659
1660                 __send_duplicate_bios(ci, ti, num_bios, &len);
1661
1662                 ci->sector += len;
1663         } while (ci->sector_count -= len);
1664
1665         return 0;
1666 }
1667
1668 static int __send_discard(struct clone_info *ci)
1669 {
1670         return __send_changing_extent_only(ci, get_num_discard_bios,
1671                                            is_split_required_for_discard);
1672 }
1673
1674 static int __send_write_same(struct clone_info *ci)
1675 {
1676         return __send_changing_extent_only(ci, get_num_write_same_bios, NULL);
1677 }
1678
1679 /*
1680  * Select the correct strategy for processing a non-flush bio.
1681  */
1682 static int __split_and_process_non_flush(struct clone_info *ci)
1683 {
1684         struct bio *bio = ci->bio;
1685         struct dm_target *ti;
1686         unsigned len;
1687
1688         if (unlikely(bio->bi_rw & REQ_DISCARD))
1689                 return __send_discard(ci);
1690         else if (unlikely(bio->bi_rw & REQ_WRITE_SAME))
1691                 return __send_write_same(ci);
1692
1693         ti = dm_table_find_target(ci->map, ci->sector);
1694         if (!dm_target_is_valid(ti))
1695                 return -EIO;
1696
1697         len = min_t(sector_t, max_io_len(ci->sector, ti), ci->sector_count);
1698
1699         __clone_and_map_data_bio(ci, ti, ci->sector, &len);
1700
1701         ci->sector += len;
1702         ci->sector_count -= len;
1703
1704         return 0;
1705 }
1706
1707 /*
1708  * Entry point to split a bio into clones and submit them to the targets.
1709  */
1710 static void __split_and_process_bio(struct mapped_device *md,
1711                                     struct dm_table *map, struct bio *bio)
1712 {
1713         struct clone_info ci;
1714         int error = 0;
1715
1716         if (unlikely(!map)) {
1717                 bio_io_error(bio);
1718                 return;
1719         }
1720
1721         ci.map = map;
1722         ci.md = md;
1723         ci.io = alloc_io(md);
1724         ci.io->error = 0;
1725         atomic_set(&ci.io->io_count, 1);
1726         ci.io->bio = bio;
1727         ci.io->md = md;
1728         spin_lock_init(&ci.io->endio_lock);
1729         ci.sector = bio->bi_iter.bi_sector;
1730
1731         start_io_acct(ci.io);
1732
1733         if (bio->bi_rw & REQ_FLUSH) {
1734                 ci.bio = &ci.md->flush_bio;
1735                 ci.sector_count = 0;
1736                 error = __send_empty_flush(&ci);
1737                 /* dec_pending submits any data associated with flush */
1738         } else {
1739                 ci.bio = bio;
1740                 ci.sector_count = bio_sectors(bio);
1741                 while (ci.sector_count && !error)
1742                         error = __split_and_process_non_flush(&ci);
1743         }
1744
1745         /* drop the extra reference count */
1746         dec_pending(ci.io, error);
1747 }
1748 /*-----------------------------------------------------------------
1749  * CRUD END
1750  *---------------------------------------------------------------*/
1751
1752 /*
1753  * The request function that just remaps the bio built up by
1754  * dm_merge_bvec.
1755  */
1756 static void dm_make_request(struct request_queue *q, struct bio *bio)
1757 {
1758         int rw = bio_data_dir(bio);
1759         struct mapped_device *md = q->queuedata;
1760         int srcu_idx;
1761         struct dm_table *map;
1762
1763         map = dm_get_live_table(md, &srcu_idx);
1764
1765         blk_queue_split(q, &bio, q->bio_split);
1766
1767         generic_start_io_acct(rw, bio_sectors(bio), &dm_disk(md)->part0);
1768
1769         /* if we're suspended, we have to queue this io for later */
1770         if (unlikely(test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags))) {
1771                 dm_put_live_table(md, srcu_idx);
1772
1773                 if (bio_rw(bio) != READA)
1774                         queue_io(md, bio);
1775                 else
1776                         bio_io_error(bio);
1777                 return;
1778         }
1779
1780         __split_and_process_bio(md, map, bio);
1781         dm_put_live_table(md, srcu_idx);
1782         return;
1783 }
1784
1785 int dm_request_based(struct mapped_device *md)
1786 {
1787         return blk_queue_stackable(md->queue);
1788 }
1789
1790 static void dm_dispatch_clone_request(struct request *clone, struct request *rq)
1791 {
1792         int r;
1793
1794         if (blk_queue_io_stat(clone->q))
1795                 clone->cmd_flags |= REQ_IO_STAT;
1796
1797         clone->start_time = jiffies;
1798         r = blk_insert_cloned_request(clone->q, clone);
1799         if (r)
1800                 /* must complete clone in terms of original request */
1801                 dm_complete_request(rq, r);
1802 }
1803
1804 static int dm_rq_bio_constructor(struct bio *bio, struct bio *bio_orig,
1805                                  void *data)
1806 {
1807         struct dm_rq_target_io *tio = data;
1808         struct dm_rq_clone_bio_info *info =
1809                 container_of(bio, struct dm_rq_clone_bio_info, clone);
1810
1811         info->orig = bio_orig;
1812         info->tio = tio;
1813         bio->bi_end_io = end_clone_bio;
1814
1815         return 0;
1816 }
1817
1818 static int setup_clone(struct request *clone, struct request *rq,
1819                        struct dm_rq_target_io *tio, gfp_t gfp_mask)
1820 {
1821         int r;
1822
1823         r = blk_rq_prep_clone(clone, rq, tio->md->bs, gfp_mask,
1824                               dm_rq_bio_constructor, tio);
1825         if (r)
1826                 return r;
1827
1828         clone->cmd = rq->cmd;
1829         clone->cmd_len = rq->cmd_len;
1830         clone->sense = rq->sense;
1831         clone->end_io = end_clone_request;
1832         clone->end_io_data = tio;
1833
1834         tio->clone = clone;
1835
1836         return 0;
1837 }
1838
1839 static struct request *clone_rq(struct request *rq, struct mapped_device *md,
1840                                 struct dm_rq_target_io *tio, gfp_t gfp_mask)
1841 {
1842         /*
1843          * Do not allocate a clone if tio->clone was already set
1844          * (see: dm_mq_queue_rq).
1845          */
1846         bool alloc_clone = !tio->clone;
1847         struct request *clone;
1848
1849         if (alloc_clone) {
1850                 clone = alloc_clone_request(md, gfp_mask);
1851                 if (!clone)
1852                         return NULL;
1853         } else
1854                 clone = tio->clone;
1855
1856         blk_rq_init(NULL, clone);
1857         if (setup_clone(clone, rq, tio, gfp_mask)) {
1858                 /* -ENOMEM */
1859                 if (alloc_clone)
1860                         free_clone_request(md, clone);
1861                 return NULL;
1862         }
1863
1864         return clone;
1865 }
1866
1867 static void map_tio_request(struct kthread_work *work);
1868
1869 static void init_tio(struct dm_rq_target_io *tio, struct request *rq,
1870                      struct mapped_device *md)
1871 {
1872         tio->md = md;
1873         tio->ti = NULL;
1874         tio->clone = NULL;
1875         tio->orig = rq;
1876         tio->error = 0;
1877         memset(&tio->info, 0, sizeof(tio->info));
1878         if (md->kworker_task)
1879                 init_kthread_work(&tio->work, map_tio_request);
1880 }
1881
1882 static struct dm_rq_target_io *prep_tio(struct request *rq,
1883                                         struct mapped_device *md, gfp_t gfp_mask)
1884 {
1885         struct dm_rq_target_io *tio;
1886         int srcu_idx;
1887         struct dm_table *table;
1888
1889         tio = alloc_rq_tio(md, gfp_mask);
1890         if (!tio)
1891                 return NULL;
1892
1893         init_tio(tio, rq, md);
1894
1895         table = dm_get_live_table(md, &srcu_idx);
1896         if (!dm_table_mq_request_based(table)) {
1897                 if (!clone_rq(rq, md, tio, gfp_mask)) {
1898                         dm_put_live_table(md, srcu_idx);
1899                         free_rq_tio(tio);
1900                         return NULL;
1901                 }
1902         }
1903         dm_put_live_table(md, srcu_idx);
1904
1905         return tio;
1906 }
1907
1908 /*
1909  * Called with the queue lock held.
1910  */
1911 static int dm_prep_fn(struct request_queue *q, struct request *rq)
1912 {
1913         struct mapped_device *md = q->queuedata;
1914         struct dm_rq_target_io *tio;
1915
1916         if (unlikely(rq->special)) {
1917                 DMWARN("Already has something in rq->special.");
1918                 return BLKPREP_KILL;
1919         }
1920
1921         tio = prep_tio(rq, md, GFP_ATOMIC);
1922         if (!tio)
1923                 return BLKPREP_DEFER;
1924
1925         rq->special = tio;
1926         rq->cmd_flags |= REQ_DONTPREP;
1927
1928         return BLKPREP_OK;
1929 }
1930
1931 /*
1932  * Returns:
1933  * 0                : the request has been processed
1934  * DM_MAPIO_REQUEUE : the original request needs to be requeued
1935  * < 0              : the request was completed due to failure
1936  */
1937 static int map_request(struct dm_rq_target_io *tio, struct request *rq,
1938                        struct mapped_device *md)
1939 {
1940         int r;
1941         struct dm_target *ti = tio->ti;
1942         struct request *clone = NULL;
1943
1944         if (tio->clone) {
1945                 clone = tio->clone;
1946                 r = ti->type->map_rq(ti, clone, &tio->info);
1947         } else {
1948                 r = ti->type->clone_and_map_rq(ti, rq, &tio->info, &clone);
1949                 if (r < 0) {
1950                         /* The target wants to complete the I/O */
1951                         dm_kill_unmapped_request(rq, r);
1952                         return r;
1953                 }
1954                 if (r != DM_MAPIO_REMAPPED)
1955                         return r;
1956                 if (setup_clone(clone, rq, tio, GFP_ATOMIC)) {
1957                         /* -ENOMEM */
1958                         ti->type->release_clone_rq(clone);
1959                         return DM_MAPIO_REQUEUE;
1960                 }
1961         }
1962
1963         switch (r) {
1964         case DM_MAPIO_SUBMITTED:
1965                 /* The target has taken the I/O to submit by itself later */
1966                 break;
1967         case DM_MAPIO_REMAPPED:
1968                 /* The target has remapped the I/O so dispatch it */
1969                 trace_block_rq_remap(clone->q, clone, disk_devt(dm_disk(md)),
1970                                      blk_rq_pos(rq));
1971                 dm_dispatch_clone_request(clone, rq);
1972                 break;
1973         case DM_MAPIO_REQUEUE:
1974                 /* The target wants to requeue the I/O */
1975                 dm_requeue_original_request(md, tio->orig);
1976                 break;
1977         default:
1978                 if (r > 0) {
1979                         DMWARN("unimplemented target map return value: %d", r);
1980                         BUG();
1981                 }
1982
1983                 /* The target wants to complete the I/O */
1984                 dm_kill_unmapped_request(rq, r);
1985                 return r;
1986         }
1987
1988         return 0;
1989 }
1990
1991 static void map_tio_request(struct kthread_work *work)
1992 {
1993         struct dm_rq_target_io *tio = container_of(work, struct dm_rq_target_io, work);
1994         struct request *rq = tio->orig;
1995         struct mapped_device *md = tio->md;
1996
1997         if (map_request(tio, rq, md) == DM_MAPIO_REQUEUE)
1998                 dm_requeue_original_request(md, rq);
1999 }
2000
2001 static void dm_start_request(struct mapped_device *md, struct request *orig)
2002 {
2003         if (!orig->q->mq_ops)
2004                 blk_start_request(orig);
2005         else
2006                 blk_mq_start_request(orig);
2007         atomic_inc(&md->pending[rq_data_dir(orig)]);
2008
2009         if (md->seq_rq_merge_deadline_usecs) {
2010                 md->last_rq_pos = rq_end_sector(orig);
2011                 md->last_rq_rw = rq_data_dir(orig);
2012                 md->last_rq_start_time = ktime_get();
2013         }
2014
2015         if (unlikely(dm_stats_used(&md->stats))) {
2016                 struct dm_rq_target_io *tio = tio_from_request(orig);
2017                 tio->duration_jiffies = jiffies;
2018                 tio->n_sectors = blk_rq_sectors(orig);
2019                 dm_stats_account_io(&md->stats, orig->cmd_flags, blk_rq_pos(orig),
2020                                     tio->n_sectors, false, 0, &tio->stats_aux);
2021         }
2022
2023         /*
2024          * Hold the md reference here for the in-flight I/O.
2025          * We can't rely on the reference count by device opener,
2026          * because the device may be closed during the request completion
2027          * when all bios are completed.
2028          * See the comment in rq_completed() too.
2029          */
2030         dm_get(md);
2031 }
2032
2033 #define MAX_SEQ_RQ_MERGE_DEADLINE_USECS 100000
2034
2035 ssize_t dm_attr_rq_based_seq_io_merge_deadline_show(struct mapped_device *md, char *buf)
2036 {
2037         return sprintf(buf, "%u\n", md->seq_rq_merge_deadline_usecs);
2038 }
2039
2040 ssize_t dm_attr_rq_based_seq_io_merge_deadline_store(struct mapped_device *md,
2041                                                      const char *buf, size_t count)
2042 {
2043         unsigned deadline;
2044
2045         if (!dm_request_based(md) || md->use_blk_mq)
2046                 return count;
2047
2048         if (kstrtouint(buf, 10, &deadline))
2049                 return -EINVAL;
2050
2051         if (deadline > MAX_SEQ_RQ_MERGE_DEADLINE_USECS)
2052                 deadline = MAX_SEQ_RQ_MERGE_DEADLINE_USECS;
2053
2054         md->seq_rq_merge_deadline_usecs = deadline;
2055
2056         return count;
2057 }
2058
2059 static bool dm_request_peeked_before_merge_deadline(struct mapped_device *md)
2060 {
2061         ktime_t kt_deadline;
2062
2063         if (!md->seq_rq_merge_deadline_usecs)
2064                 return false;
2065
2066         kt_deadline = ns_to_ktime((u64)md->seq_rq_merge_deadline_usecs * NSEC_PER_USEC);
2067         kt_deadline = ktime_add_safe(md->last_rq_start_time, kt_deadline);
2068
2069         return !ktime_after(ktime_get(), kt_deadline);
2070 }
2071
2072 /*
2073  * q->request_fn for request-based dm.
2074  * Called with the queue lock held.
2075  */
2076 static void dm_request_fn(struct request_queue *q)
2077 {
2078         struct mapped_device *md = q->queuedata;
2079         int srcu_idx;
2080         struct dm_table *map = dm_get_live_table(md, &srcu_idx);
2081         struct dm_target *ti;
2082         struct request *rq;
2083         struct dm_rq_target_io *tio;
2084         sector_t pos;
2085
2086         /*
2087          * For suspend, check blk_queue_stopped() and increment
2088          * ->pending within a single queue_lock not to increment the
2089          * number of in-flight I/Os after the queue is stopped in
2090          * dm_suspend().
2091          */
2092         while (!blk_queue_stopped(q)) {
2093                 rq = blk_peek_request(q);
2094                 if (!rq)
2095                         goto out;
2096
2097                 /* always use block 0 to find the target for flushes for now */
2098                 pos = 0;
2099                 if (!(rq->cmd_flags & REQ_FLUSH))
2100                         pos = blk_rq_pos(rq);
2101
2102                 ti = dm_table_find_target(map, pos);
2103                 if (!dm_target_is_valid(ti)) {
2104                         /*
2105                          * Must perform setup, that rq_completed() requires,
2106                          * before calling dm_kill_unmapped_request
2107                          */
2108                         DMERR_LIMIT("request attempted access beyond the end of device");
2109                         dm_start_request(md, rq);
2110                         dm_kill_unmapped_request(rq, -EIO);
2111                         continue;
2112                 }
2113
2114                 if (dm_request_peeked_before_merge_deadline(md) &&
2115                     md_in_flight(md) && rq->bio && rq->bio->bi_vcnt == 1 &&
2116                     md->last_rq_pos == pos && md->last_rq_rw == rq_data_dir(rq))
2117                         goto delay_and_out;
2118
2119                 if (ti->type->busy && ti->type->busy(ti))
2120                         goto delay_and_out;
2121
2122                 dm_start_request(md, rq);
2123
2124                 tio = tio_from_request(rq);
2125                 /* Establish tio->ti before queuing work (map_tio_request) */
2126                 tio->ti = ti;
2127                 queue_kthread_work(&md->kworker, &tio->work);
2128                 BUG_ON(!irqs_disabled());
2129         }
2130
2131         goto out;
2132
2133 delay_and_out:
2134         blk_delay_queue(q, HZ / 100);
2135 out:
2136         dm_put_live_table(md, srcu_idx);
2137 }
2138
2139 static int dm_any_congested(void *congested_data, int bdi_bits)
2140 {
2141         int r = bdi_bits;
2142         struct mapped_device *md = congested_data;
2143         struct dm_table *map;
2144
2145         if (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
2146                 map = dm_get_live_table_fast(md);
2147                 if (map) {
2148                         /*
2149                          * Request-based dm cares about only own queue for
2150                          * the query about congestion status of request_queue
2151                          */
2152                         if (dm_request_based(md))
2153                                 r = md->queue->backing_dev_info.wb.state &
2154                                     bdi_bits;
2155                         else
2156                                 r = dm_table_any_congested(map, bdi_bits);
2157                 }
2158                 dm_put_live_table_fast(md);
2159         }
2160
2161         return r;
2162 }
2163
2164 /*-----------------------------------------------------------------
2165  * An IDR is used to keep track of allocated minor numbers.
2166  *---------------------------------------------------------------*/
2167 static void free_minor(int minor)
2168 {
2169         spin_lock(&_minor_lock);
2170         idr_remove(&_minor_idr, minor);
2171         spin_unlock(&_minor_lock);
2172 }
2173
2174 /*
2175  * See if the device with a specific minor # is free.
2176  */
2177 static int specific_minor(int minor)
2178 {
2179         int r;
2180
2181         if (minor >= (1 << MINORBITS))
2182                 return -EINVAL;
2183
2184         idr_preload(GFP_KERNEL);
2185         spin_lock(&_minor_lock);
2186
2187         r = idr_alloc(&_minor_idr, MINOR_ALLOCED, minor, minor + 1, GFP_NOWAIT);
2188
2189         spin_unlock(&_minor_lock);
2190         idr_preload_end();
2191         if (r < 0)
2192                 return r == -ENOSPC ? -EBUSY : r;
2193         return 0;
2194 }
2195
2196 static int next_free_minor(int *minor)
2197 {
2198         int r;
2199
2200         idr_preload(GFP_KERNEL);
2201         spin_lock(&_minor_lock);
2202
2203         r = idr_alloc(&_minor_idr, MINOR_ALLOCED, 0, 1 << MINORBITS, GFP_NOWAIT);
2204
2205         spin_unlock(&_minor_lock);
2206         idr_preload_end();
2207         if (r < 0)
2208                 return r;
2209         *minor = r;
2210         return 0;
2211 }
2212
2213 static const struct block_device_operations dm_blk_dops;
2214
2215 static void dm_wq_work(struct work_struct *work);
2216
2217 static void dm_init_md_queue(struct mapped_device *md)
2218 {
2219         /*
2220          * Request-based dm devices cannot be stacked on top of bio-based dm
2221          * devices.  The type of this dm device may not have been decided yet.
2222          * The type is decided at the first table loading time.
2223          * To prevent problematic device stacking, clear the queue flag
2224          * for request stacking support until then.
2225          *
2226          * This queue is new, so no concurrency on the queue_flags.
2227          */
2228         queue_flag_clear_unlocked(QUEUE_FLAG_STACKABLE, md->queue);
2229
2230         /*
2231          * Initialize data that will only be used by a non-blk-mq DM queue
2232          * - must do so here (in alloc_dev callchain) before queue is used
2233          */
2234         md->queue->queuedata = md;
2235         md->queue->backing_dev_info.congested_data = md;
2236 }
2237
2238 static void dm_init_old_md_queue(struct mapped_device *md)
2239 {
2240         md->use_blk_mq = false;
2241         dm_init_md_queue(md);
2242
2243         /*
2244          * Initialize aspects of queue that aren't relevant for blk-mq
2245          */
2246         md->queue->backing_dev_info.congested_fn = dm_any_congested;
2247         blk_queue_bounce_limit(md->queue, BLK_BOUNCE_ANY);
2248 }
2249
2250 static void cleanup_mapped_device(struct mapped_device *md)
2251 {
2252         if (md->wq)
2253                 destroy_workqueue(md->wq);
2254         if (md->kworker_task)
2255                 kthread_stop(md->kworker_task);
2256         if (md->io_pool)
2257                 mempool_destroy(md->io_pool);
2258         if (md->rq_pool)
2259                 mempool_destroy(md->rq_pool);
2260         if (md->bs)
2261                 bioset_free(md->bs);
2262
2263         cleanup_srcu_struct(&md->io_barrier);
2264
2265         if (md->disk) {
2266                 spin_lock(&_minor_lock);
2267                 md->disk->private_data = NULL;
2268                 spin_unlock(&_minor_lock);
2269                 if (blk_get_integrity(md->disk))
2270                         blk_integrity_unregister(md->disk);
2271                 del_gendisk(md->disk);
2272                 put_disk(md->disk);
2273         }
2274
2275         if (md->queue)
2276                 blk_cleanup_queue(md->queue);
2277
2278         if (md->bdev) {
2279                 bdput(md->bdev);
2280                 md->bdev = NULL;
2281         }
2282 }
2283
2284 /*
2285  * Allocate and initialise a blank device with a given minor.
2286  */
2287 static struct mapped_device *alloc_dev(int minor)
2288 {
2289         int r;
2290         struct mapped_device *md = kzalloc(sizeof(*md), GFP_KERNEL);
2291         void *old_md;
2292
2293         if (!md) {
2294                 DMWARN("unable to allocate device, out of memory.");
2295                 return NULL;
2296         }
2297
2298         if (!try_module_get(THIS_MODULE))
2299                 goto bad_module_get;
2300
2301         /* get a minor number for the dev */
2302         if (minor == DM_ANY_MINOR)
2303                 r = next_free_minor(&minor);
2304         else
2305                 r = specific_minor(minor);
2306         if (r < 0)
2307                 goto bad_minor;
2308
2309         r = init_srcu_struct(&md->io_barrier);
2310         if (r < 0)
2311                 goto bad_io_barrier;
2312
2313         md->use_blk_mq = use_blk_mq;
2314         md->type = DM_TYPE_NONE;
2315         mutex_init(&md->suspend_lock);
2316         mutex_init(&md->type_lock);
2317         mutex_init(&md->table_devices_lock);
2318         spin_lock_init(&md->deferred_lock);
2319         atomic_set(&md->holders, 1);
2320         atomic_set(&md->open_count, 0);
2321         atomic_set(&md->event_nr, 0);
2322         atomic_set(&md->uevent_seq, 0);
2323         INIT_LIST_HEAD(&md->uevent_list);
2324         INIT_LIST_HEAD(&md->table_devices);
2325         spin_lock_init(&md->uevent_lock);
2326
2327         md->queue = blk_alloc_queue(GFP_KERNEL);
2328         if (!md->queue)
2329                 goto bad;
2330
2331         dm_init_md_queue(md);
2332
2333         md->disk = alloc_disk(1);
2334         if (!md->disk)
2335                 goto bad;
2336
2337         atomic_set(&md->pending[0], 0);
2338         atomic_set(&md->pending[1], 0);
2339         init_waitqueue_head(&md->wait);
2340         INIT_WORK(&md->work, dm_wq_work);
2341         init_waitqueue_head(&md->eventq);
2342         init_completion(&md->kobj_holder.completion);
2343         md->kworker_task = NULL;
2344
2345         md->disk->major = _major;
2346         md->disk->first_minor = minor;
2347         md->disk->fops = &dm_blk_dops;
2348         md->disk->queue = md->queue;
2349         md->disk->private_data = md;
2350         sprintf(md->disk->disk_name, "dm-%d", minor);
2351         add_disk(md->disk);
2352         format_dev_t(md->name, MKDEV(_major, minor));
2353
2354         md->wq = alloc_workqueue("kdmflush", WQ_MEM_RECLAIM, 0);
2355         if (!md->wq)
2356                 goto bad;
2357
2358         md->bdev = bdget_disk(md->disk, 0);
2359         if (!md->bdev)
2360                 goto bad;
2361
2362         bio_init(&md->flush_bio);
2363         md->flush_bio.bi_bdev = md->bdev;
2364         md->flush_bio.bi_rw = WRITE_FLUSH;
2365
2366         dm_stats_init(&md->stats);
2367
2368         /* Populate the mapping, nobody knows we exist yet */
2369         spin_lock(&_minor_lock);
2370         old_md = idr_replace(&_minor_idr, md, minor);
2371         spin_unlock(&_minor_lock);
2372
2373         BUG_ON(old_md != MINOR_ALLOCED);
2374
2375         return md;
2376
2377 bad:
2378         cleanup_mapped_device(md);
2379 bad_io_barrier:
2380         free_minor(minor);
2381 bad_minor:
2382         module_put(THIS_MODULE);
2383 bad_module_get:
2384         kfree(md);
2385         return NULL;
2386 }
2387
2388 static void unlock_fs(struct mapped_device *md);
2389
2390 static void free_dev(struct mapped_device *md)
2391 {
2392         int minor = MINOR(disk_devt(md->disk));
2393
2394         unlock_fs(md);
2395
2396         cleanup_mapped_device(md);
2397         if (md->use_blk_mq)
2398                 blk_mq_free_tag_set(&md->tag_set);
2399
2400         free_table_devices(&md->table_devices);
2401         dm_stats_cleanup(&md->stats);
2402         free_minor(minor);
2403
2404         module_put(THIS_MODULE);
2405         kfree(md);
2406 }
2407
2408 static void __bind_mempools(struct mapped_device *md, struct dm_table *t)
2409 {
2410         struct dm_md_mempools *p = dm_table_get_md_mempools(t);
2411
2412         if (md->bs) {
2413                 /* The md already has necessary mempools. */
2414                 if (dm_table_get_type(t) == DM_TYPE_BIO_BASED) {
2415                         /*
2416                          * Reload bioset because front_pad may have changed
2417                          * because a different table was loaded.
2418                          */
2419                         bioset_free(md->bs);
2420                         md->bs = p->bs;
2421                         p->bs = NULL;
2422                 }
2423                 /*
2424                  * There's no need to reload with request-based dm
2425                  * because the size of front_pad doesn't change.
2426                  * Note for future: If you are to reload bioset,
2427                  * prep-ed requests in the queue may refer
2428                  * to bio from the old bioset, so you must walk
2429                  * through the queue to unprep.
2430                  */
2431                 goto out;
2432         }
2433
2434         BUG_ON(!p || md->io_pool || md->rq_pool || md->bs);
2435
2436         md->io_pool = p->io_pool;
2437         p->io_pool = NULL;
2438         md->rq_pool = p->rq_pool;
2439         p->rq_pool = NULL;
2440         md->bs = p->bs;
2441         p->bs = NULL;
2442
2443 out:
2444         /* mempool bind completed, no longer need any mempools in the table */
2445         dm_table_free_md_mempools(t);
2446 }
2447
2448 /*
2449  * Bind a table to the device.
2450  */
2451 static void event_callback(void *context)
2452 {
2453         unsigned long flags;
2454         LIST_HEAD(uevents);
2455         struct mapped_device *md = (struct mapped_device *) context;
2456
2457         spin_lock_irqsave(&md->uevent_lock, flags);
2458         list_splice_init(&md->uevent_list, &uevents);
2459         spin_unlock_irqrestore(&md->uevent_lock, flags);
2460
2461         dm_send_uevents(&uevents, &disk_to_dev(md->disk)->kobj);
2462
2463         atomic_inc(&md->event_nr);
2464         wake_up(&md->eventq);
2465 }
2466
2467 /*
2468  * Protected by md->suspend_lock obtained by dm_swap_table().
2469  */
2470 static void __set_size(struct mapped_device *md, sector_t size)
2471 {
2472         set_capacity(md->disk, size);
2473
2474         i_size_write(md->bdev->bd_inode, (loff_t)size << SECTOR_SHIFT);
2475 }
2476
2477 /*
2478  * Returns old map, which caller must destroy.
2479  */
2480 static struct dm_table *__bind(struct mapped_device *md, struct dm_table *t,
2481                                struct queue_limits *limits)
2482 {
2483         struct dm_table *old_map;
2484         struct request_queue *q = md->queue;
2485         sector_t size;
2486
2487         size = dm_table_get_size(t);
2488
2489         /*
2490          * Wipe any geometry if the size of the table changed.
2491          */
2492         if (size != dm_get_size(md))
2493                 memset(&md->geometry, 0, sizeof(md->geometry));
2494
2495         __set_size(md, size);
2496
2497         dm_table_event_callback(t, event_callback, md);
2498
2499         /*
2500          * The queue hasn't been stopped yet, if the old table type wasn't
2501          * for request-based during suspension.  So stop it to prevent
2502          * I/O mapping before resume.
2503          * This must be done before setting the queue restrictions,
2504          * because request-based dm may be run just after the setting.
2505          */
2506         if (dm_table_request_based(t))
2507                 stop_queue(q);
2508
2509         __bind_mempools(md, t);
2510
2511         old_map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
2512         rcu_assign_pointer(md->map, t);
2513         md->immutable_target_type = dm_table_get_immutable_target_type(t);
2514
2515         dm_table_set_restrictions(t, q, limits);
2516         if (old_map)
2517                 dm_sync_table(md);
2518
2519         return old_map;
2520 }
2521
2522 /*
2523  * Returns unbound table for the caller to free.
2524  */
2525 static struct dm_table *__unbind(struct mapped_device *md)
2526 {
2527         struct dm_table *map = rcu_dereference_protected(md->map, 1);
2528
2529         if (!map)
2530                 return NULL;
2531
2532         dm_table_event_callback(map, NULL, NULL);
2533         RCU_INIT_POINTER(md->map, NULL);
2534         dm_sync_table(md);
2535
2536         return map;
2537 }
2538
2539 /*
2540  * Constructor for a new device.
2541  */
2542 int dm_create(int minor, struct mapped_device **result)
2543 {
2544         struct mapped_device *md;
2545
2546         md = alloc_dev(minor);
2547         if (!md)
2548                 return -ENXIO;
2549
2550         dm_sysfs_init(md);
2551
2552         *result = md;
2553         return 0;
2554 }
2555
2556 /*
2557  * Functions to manage md->type.
2558  * All are required to hold md->type_lock.
2559  */
2560 void dm_lock_md_type(struct mapped_device *md)
2561 {
2562         mutex_lock(&md->type_lock);
2563 }
2564
2565 void dm_unlock_md_type(struct mapped_device *md)
2566 {
2567         mutex_unlock(&md->type_lock);
2568 }
2569
2570 void dm_set_md_type(struct mapped_device *md, unsigned type)
2571 {
2572         BUG_ON(!mutex_is_locked(&md->type_lock));
2573         md->type = type;
2574 }
2575
2576 unsigned dm_get_md_type(struct mapped_device *md)
2577 {
2578         BUG_ON(!mutex_is_locked(&md->type_lock));
2579         return md->type;
2580 }
2581
2582 struct target_type *dm_get_immutable_target_type(struct mapped_device *md)
2583 {
2584         return md->immutable_target_type;
2585 }
2586
2587 /*
2588  * The queue_limits are only valid as long as you have a reference
2589  * count on 'md'.
2590  */
2591 struct queue_limits *dm_get_queue_limits(struct mapped_device *md)
2592 {
2593         BUG_ON(!atomic_read(&md->holders));
2594         return &md->queue->limits;
2595 }
2596 EXPORT_SYMBOL_GPL(dm_get_queue_limits);
2597
2598 static void init_rq_based_worker_thread(struct mapped_device *md)
2599 {
2600         /* Initialize the request-based DM worker thread */
2601         init_kthread_worker(&md->kworker);
2602         md->kworker_task = kthread_run(kthread_worker_fn, &md->kworker,
2603                                        "kdmwork-%s", dm_device_name(md));
2604 }
2605
2606 /*
2607  * Fully initialize a request-based queue (->elevator, ->request_fn, etc).
2608  */
2609 static int dm_init_request_based_queue(struct mapped_device *md)
2610 {
2611         struct request_queue *q = NULL;
2612
2613         /* Fully initialize the queue */
2614         q = blk_init_allocated_queue(md->queue, dm_request_fn, NULL);
2615         if (!q)
2616                 return -EINVAL;
2617
2618         /* disable dm_request_fn's merge heuristic by default */
2619         md->seq_rq_merge_deadline_usecs = 0;
2620
2621         md->queue = q;
2622         dm_init_old_md_queue(md);
2623         blk_queue_softirq_done(md->queue, dm_softirq_done);
2624         blk_queue_prep_rq(md->queue, dm_prep_fn);
2625
2626         init_rq_based_worker_thread(md);
2627
2628         elv_register_queue(md->queue);
2629
2630         return 0;
2631 }
2632
2633 static int dm_mq_init_request(void *data, struct request *rq,
2634                               unsigned int hctx_idx, unsigned int request_idx,
2635                               unsigned int numa_node)
2636 {
2637         struct mapped_device *md = data;
2638         struct dm_rq_target_io *tio = blk_mq_rq_to_pdu(rq);
2639
2640         /*
2641          * Must initialize md member of tio, otherwise it won't
2642          * be available in dm_mq_queue_rq.
2643          */
2644         tio->md = md;
2645
2646         return 0;
2647 }
2648
2649 static int dm_mq_queue_rq(struct blk_mq_hw_ctx *hctx,
2650                           const struct blk_mq_queue_data *bd)
2651 {
2652         struct request *rq = bd->rq;
2653         struct dm_rq_target_io *tio = blk_mq_rq_to_pdu(rq);
2654         struct mapped_device *md = tio->md;
2655         int srcu_idx;
2656         struct dm_table *map = dm_get_live_table(md, &srcu_idx);
2657         struct dm_target *ti;
2658         sector_t pos;
2659
2660         /* always use block 0 to find the target for flushes for now */
2661         pos = 0;
2662         if (!(rq->cmd_flags & REQ_FLUSH))
2663                 pos = blk_rq_pos(rq);
2664
2665         ti = dm_table_find_target(map, pos);
2666         if (!dm_target_is_valid(ti)) {
2667                 dm_put_live_table(md, srcu_idx);
2668                 DMERR_LIMIT("request attempted access beyond the end of device");
2669                 /*
2670                  * Must perform setup, that rq_completed() requires,
2671                  * before returning BLK_MQ_RQ_QUEUE_ERROR
2672                  */
2673                 dm_start_request(md, rq);
2674                 return BLK_MQ_RQ_QUEUE_ERROR;
2675         }
2676         dm_put_live_table(md, srcu_idx);
2677
2678         if (ti->type->busy && ti->type->busy(ti))
2679                 return BLK_MQ_RQ_QUEUE_BUSY;
2680
2681         dm_start_request(md, rq);
2682
2683         /* Init tio using md established in .init_request */
2684         init_tio(tio, rq, md);
2685
2686         /*
2687          * Establish tio->ti before queuing work (map_tio_request)
2688          * or making direct call to map_request().
2689          */
2690         tio->ti = ti;
2691
2692         /* Clone the request if underlying devices aren't blk-mq */
2693         if (dm_table_get_type(map) == DM_TYPE_REQUEST_BASED) {
2694                 /* clone request is allocated at the end of the pdu */
2695                 tio->clone = (void *)blk_mq_rq_to_pdu(rq) + sizeof(struct dm_rq_target_io);
2696                 (void) clone_rq(rq, md, tio, GFP_ATOMIC);
2697                 queue_kthread_work(&md->kworker, &tio->work);
2698         } else {
2699                 /* Direct call is fine since .queue_rq allows allocations */
2700                 if (map_request(tio, rq, md) == DM_MAPIO_REQUEUE) {
2701                         /* Undo dm_start_request() before requeuing */
2702                         rq_end_stats(md, rq);
2703                         rq_completed(md, rq_data_dir(rq), false);
2704                         return BLK_MQ_RQ_QUEUE_BUSY;
2705                 }
2706         }
2707
2708         return BLK_MQ_RQ_QUEUE_OK;
2709 }
2710
2711 static struct blk_mq_ops dm_mq_ops = {
2712         .queue_rq = dm_mq_queue_rq,
2713         .map_queue = blk_mq_map_queue,
2714         .complete = dm_softirq_done,
2715         .init_request = dm_mq_init_request,
2716 };
2717
2718 static int dm_init_request_based_blk_mq_queue(struct mapped_device *md)
2719 {
2720         unsigned md_type = dm_get_md_type(md);
2721         struct request_queue *q;
2722         int err;
2723
2724         memset(&md->tag_set, 0, sizeof(md->tag_set));
2725         md->tag_set.ops = &dm_mq_ops;
2726         md->tag_set.queue_depth = BLKDEV_MAX_RQ;
2727         md->tag_set.numa_node = NUMA_NO_NODE;
2728         md->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
2729         md->tag_set.nr_hw_queues = 1;
2730         if (md_type == DM_TYPE_REQUEST_BASED) {
2731                 /* make the memory for non-blk-mq clone part of the pdu */
2732                 md->tag_set.cmd_size = sizeof(struct dm_rq_target_io) + sizeof(struct request);
2733         } else
2734                 md->tag_set.cmd_size = sizeof(struct dm_rq_target_io);
2735         md->tag_set.driver_data = md;
2736
2737         err = blk_mq_alloc_tag_set(&md->tag_set);
2738         if (err)
2739                 return err;
2740
2741         q = blk_mq_init_allocated_queue(&md->tag_set, md->queue);
2742         if (IS_ERR(q)) {
2743                 err = PTR_ERR(q);
2744                 goto out_tag_set;
2745         }
2746         md->queue = q;
2747         dm_init_md_queue(md);
2748
2749         /* backfill 'mq' sysfs registration normally done in blk_register_queue */
2750         blk_mq_register_disk(md->disk);
2751
2752         if (md_type == DM_TYPE_REQUEST_BASED)
2753                 init_rq_based_worker_thread(md);
2754
2755         return 0;
2756
2757 out_tag_set:
2758         blk_mq_free_tag_set(&md->tag_set);
2759         return err;
2760 }
2761
2762 static unsigned filter_md_type(unsigned type, struct mapped_device *md)
2763 {
2764         if (type == DM_TYPE_BIO_BASED)
2765                 return type;
2766
2767         return !md->use_blk_mq ? DM_TYPE_REQUEST_BASED : DM_TYPE_MQ_REQUEST_BASED;
2768 }
2769
2770 /*
2771  * Setup the DM device's queue based on md's type
2772  */
2773 int dm_setup_md_queue(struct mapped_device *md)
2774 {
2775         int r;
2776         unsigned md_type = filter_md_type(dm_get_md_type(md), md);
2777
2778         switch (md_type) {
2779         case DM_TYPE_REQUEST_BASED:
2780                 r = dm_init_request_based_queue(md);
2781                 if (r) {
2782                         DMWARN("Cannot initialize queue for request-based mapped device");
2783                         return r;
2784                 }
2785                 break;
2786         case DM_TYPE_MQ_REQUEST_BASED:
2787                 r = dm_init_request_based_blk_mq_queue(md);
2788                 if (r) {
2789                         DMWARN("Cannot initialize queue for request-based blk-mq mapped device");
2790                         return r;
2791                 }
2792                 break;
2793         case DM_TYPE_BIO_BASED:
2794                 dm_init_old_md_queue(md);
2795                 blk_queue_make_request(md->queue, dm_make_request);
2796                 break;
2797         }
2798
2799         return 0;
2800 }
2801
2802 struct mapped_device *dm_get_md(dev_t dev)
2803 {
2804         struct mapped_device *md;
2805         unsigned minor = MINOR(dev);
2806
2807         if (MAJOR(dev) != _major || minor >= (1 << MINORBITS))
2808                 return NULL;
2809
2810         spin_lock(&_minor_lock);
2811
2812         md = idr_find(&_minor_idr, minor);
2813         if (md) {
2814                 if ((md == MINOR_ALLOCED ||
2815                      (MINOR(disk_devt(dm_disk(md))) != minor) ||
2816                      dm_deleting_md(md) ||
2817                      test_bit(DMF_FREEING, &md->flags))) {
2818                         md = NULL;
2819                         goto out;
2820                 }
2821                 dm_get(md);
2822         }
2823
2824 out:
2825         spin_unlock(&_minor_lock);
2826
2827         return md;
2828 }
2829 EXPORT_SYMBOL_GPL(dm_get_md);
2830
2831 void *dm_get_mdptr(struct mapped_device *md)
2832 {
2833         return md->interface_ptr;
2834 }
2835
2836 void dm_set_mdptr(struct mapped_device *md, void *ptr)
2837 {
2838         md->interface_ptr = ptr;
2839 }
2840
2841 void dm_get(struct mapped_device *md)
2842 {
2843         atomic_inc(&md->holders);
2844         BUG_ON(test_bit(DMF_FREEING, &md->flags));
2845 }
2846
2847 int dm_hold(struct mapped_device *md)
2848 {
2849         spin_lock(&_minor_lock);
2850         if (test_bit(DMF_FREEING, &md->flags)) {
2851                 spin_unlock(&_minor_lock);
2852                 return -EBUSY;
2853         }
2854         dm_get(md);
2855         spin_unlock(&_minor_lock);
2856         return 0;
2857 }
2858 EXPORT_SYMBOL_GPL(dm_hold);
2859
2860 const char *dm_device_name(struct mapped_device *md)
2861 {
2862         return md->name;
2863 }
2864 EXPORT_SYMBOL_GPL(dm_device_name);
2865
2866 static void __dm_destroy(struct mapped_device *md, bool wait)
2867 {
2868         struct dm_table *map;
2869         int srcu_idx;
2870
2871         might_sleep();
2872
2873         map = dm_get_live_table(md, &srcu_idx);
2874
2875         spin_lock(&_minor_lock);
2876         idr_replace(&_minor_idr, MINOR_ALLOCED, MINOR(disk_devt(dm_disk(md))));
2877         set_bit(DMF_FREEING, &md->flags);
2878         spin_unlock(&_minor_lock);
2879
2880         if (dm_request_based(md) && md->kworker_task)
2881                 flush_kthread_worker(&md->kworker);
2882
2883         /*
2884          * Take suspend_lock so that presuspend and postsuspend methods
2885          * do not race with internal suspend.
2886          */
2887         mutex_lock(&md->suspend_lock);
2888         if (!dm_suspended_md(md)) {
2889                 dm_table_presuspend_targets(map);
2890                 dm_table_postsuspend_targets(map);
2891         }
2892         mutex_unlock(&md->suspend_lock);
2893
2894         /* dm_put_live_table must be before msleep, otherwise deadlock is possible */
2895         dm_put_live_table(md, srcu_idx);
2896
2897         /*
2898          * Rare, but there may be I/O requests still going to complete,
2899          * for example.  Wait for all references to disappear.
2900          * No one should increment the reference count of the mapped_device,
2901          * after the mapped_device state becomes DMF_FREEING.
2902          */
2903         if (wait)
2904                 while (atomic_read(&md->holders))
2905                         msleep(1);
2906         else if (atomic_read(&md->holders))
2907                 DMWARN("%s: Forcibly removing mapped_device still in use! (%d users)",
2908                        dm_device_name(md), atomic_read(&md->holders));
2909
2910         dm_sysfs_exit(md);
2911         dm_table_destroy(__unbind(md));
2912         free_dev(md);
2913 }
2914
2915 void dm_destroy(struct mapped_device *md)
2916 {
2917         __dm_destroy(md, true);
2918 }
2919
2920 void dm_destroy_immediate(struct mapped_device *md)
2921 {
2922         __dm_destroy(md, false);
2923 }
2924
2925 void dm_put(struct mapped_device *md)
2926 {
2927         atomic_dec(&md->holders);
2928 }
2929 EXPORT_SYMBOL_GPL(dm_put);
2930
2931 static int dm_wait_for_completion(struct mapped_device *md, int interruptible)
2932 {
2933         int r = 0;
2934         DECLARE_WAITQUEUE(wait, current);
2935
2936         add_wait_queue(&md->wait, &wait);
2937
2938         while (1) {
2939                 set_current_state(interruptible);
2940
2941                 if (!md_in_flight(md))
2942                         break;
2943
2944                 if (interruptible == TASK_INTERRUPTIBLE &&
2945                     signal_pending(current)) {
2946                         r = -EINTR;
2947                         break;
2948                 }
2949
2950                 io_schedule();
2951         }
2952         set_current_state(TASK_RUNNING);
2953
2954         remove_wait_queue(&md->wait, &wait);
2955
2956         return r;
2957 }
2958
2959 /*
2960  * Process the deferred bios
2961  */
2962 static void dm_wq_work(struct work_struct *work)
2963 {
2964         struct mapped_device *md = container_of(work, struct mapped_device,
2965                                                 work);
2966         struct bio *c;
2967         int srcu_idx;
2968         struct dm_table *map;
2969
2970         map = dm_get_live_table(md, &srcu_idx);
2971
2972         while (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
2973                 spin_lock_irq(&md->deferred_lock);
2974                 c = bio_list_pop(&md->deferred);
2975                 spin_unlock_irq(&md->deferred_lock);
2976
2977                 if (!c)
2978                         break;
2979
2980                 if (dm_request_based(md))
2981                         generic_make_request(c);
2982                 else
2983                         __split_and_process_bio(md, map, c);
2984         }
2985
2986         dm_put_live_table(md, srcu_idx);
2987 }
2988
2989 static void dm_queue_flush(struct mapped_device *md)
2990 {
2991         clear_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
2992         smp_mb__after_atomic();
2993         queue_work(md->wq, &md->work);
2994 }
2995
2996 /*
2997  * Swap in a new table, returning the old one for the caller to destroy.
2998  */
2999 struct dm_table *dm_swap_table(struct mapped_device *md, struct dm_table *table)
3000 {
3001         struct dm_table *live_map = NULL, *map = ERR_PTR(-EINVAL);
3002         struct queue_limits limits;
3003         int r;
3004
3005         mutex_lock(&md->suspend_lock);
3006
3007         /* device must be suspended */
3008         if (!dm_suspended_md(md))
3009                 goto out;
3010
3011         /*
3012          * If the new table has no data devices, retain the existing limits.
3013          * This helps multipath with queue_if_no_path if all paths disappear,
3014          * then new I/O is queued based on these limits, and then some paths
3015          * reappear.
3016          */
3017         if (dm_table_has_no_data_devices(table)) {
3018                 live_map = dm_get_live_table_fast(md);
3019                 if (live_map)
3020                         limits = md->queue->limits;
3021                 dm_put_live_table_fast(md);
3022         }
3023
3024         if (!live_map) {
3025                 r = dm_calculate_queue_limits(table, &limits);
3026                 if (r) {
3027                         map = ERR_PTR(r);
3028                         goto out;
3029                 }
3030         }
3031
3032         map = __bind(md, table, &limits);
3033
3034 out:
3035         mutex_unlock(&md->suspend_lock);
3036         return map;
3037 }
3038
3039 /*
3040  * Functions to lock and unlock any filesystem running on the
3041  * device.
3042  */
3043 static int lock_fs(struct mapped_device *md)
3044 {
3045         int r;
3046
3047         WARN_ON(md->frozen_sb);
3048
3049         md->frozen_sb = freeze_bdev(md->bdev);
3050         if (IS_ERR(md->frozen_sb)) {
3051                 r = PTR_ERR(md->frozen_sb);
3052                 md->frozen_sb = NULL;
3053                 return r;
3054         }
3055
3056         set_bit(DMF_FROZEN, &md->flags);
3057
3058         return 0;
3059 }
3060
3061 static void unlock_fs(struct mapped_device *md)
3062 {
3063         if (!test_bit(DMF_FROZEN, &md->flags))
3064                 return;
3065
3066         thaw_bdev(md->bdev, md->frozen_sb);
3067         md->frozen_sb = NULL;
3068         clear_bit(DMF_FROZEN, &md->flags);
3069 }
3070
3071 /*
3072  * If __dm_suspend returns 0, the device is completely quiescent
3073  * now. There is no request-processing activity. All new requests
3074  * are being added to md->deferred list.
3075  *
3076  * Caller must hold md->suspend_lock
3077  */
3078 static int __dm_suspend(struct mapped_device *md, struct dm_table *map,
3079                         unsigned suspend_flags, int interruptible)
3080 {
3081         bool do_lockfs = suspend_flags & DM_SUSPEND_LOCKFS_FLAG;
3082         bool noflush = suspend_flags & DM_SUSPEND_NOFLUSH_FLAG;
3083         int r;
3084
3085         /*
3086          * DMF_NOFLUSH_SUSPENDING must be set before presuspend.
3087          * This flag is cleared before dm_suspend returns.
3088          */
3089         if (noflush)
3090                 set_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
3091
3092         /*
3093          * This gets reverted if there's an error later and the targets
3094          * provide the .presuspend_undo hook.
3095          */
3096         dm_table_presuspend_targets(map);
3097
3098         /*
3099          * Flush I/O to the device.
3100          * Any I/O submitted after lock_fs() may not be flushed.
3101          * noflush takes precedence over do_lockfs.
3102          * (lock_fs() flushes I/Os and waits for them to complete.)
3103          */
3104         if (!noflush && do_lockfs) {
3105                 r = lock_fs(md);
3106                 if (r) {
3107                         dm_table_presuspend_undo_targets(map);
3108                         return r;
3109                 }
3110         }
3111
3112         /*
3113          * Here we must make sure that no processes are submitting requests
3114          * to target drivers i.e. no one may be executing
3115          * __split_and_process_bio. This is called from dm_request and
3116          * dm_wq_work.
3117          *
3118          * To get all processes out of __split_and_process_bio in dm_request,
3119          * we take the write lock. To prevent any process from reentering
3120          * __split_and_process_bio from dm_request and quiesce the thread
3121          * (dm_wq_work), we set BMF_BLOCK_IO_FOR_SUSPEND and call
3122          * flush_workqueue(md->wq).
3123          */
3124         set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
3125         if (map)
3126                 synchronize_srcu(&md->io_barrier);
3127
3128         /*
3129          * Stop md->queue before flushing md->wq in case request-based
3130          * dm defers requests to md->wq from md->queue.
3131          */
3132         if (dm_request_based(md)) {
3133                 stop_queue(md->queue);
3134                 if (md->kworker_task)
3135                         flush_kthread_worker(&md->kworker);
3136         }
3137
3138         flush_workqueue(md->wq);
3139
3140         /*
3141          * At this point no more requests are entering target request routines.
3142          * We call dm_wait_for_completion to wait for all existing requests
3143          * to finish.
3144          */
3145         r = dm_wait_for_completion(md, interruptible);
3146
3147         if (noflush)
3148                 clear_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
3149         if (map)
3150                 synchronize_srcu(&md->io_barrier);
3151
3152         /* were we interrupted ? */
3153         if (r < 0) {
3154                 dm_queue_flush(md);
3155
3156                 if (dm_request_based(md))
3157                         start_queue(md->queue);
3158
3159                 unlock_fs(md);
3160                 dm_table_presuspend_undo_targets(map);
3161                 /* pushback list is already flushed, so skip flush */
3162         }
3163
3164         return r;
3165 }
3166
3167 /*
3168  * We need to be able to change a mapping table under a mounted
3169  * filesystem.  For example we might want to move some data in
3170  * the background.  Before the table can be swapped with
3171  * dm_bind_table, dm_suspend must be called to flush any in
3172  * flight bios and ensure that any further io gets deferred.
3173  */
3174 /*
3175  * Suspend mechanism in request-based dm.
3176  *
3177  * 1. Flush all I/Os by lock_fs() if needed.
3178  * 2. Stop dispatching any I/O by stopping the request_queue.
3179  * 3. Wait for all in-flight I/Os to be completed or requeued.
3180  *
3181  * To abort suspend, start the request_queue.
3182  */
3183 int dm_suspend(struct mapped_device *md, unsigned suspend_flags)
3184 {
3185         struct dm_table *map = NULL;
3186         int r = 0;
3187
3188 retry:
3189         mutex_lock_nested(&md->suspend_lock, SINGLE_DEPTH_NESTING);
3190
3191         if (dm_suspended_md(md)) {
3192                 r = -EINVAL;
3193                 goto out_unlock;
3194         }
3195
3196         if (dm_suspended_internally_md(md)) {
3197                 /* already internally suspended, wait for internal resume */
3198                 mutex_unlock(&md->suspend_lock);
3199                 r = wait_on_bit(&md->flags, DMF_SUSPENDED_INTERNALLY, TASK_INTERRUPTIBLE);
3200                 if (r)
3201                         return r;
3202                 goto retry;
3203         }
3204
3205         map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
3206
3207         r = __dm_suspend(md, map, suspend_flags, TASK_INTERRUPTIBLE);
3208         if (r)
3209                 goto out_unlock;
3210
3211         set_bit(DMF_SUSPENDED, &md->flags);
3212
3213         dm_table_postsuspend_targets(map);
3214
3215 out_unlock:
3216         mutex_unlock(&md->suspend_lock);
3217         return r;
3218 }
3219
3220 static int __dm_resume(struct mapped_device *md, struct dm_table *map)
3221 {
3222         if (map) {
3223                 int r = dm_table_resume_targets(map);
3224                 if (r)
3225                         return r;
3226         }
3227
3228         dm_queue_flush(md);
3229
3230         /*
3231          * Flushing deferred I/Os must be done after targets are resumed
3232          * so that mapping of targets can work correctly.
3233          * Request-based dm is queueing the deferred I/Os in its request_queue.
3234          */
3235         if (dm_request_based(md))
3236                 start_queue(md->queue);
3237
3238         unlock_fs(md);
3239
3240         return 0;
3241 }
3242
3243 int dm_resume(struct mapped_device *md)
3244 {
3245         int r = -EINVAL;
3246         struct dm_table *map = NULL;
3247
3248 retry:
3249         mutex_lock_nested(&md->suspend_lock, SINGLE_DEPTH_NESTING);
3250
3251         if (!dm_suspended_md(md))
3252                 goto out;
3253
3254         if (dm_suspended_internally_md(md)) {
3255                 /* already internally suspended, wait for internal resume */
3256                 mutex_unlock(&md->suspend_lock);
3257                 r = wait_on_bit(&md->flags, DMF_SUSPENDED_INTERNALLY, TASK_INTERRUPTIBLE);
3258                 if (r)
3259                         return r;
3260                 goto retry;
3261         }
3262
3263         map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
3264         if (!map || !dm_table_get_size(map))
3265                 goto out;
3266
3267         r = __dm_resume(md, map);
3268         if (r)
3269                 goto out;
3270
3271         clear_bit(DMF_SUSPENDED, &md->flags);
3272
3273         r = 0;
3274 out:
3275         mutex_unlock(&md->suspend_lock);
3276
3277         return r;
3278 }
3279
3280 /*
3281  * Internal suspend/resume works like userspace-driven suspend. It waits
3282  * until all bios finish and prevents issuing new bios to the target drivers.
3283  * It may be used only from the kernel.
3284  */
3285
3286 static void __dm_internal_suspend(struct mapped_device *md, unsigned suspend_flags)
3287 {
3288         struct dm_table *map = NULL;
3289
3290         if (md->internal_suspend_count++)
3291                 return; /* nested internal suspend */
3292
3293         if (dm_suspended_md(md)) {
3294                 set_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
3295                 return; /* nest suspend */
3296         }
3297
3298         map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
3299
3300         /*
3301          * Using TASK_UNINTERRUPTIBLE because only NOFLUSH internal suspend is
3302          * supported.  Properly supporting a TASK_INTERRUPTIBLE internal suspend
3303          * would require changing .presuspend to return an error -- avoid this
3304          * until there is a need for more elaborate variants of internal suspend.
3305          */
3306         (void) __dm_suspend(md, map, suspend_flags, TASK_UNINTERRUPTIBLE);
3307
3308         set_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
3309
3310         dm_table_postsuspend_targets(map);
3311 }
3312
3313 static void __dm_internal_resume(struct mapped_device *md)
3314 {
3315         BUG_ON(!md->internal_suspend_count);
3316
3317         if (--md->internal_suspend_count)
3318                 return; /* resume from nested internal suspend */
3319
3320         if (dm_suspended_md(md))
3321                 goto done; /* resume from nested suspend */
3322
3323         /*
3324          * NOTE: existing callers don't need to call dm_table_resume_targets
3325          * (which may fail -- so best to avoid it for now by passing NULL map)
3326          */
3327         (void) __dm_resume(md, NULL);
3328
3329 done:
3330         clear_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
3331         smp_mb__after_atomic();
3332         wake_up_bit(&md->flags, DMF_SUSPENDED_INTERNALLY);
3333 }
3334
3335 void dm_internal_suspend_noflush(struct mapped_device *md)
3336 {
3337         mutex_lock(&md->suspend_lock);
3338         __dm_internal_suspend(md, DM_SUSPEND_NOFLUSH_FLAG);
3339         mutex_unlock(&md->suspend_lock);
3340 }
3341 EXPORT_SYMBOL_GPL(dm_internal_suspend_noflush);
3342
3343 void dm_internal_resume(struct mapped_device *md)
3344 {
3345         mutex_lock(&md->suspend_lock);
3346         __dm_internal_resume(md);
3347         mutex_unlock(&md->suspend_lock);
3348 }
3349 EXPORT_SYMBOL_GPL(dm_internal_resume);
3350
3351 /*
3352  * Fast variants of internal suspend/resume hold md->suspend_lock,
3353  * which prevents interaction with userspace-driven suspend.
3354  */
3355
3356 void dm_internal_suspend_fast(struct mapped_device *md)
3357 {
3358         mutex_lock(&md->suspend_lock);
3359         if (dm_suspended_md(md) || dm_suspended_internally_md(md))
3360                 return;
3361
3362         set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
3363         synchronize_srcu(&md->io_barrier);
3364         flush_workqueue(md->wq);
3365         dm_wait_for_completion(md, TASK_UNINTERRUPTIBLE);
3366 }
3367 EXPORT_SYMBOL_GPL(dm_internal_suspend_fast);
3368
3369 void dm_internal_resume_fast(struct mapped_device *md)
3370 {
3371         if (dm_suspended_md(md) || dm_suspended_internally_md(md))
3372                 goto done;
3373
3374         dm_queue_flush(md);
3375
3376 done:
3377         mutex_unlock(&md->suspend_lock);
3378 }
3379 EXPORT_SYMBOL_GPL(dm_internal_resume_fast);
3380
3381 /*-----------------------------------------------------------------
3382  * Event notification.
3383  *---------------------------------------------------------------*/
3384 int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
3385                        unsigned cookie)
3386 {
3387         char udev_cookie[DM_COOKIE_LENGTH];
3388         char *envp[] = { udev_cookie, NULL };
3389
3390         if (!cookie)
3391                 return kobject_uevent(&disk_to_dev(md->disk)->kobj, action);
3392         else {
3393                 snprintf(udev_cookie, DM_COOKIE_LENGTH, "%s=%u",
3394                          DM_COOKIE_ENV_VAR_NAME, cookie);
3395                 return kobject_uevent_env(&disk_to_dev(md->disk)->kobj,
3396                                           action, envp);
3397         }
3398 }
3399
3400 uint32_t dm_next_uevent_seq(struct mapped_device *md)
3401 {
3402         return atomic_add_return(1, &md->uevent_seq);
3403 }
3404
3405 uint32_t dm_get_event_nr(struct mapped_device *md)
3406 {
3407         return atomic_read(&md->event_nr);
3408 }
3409
3410 int dm_wait_event(struct mapped_device *md, int event_nr)
3411 {
3412         return wait_event_interruptible(md->eventq,
3413                         (event_nr != atomic_read(&md->event_nr)));
3414 }
3415
3416 void dm_uevent_add(struct mapped_device *md, struct list_head *elist)
3417 {
3418         unsigned long flags;
3419
3420         spin_lock_irqsave(&md->uevent_lock, flags);
3421         list_add(elist, &md->uevent_list);
3422         spin_unlock_irqrestore(&md->uevent_lock, flags);
3423 }
3424
3425 /*
3426  * The gendisk is only valid as long as you have a reference
3427  * count on 'md'.
3428  */
3429 struct gendisk *dm_disk(struct mapped_device *md)
3430 {
3431         return md->disk;
3432 }
3433 EXPORT_SYMBOL_GPL(dm_disk);
3434
3435 struct kobject *dm_kobject(struct mapped_device *md)
3436 {
3437         return &md->kobj_holder.kobj;
3438 }
3439
3440 struct mapped_device *dm_get_from_kobject(struct kobject *kobj)
3441 {
3442         struct mapped_device *md;
3443
3444         md = container_of(kobj, struct mapped_device, kobj_holder.kobj);
3445
3446         if (test_bit(DMF_FREEING, &md->flags) ||
3447             dm_deleting_md(md))
3448                 return NULL;
3449
3450         dm_get(md);
3451         return md;
3452 }
3453
3454 int dm_suspended_md(struct mapped_device *md)
3455 {
3456         return test_bit(DMF_SUSPENDED, &md->flags);
3457 }
3458
3459 int dm_suspended_internally_md(struct mapped_device *md)
3460 {
3461         return test_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
3462 }
3463
3464 int dm_test_deferred_remove_flag(struct mapped_device *md)
3465 {
3466         return test_bit(DMF_DEFERRED_REMOVE, &md->flags);
3467 }
3468
3469 int dm_suspended(struct dm_target *ti)
3470 {
3471         return dm_suspended_md(dm_table_get_md(ti->table));
3472 }
3473 EXPORT_SYMBOL_GPL(dm_suspended);
3474
3475 int dm_noflush_suspending(struct dm_target *ti)
3476 {
3477         return __noflush_suspending(dm_table_get_md(ti->table));
3478 }
3479 EXPORT_SYMBOL_GPL(dm_noflush_suspending);
3480
3481 struct dm_md_mempools *dm_alloc_md_mempools(struct mapped_device *md, unsigned type,
3482                                             unsigned integrity, unsigned per_bio_data_size)
3483 {
3484         struct dm_md_mempools *pools = kzalloc(sizeof(*pools), GFP_KERNEL);
3485         struct kmem_cache *cachep = NULL;
3486         unsigned int pool_size = 0;
3487         unsigned int front_pad;
3488
3489         if (!pools)
3490                 return NULL;
3491
3492         type = filter_md_type(type, md);
3493
3494         switch (type) {
3495         case DM_TYPE_BIO_BASED:
3496                 cachep = _io_cache;
3497                 pool_size = dm_get_reserved_bio_based_ios();
3498                 front_pad = roundup(per_bio_data_size, __alignof__(struct dm_target_io)) + offsetof(struct dm_target_io, clone);
3499                 break;
3500         case DM_TYPE_REQUEST_BASED:
3501                 cachep = _rq_tio_cache;
3502                 pool_size = dm_get_reserved_rq_based_ios();
3503                 pools->rq_pool = mempool_create_slab_pool(pool_size, _rq_cache);
3504                 if (!pools->rq_pool)
3505                         goto out;
3506                 /* fall through to setup remaining rq-based pools */
3507         case DM_TYPE_MQ_REQUEST_BASED:
3508                 if (!pool_size)
3509                         pool_size = dm_get_reserved_rq_based_ios();
3510                 front_pad = offsetof(struct dm_rq_clone_bio_info, clone);
3511                 /* per_bio_data_size is not used. See __bind_mempools(). */
3512                 WARN_ON(per_bio_data_size != 0);
3513                 break;
3514         default:
3515                 BUG();
3516         }
3517
3518         if (cachep) {
3519                 pools->io_pool = mempool_create_slab_pool(pool_size, cachep);
3520                 if (!pools->io_pool)
3521                         goto out;
3522         }
3523
3524         pools->bs = bioset_create_nobvec(pool_size, front_pad);
3525         if (!pools->bs)
3526                 goto out;
3527
3528         if (integrity && bioset_integrity_create(pools->bs, pool_size))
3529                 goto out;
3530
3531         return pools;
3532
3533 out:
3534         dm_free_md_mempools(pools);
3535
3536         return NULL;
3537 }
3538
3539 void dm_free_md_mempools(struct dm_md_mempools *pools)
3540 {
3541         if (!pools)
3542                 return;
3543
3544         if (pools->io_pool)
3545                 mempool_destroy(pools->io_pool);
3546
3547         if (pools->rq_pool)
3548                 mempool_destroy(pools->rq_pool);
3549
3550         if (pools->bs)
3551                 bioset_free(pools->bs);
3552
3553         kfree(pools);
3554 }
3555
3556 static const struct block_device_operations dm_blk_dops = {
3557         .open = dm_blk_open,
3558         .release = dm_blk_close,
3559         .ioctl = dm_blk_ioctl,
3560         .getgeo = dm_blk_getgeo,
3561         .owner = THIS_MODULE
3562 };
3563
3564 /*
3565  * module hooks
3566  */
3567 module_init(dm_init);
3568 module_exit(dm_exit);
3569
3570 module_param(major, uint, 0);
3571 MODULE_PARM_DESC(major, "The major number of the device mapper");
3572
3573 module_param(reserved_bio_based_ios, uint, S_IRUGO | S_IWUSR);
3574 MODULE_PARM_DESC(reserved_bio_based_ios, "Reserved IOs in bio-based mempools");
3575
3576 module_param(reserved_rq_based_ios, uint, S_IRUGO | S_IWUSR);
3577 MODULE_PARM_DESC(reserved_rq_based_ios, "Reserved IOs in request-based mempools");
3578
3579 module_param(use_blk_mq, bool, S_IRUGO | S_IWUSR);
3580 MODULE_PARM_DESC(use_blk_mq, "Use block multiqueue for request-based DM devices");
3581
3582 MODULE_DESCRIPTION(DM_NAME " driver");
3583 MODULE_AUTHOR("Joe Thornber <dm-devel@redhat.com>");
3584 MODULE_LICENSE("GPL");