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