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