OSDN Git Service

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