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