dm: rename bio cloning functions
[linux-block.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                         bio_endio(bio, io_error);
630                 }
631         }
632 }
633
634 static void clone_endio(struct bio *bio, int error)
635 {
636         int r = 0;
637         struct dm_target_io *tio = bio->bi_private;
638         struct dm_io *io = tio->io;
639         struct mapped_device *md = tio->io->md;
640         dm_endio_fn endio = tio->ti->type->end_io;
641
642         if (!bio_flagged(bio, BIO_UPTODATE) && !error)
643                 error = -EIO;
644
645         if (endio) {
646                 r = endio(tio->ti, bio, error);
647                 if (r < 0 || r == DM_ENDIO_REQUEUE)
648                         /*
649                          * error and requeue request are handled
650                          * in dec_pending().
651                          */
652                         error = r;
653                 else if (r == DM_ENDIO_INCOMPLETE)
654                         /* The target will handle the io */
655                         return;
656                 else if (r) {
657                         DMWARN("unimplemented target endio return value: %d", r);
658                         BUG();
659                 }
660         }
661
662         free_tio(md, tio);
663         dec_pending(io, error);
664 }
665
666 /*
667  * Partial completion handling for request-based dm
668  */
669 static void end_clone_bio(struct bio *clone, int error)
670 {
671         struct dm_rq_clone_bio_info *info = clone->bi_private;
672         struct dm_rq_target_io *tio = info->tio;
673         struct bio *bio = info->orig;
674         unsigned int nr_bytes = info->orig->bi_size;
675
676         bio_put(clone);
677
678         if (tio->error)
679                 /*
680                  * An error has already been detected on the request.
681                  * Once error occurred, just let clone->end_io() handle
682                  * the remainder.
683                  */
684                 return;
685         else if (error) {
686                 /*
687                  * Don't notice the error to the upper layer yet.
688                  * The error handling decision is made by the target driver,
689                  * when the request is completed.
690                  */
691                 tio->error = error;
692                 return;
693         }
694
695         /*
696          * I/O for the bio successfully completed.
697          * Notice the data completion to the upper layer.
698          */
699
700         /*
701          * bios are processed from the head of the list.
702          * So the completing bio should always be rq->bio.
703          * If it's not, something wrong is happening.
704          */
705         if (tio->orig->bio != bio)
706                 DMERR("bio completion is going in the middle of the request");
707
708         /*
709          * Update the original request.
710          * Do not use blk_end_request() here, because it may complete
711          * the original request before the clone, and break the ordering.
712          */
713         blk_update_request(tio->orig, 0, nr_bytes);
714 }
715
716 /*
717  * Don't touch any member of the md after calling this function because
718  * the md may be freed in dm_put() at the end of this function.
719  * Or do dm_get() before calling this function and dm_put() later.
720  */
721 static void rq_completed(struct mapped_device *md, int rw, int run_queue)
722 {
723         atomic_dec(&md->pending[rw]);
724
725         /* nudge anyone waiting on suspend queue */
726         if (!md_in_flight(md))
727                 wake_up(&md->wait);
728
729         /*
730          * Run this off this callpath, as drivers could invoke end_io while
731          * inside their request_fn (and holding the queue lock). Calling
732          * back into ->request_fn() could deadlock attempting to grab the
733          * queue lock again.
734          */
735         if (run_queue)
736                 blk_run_queue_async(md->queue);
737
738         /*
739          * dm_put() must be at the end of this function. See the comment above
740          */
741         dm_put(md);
742 }
743
744 static void free_rq_clone(struct request *clone)
745 {
746         struct dm_rq_target_io *tio = clone->end_io_data;
747
748         blk_rq_unprep_clone(clone);
749         free_rq_tio(tio);
750 }
751
752 /*
753  * Complete the clone and the original request.
754  * Must be called without queue lock.
755  */
756 static void dm_end_request(struct request *clone, int error)
757 {
758         int rw = rq_data_dir(clone);
759         struct dm_rq_target_io *tio = clone->end_io_data;
760         struct mapped_device *md = tio->md;
761         struct request *rq = tio->orig;
762
763         if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
764                 rq->errors = clone->errors;
765                 rq->resid_len = clone->resid_len;
766
767                 if (rq->sense)
768                         /*
769                          * We are using the sense buffer of the original
770                          * request.
771                          * So setting the length of the sense data is enough.
772                          */
773                         rq->sense_len = clone->sense_len;
774         }
775
776         free_rq_clone(clone);
777         blk_end_request_all(rq, error);
778         rq_completed(md, rw, true);
779 }
780
781 static void dm_unprep_request(struct request *rq)
782 {
783         struct request *clone = rq->special;
784
785         rq->special = NULL;
786         rq->cmd_flags &= ~REQ_DONTPREP;
787
788         free_rq_clone(clone);
789 }
790
791 /*
792  * Requeue the original request of a clone.
793  */
794 void dm_requeue_unmapped_request(struct request *clone)
795 {
796         int rw = rq_data_dir(clone);
797         struct dm_rq_target_io *tio = clone->end_io_data;
798         struct mapped_device *md = tio->md;
799         struct request *rq = tio->orig;
800         struct request_queue *q = rq->q;
801         unsigned long flags;
802
803         dm_unprep_request(rq);
804
805         spin_lock_irqsave(q->queue_lock, flags);
806         blk_requeue_request(q, rq);
807         spin_unlock_irqrestore(q->queue_lock, flags);
808
809         rq_completed(md, rw, 0);
810 }
811 EXPORT_SYMBOL_GPL(dm_requeue_unmapped_request);
812
813 static void __stop_queue(struct request_queue *q)
814 {
815         blk_stop_queue(q);
816 }
817
818 static void stop_queue(struct request_queue *q)
819 {
820         unsigned long flags;
821
822         spin_lock_irqsave(q->queue_lock, flags);
823         __stop_queue(q);
824         spin_unlock_irqrestore(q->queue_lock, flags);
825 }
826
827 static void __start_queue(struct request_queue *q)
828 {
829         if (blk_queue_stopped(q))
830                 blk_start_queue(q);
831 }
832
833 static void start_queue(struct request_queue *q)
834 {
835         unsigned long flags;
836
837         spin_lock_irqsave(q->queue_lock, flags);
838         __start_queue(q);
839         spin_unlock_irqrestore(q->queue_lock, flags);
840 }
841
842 static void dm_done(struct request *clone, int error, bool mapped)
843 {
844         int r = error;
845         struct dm_rq_target_io *tio = clone->end_io_data;
846         dm_request_endio_fn rq_end_io = NULL;
847
848         if (tio->ti) {
849                 rq_end_io = tio->ti->type->rq_end_io;
850
851                 if (mapped && rq_end_io)
852                         r = rq_end_io(tio->ti, clone, error, &tio->info);
853         }
854
855         if (r <= 0)
856                 /* The target wants to complete the I/O */
857                 dm_end_request(clone, r);
858         else if (r == DM_ENDIO_INCOMPLETE)
859                 /* The target will handle the I/O */
860                 return;
861         else if (r == DM_ENDIO_REQUEUE)
862                 /* The target wants to requeue the I/O */
863                 dm_requeue_unmapped_request(clone);
864         else {
865                 DMWARN("unimplemented target endio return value: %d", r);
866                 BUG();
867         }
868 }
869
870 /*
871  * Request completion handler for request-based dm
872  */
873 static void dm_softirq_done(struct request *rq)
874 {
875         bool mapped = true;
876         struct request *clone = rq->completion_data;
877         struct dm_rq_target_io *tio = clone->end_io_data;
878
879         if (rq->cmd_flags & REQ_FAILED)
880                 mapped = false;
881
882         dm_done(clone, tio->error, mapped);
883 }
884
885 /*
886  * Complete the clone and the original request with the error status
887  * through softirq context.
888  */
889 static void dm_complete_request(struct request *clone, int error)
890 {
891         struct dm_rq_target_io *tio = clone->end_io_data;
892         struct request *rq = tio->orig;
893
894         tio->error = error;
895         rq->completion_data = clone;
896         blk_complete_request(rq);
897 }
898
899 /*
900  * Complete the not-mapped clone and the original request with the error status
901  * through softirq context.
902  * Target's rq_end_io() function isn't called.
903  * This may be used when the target's map_rq() function fails.
904  */
905 void dm_kill_unmapped_request(struct request *clone, int error)
906 {
907         struct dm_rq_target_io *tio = clone->end_io_data;
908         struct request *rq = tio->orig;
909
910         rq->cmd_flags |= REQ_FAILED;
911         dm_complete_request(clone, error);
912 }
913 EXPORT_SYMBOL_GPL(dm_kill_unmapped_request);
914
915 /*
916  * Called with the queue lock held
917  */
918 static void end_clone_request(struct request *clone, int error)
919 {
920         /*
921          * For just cleaning up the information of the queue in which
922          * the clone was dispatched.
923          * The clone is *NOT* freed actually here because it is alloced from
924          * dm own mempool and REQ_ALLOCED isn't set in clone->cmd_flags.
925          */
926         __blk_put_request(clone->q, clone);
927
928         /*
929          * Actual request completion is done in a softirq context which doesn't
930          * hold the queue lock.  Otherwise, deadlock could occur because:
931          *     - another request may be submitted by the upper level driver
932          *       of the stacking during the completion
933          *     - the submission which requires queue lock may be done
934          *       against this queue
935          */
936         dm_complete_request(clone, error);
937 }
938
939 /*
940  * Return maximum size of I/O possible at the supplied sector up to the current
941  * target boundary.
942  */
943 static sector_t max_io_len_target_boundary(sector_t sector, struct dm_target *ti)
944 {
945         sector_t target_offset = dm_target_offset(ti, sector);
946
947         return ti->len - target_offset;
948 }
949
950 static sector_t max_io_len(sector_t sector, struct dm_target *ti)
951 {
952         sector_t len = max_io_len_target_boundary(sector, ti);
953         sector_t offset, max_len;
954
955         /*
956          * Does the target need to split even further?
957          */
958         if (ti->max_io_len) {
959                 offset = dm_target_offset(ti, sector);
960                 if (unlikely(ti->max_io_len & (ti->max_io_len - 1)))
961                         max_len = sector_div(offset, ti->max_io_len);
962                 else
963                         max_len = offset & (ti->max_io_len - 1);
964                 max_len = ti->max_io_len - max_len;
965
966                 if (len > max_len)
967                         len = max_len;
968         }
969
970         return len;
971 }
972
973 int dm_set_target_max_io_len(struct dm_target *ti, sector_t len)
974 {
975         if (len > UINT_MAX) {
976                 DMERR("Specified maximum size of target IO (%llu) exceeds limit (%u)",
977                       (unsigned long long)len, UINT_MAX);
978                 ti->error = "Maximum size of target IO is too large";
979                 return -EINVAL;
980         }
981
982         ti->max_io_len = (uint32_t) len;
983
984         return 0;
985 }
986 EXPORT_SYMBOL_GPL(dm_set_target_max_io_len);
987
988 static void __map_bio(struct dm_target_io *tio)
989 {
990         int r;
991         sector_t sector;
992         struct mapped_device *md;
993         struct bio *clone = &tio->clone;
994         struct dm_target *ti = tio->ti;
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 static void bio_setup_sector(struct bio *bio, sector_t sector, sector_t len)
1036 {
1037         bio->bi_sector = sector;
1038         bio->bi_size = to_bytes(len);
1039 }
1040
1041 static void bio_setup_bv(struct bio *bio, unsigned short idx, unsigned short bv_count)
1042 {
1043         bio->bi_idx = idx;
1044         bio->bi_vcnt = idx + bv_count;
1045         bio->bi_flags &= ~(1 << BIO_SEG_VALID);
1046 }
1047
1048 static void clone_bio_integrity(struct bio *bio, struct bio *clone,
1049                                 unsigned short idx, unsigned len, unsigned offset,
1050                                 unsigned trim)
1051 {
1052         if (!bio_integrity(bio))
1053                 return;
1054
1055         bio_integrity_clone(clone, bio, GFP_NOIO);
1056
1057         if (trim)
1058                 bio_integrity_trim(clone, bio_sector_offset(bio, idx, offset), len);
1059 }
1060
1061 /*
1062  * Creates a little bio that just does part of a bvec.
1063  */
1064 static void clone_split_bio(struct dm_target_io *tio, struct bio *bio,
1065                             sector_t sector, unsigned short idx,
1066                             unsigned offset, unsigned len)
1067 {
1068         struct bio *clone = &tio->clone;
1069         struct bio_vec *bv = bio->bi_io_vec + idx;
1070
1071         *clone->bi_io_vec = *bv;
1072
1073         bio_setup_sector(clone, sector, len);
1074
1075         clone->bi_bdev = bio->bi_bdev;
1076         clone->bi_rw = bio->bi_rw;
1077         clone->bi_vcnt = 1;
1078         clone->bi_io_vec->bv_offset = offset;
1079         clone->bi_io_vec->bv_len = clone->bi_size;
1080         clone->bi_flags |= 1 << BIO_CLONED;
1081
1082         clone_bio_integrity(bio, clone, idx, len, offset, 1);
1083 }
1084
1085 /*
1086  * Creates a bio that consists of range of complete bvecs.
1087  */
1088 static void clone_bio(struct dm_target_io *tio, struct bio *bio,
1089                       sector_t sector, unsigned short idx,
1090                       unsigned short bv_count, unsigned int len)
1091 {
1092         struct bio *clone = &tio->clone;
1093         unsigned trim = 0;
1094
1095         __bio_clone(clone, bio);
1096         bio_setup_sector(clone, sector, len);
1097         bio_setup_bv(clone, idx, bv_count);
1098
1099         if (idx != bio->bi_idx || clone->bi_size < bio->bi_size)
1100                 trim = 1;
1101         clone_bio_integrity(bio, clone, idx, len, 0, trim);
1102 }
1103
1104 static struct dm_target_io *alloc_tio(struct clone_info *ci,
1105                                       struct dm_target *ti, int nr_iovecs,
1106                                       unsigned target_bio_nr)
1107 {
1108         struct dm_target_io *tio;
1109         struct bio *clone;
1110
1111         clone = bio_alloc_bioset(GFP_NOIO, nr_iovecs, ci->md->bs);
1112         tio = container_of(clone, struct dm_target_io, clone);
1113
1114         tio->io = ci->io;
1115         tio->ti = ti;
1116         memset(&tio->info, 0, sizeof(tio->info));
1117         tio->target_bio_nr = target_bio_nr;
1118
1119         return tio;
1120 }
1121
1122 static void __clone_and_map_simple_bio(struct clone_info *ci,
1123                                        struct dm_target *ti,
1124                                        unsigned target_bio_nr, sector_t len)
1125 {
1126         struct dm_target_io *tio = alloc_tio(ci, ti, ci->bio->bi_max_vecs, target_bio_nr);
1127         struct bio *clone = &tio->clone;
1128
1129         /*
1130          * Discard requests require the bio's inline iovecs be initialized.
1131          * ci->bio->bi_max_vecs is BIO_INLINE_VECS anyway, for both flush
1132          * and discard, so no need for concern about wasted bvec allocations.
1133          */
1134          __bio_clone(clone, ci->bio);
1135         if (len)
1136                 bio_setup_sector(clone, ci->sector, len);
1137
1138         __map_bio(tio);
1139 }
1140
1141 static void __send_duplicate_bios(struct clone_info *ci, struct dm_target *ti,
1142                                   unsigned num_bios, sector_t len)
1143 {
1144         unsigned target_bio_nr;
1145
1146         for (target_bio_nr = 0; target_bio_nr < num_bios; target_bio_nr++)
1147                 __clone_and_map_simple_bio(ci, ti, target_bio_nr, len);
1148 }
1149
1150 static int __send_empty_flush(struct clone_info *ci)
1151 {
1152         unsigned target_nr = 0;
1153         struct dm_target *ti;
1154
1155         BUG_ON(bio_has_data(ci->bio));
1156         while ((ti = dm_table_get_target(ci->map, target_nr++)))
1157                 __send_duplicate_bios(ci, ti, ti->num_flush_bios, 0);
1158
1159         return 0;
1160 }
1161
1162 static void __clone_and_map_data_bio(struct clone_info *ci,
1163                                      struct dm_target *ti)
1164 {
1165         struct bio *bio = ci->bio;
1166         struct dm_target_io *tio;
1167
1168         tio = alloc_tio(ci, ti, bio->bi_max_vecs, 0);
1169         clone_bio(tio, bio, ci->sector, ci->idx, bio->bi_vcnt - ci->idx,
1170                   ci->sector_count);
1171         __map_bio(tio);
1172         ci->sector_count = 0;
1173 }
1174
1175 typedef unsigned (*get_num_bios_fn)(struct dm_target *ti);
1176
1177 static unsigned get_num_discard_bios(struct dm_target *ti)
1178 {
1179         return ti->num_discard_bios;
1180 }
1181
1182 static unsigned get_num_write_same_bios(struct dm_target *ti)
1183 {
1184         return ti->num_write_same_bios;
1185 }
1186
1187 typedef bool (*is_split_required_fn)(struct dm_target *ti);
1188
1189 static bool is_split_required_for_discard(struct dm_target *ti)
1190 {
1191         return ti->split_discard_bios;
1192 }
1193
1194 static int __send_changing_extent_only(struct clone_info *ci,
1195                                        get_num_bios_fn get_num_bios,
1196                                        is_split_required_fn is_split_required)
1197 {
1198         struct dm_target *ti;
1199         sector_t len;
1200         unsigned num_bios;
1201
1202         do {
1203                 ti = dm_table_find_target(ci->map, ci->sector);
1204                 if (!dm_target_is_valid(ti))
1205                         return -EIO;
1206
1207                 /*
1208                  * Even though the device advertised support for this type of
1209                  * request, that does not mean every target supports it, and
1210                  * reconfiguration might also have changed that since the
1211                  * check was performed.
1212                  */
1213                 num_bios = get_num_bios ? get_num_bios(ti) : 0;
1214                 if (!num_bios)
1215                         return -EOPNOTSUPP;
1216
1217                 if (is_split_required && !is_split_required(ti))
1218                         len = min(ci->sector_count, max_io_len_target_boundary(ci->sector, ti));
1219                 else
1220                         len = min(ci->sector_count, max_io_len(ci->sector, ti));
1221
1222                 __send_duplicate_bios(ci, ti, num_bios, len);
1223
1224                 ci->sector += len;
1225         } while (ci->sector_count -= len);
1226
1227         return 0;
1228 }
1229
1230 static int __send_discard(struct clone_info *ci)
1231 {
1232         return __send_changing_extent_only(ci, get_num_discard_bios,
1233                                            is_split_required_for_discard);
1234 }
1235
1236 static int __send_write_same(struct clone_info *ci)
1237 {
1238         return __send_changing_extent_only(ci, get_num_write_same_bios, NULL);
1239 }
1240
1241 static int __split_and_process_non_flush(struct clone_info *ci)
1242 {
1243         struct bio *bio = ci->bio;
1244         struct dm_target *ti;
1245         sector_t len = 0, max;
1246         struct dm_target_io *tio;
1247
1248         if (unlikely(bio->bi_rw & REQ_DISCARD))
1249                 return __send_discard(ci);
1250         else if (unlikely(bio->bi_rw & REQ_WRITE_SAME))
1251                 return __send_write_same(ci);
1252
1253         ti = dm_table_find_target(ci->map, ci->sector);
1254         if (!dm_target_is_valid(ti))
1255                 return -EIO;
1256
1257         max = max_io_len(ci->sector, ti);
1258
1259         if (ci->sector_count <= max) {
1260                 /*
1261                  * Optimise for the simple case where we can do all of
1262                  * the remaining io with a single clone.
1263                  */
1264                 __clone_and_map_data_bio(ci, ti);
1265
1266         } else if (to_sector(bio->bi_io_vec[ci->idx].bv_len) <= max) {
1267                 /*
1268                  * There are some bvecs that don't span targets.
1269                  * Do as many of these as possible.
1270                  */
1271                 int i;
1272                 sector_t remaining = max;
1273                 sector_t bv_len;
1274
1275                 for (i = ci->idx; remaining && (i < bio->bi_vcnt); i++) {
1276                         bv_len = to_sector(bio->bi_io_vec[i].bv_len);
1277
1278                         if (bv_len > remaining)
1279                                 break;
1280
1281                         remaining -= bv_len;
1282                         len += bv_len;
1283                 }
1284
1285                 tio = alloc_tio(ci, ti, bio->bi_max_vecs, 0);
1286                 clone_bio(tio, bio, ci->sector, ci->idx, i - ci->idx, len);
1287                 __map_bio(tio);
1288
1289                 ci->sector += len;
1290                 ci->sector_count -= len;
1291                 ci->idx = i;
1292
1293         } else {
1294                 /*
1295                  * Handle a bvec that must be split between two or more targets.
1296                  */
1297                 struct bio_vec *bv = bio->bi_io_vec + ci->idx;
1298                 sector_t remaining = to_sector(bv->bv_len);
1299                 unsigned int offset = 0;
1300
1301                 do {
1302                         if (offset) {
1303                                 ti = dm_table_find_target(ci->map, ci->sector);
1304                                 if (!dm_target_is_valid(ti))
1305                                         return -EIO;
1306
1307                                 max = max_io_len(ci->sector, ti);
1308                         }
1309
1310                         len = min(remaining, max);
1311
1312                         tio = alloc_tio(ci, ti, 1, 0);
1313                         clone_split_bio(tio, bio, ci->sector, ci->idx,
1314                                         bv->bv_offset + offset, len);
1315
1316                         __map_bio(tio);
1317
1318                         ci->sector += len;
1319                         ci->sector_count -= len;
1320                         offset += to_bytes(len);
1321                 } while (remaining -= len);
1322
1323                 ci->idx++;
1324         }
1325
1326         return 0;
1327 }
1328
1329 /*
1330  * Entry point to split a bio into clones and submit them to the targets.
1331  */
1332 static void __split_and_process_bio(struct mapped_device *md, struct bio *bio)
1333 {
1334         struct clone_info ci;
1335         int error = 0;
1336
1337         ci.map = dm_get_live_table(md);
1338         if (unlikely(!ci.map)) {
1339                 bio_io_error(bio);
1340                 return;
1341         }
1342
1343         ci.md = md;
1344         ci.io = alloc_io(md);
1345         ci.io->error = 0;
1346         atomic_set(&ci.io->io_count, 1);
1347         ci.io->bio = bio;
1348         ci.io->md = md;
1349         spin_lock_init(&ci.io->endio_lock);
1350         ci.sector = bio->bi_sector;
1351         ci.idx = bio->bi_idx;
1352
1353         start_io_acct(ci.io);
1354
1355         if (bio->bi_rw & REQ_FLUSH) {
1356                 ci.bio = &ci.md->flush_bio;
1357                 ci.sector_count = 0;
1358                 error = __send_empty_flush(&ci);
1359                 /* dec_pending submits any data associated with flush */
1360         } else {
1361                 ci.bio = bio;
1362                 ci.sector_count = bio_sectors(bio);
1363                 while (ci.sector_count && !error)
1364                         error = __split_and_process_non_flush(&ci);
1365         }
1366
1367         /* drop the extra reference count */
1368         dec_pending(ci.io, error);
1369         dm_table_put(ci.map);
1370 }
1371 /*-----------------------------------------------------------------
1372  * CRUD END
1373  *---------------------------------------------------------------*/
1374
1375 static int dm_merge_bvec(struct request_queue *q,
1376                          struct bvec_merge_data *bvm,
1377                          struct bio_vec *biovec)
1378 {
1379         struct mapped_device *md = q->queuedata;
1380         struct dm_table *map = dm_get_live_table(md);
1381         struct dm_target *ti;
1382         sector_t max_sectors;
1383         int max_size = 0;
1384
1385         if (unlikely(!map))
1386                 goto out;
1387
1388         ti = dm_table_find_target(map, bvm->bi_sector);
1389         if (!dm_target_is_valid(ti))
1390                 goto out_table;
1391
1392         /*
1393          * Find maximum amount of I/O that won't need splitting
1394          */
1395         max_sectors = min(max_io_len(bvm->bi_sector, ti),
1396                           (sector_t) BIO_MAX_SECTORS);
1397         max_size = (max_sectors << SECTOR_SHIFT) - bvm->bi_size;
1398         if (max_size < 0)
1399                 max_size = 0;
1400
1401         /*
1402          * merge_bvec_fn() returns number of bytes
1403          * it can accept at this offset
1404          * max is precomputed maximal io size
1405          */
1406         if (max_size && ti->type->merge)
1407                 max_size = ti->type->merge(ti, bvm, biovec, max_size);
1408         /*
1409          * If the target doesn't support merge method and some of the devices
1410          * provided their merge_bvec method (we know this by looking at
1411          * queue_max_hw_sectors), then we can't allow bios with multiple vector
1412          * entries.  So always set max_size to 0, and the code below allows
1413          * just one page.
1414          */
1415         else if (queue_max_hw_sectors(q) <= PAGE_SIZE >> 9)
1416
1417                 max_size = 0;
1418
1419 out_table:
1420         dm_table_put(map);
1421
1422 out:
1423         /*
1424          * Always allow an entire first page
1425          */
1426         if (max_size <= biovec->bv_len && !(bvm->bi_size >> SECTOR_SHIFT))
1427                 max_size = biovec->bv_len;
1428
1429         return max_size;
1430 }
1431
1432 /*
1433  * The request function that just remaps the bio built up by
1434  * dm_merge_bvec.
1435  */
1436 static void _dm_request(struct request_queue *q, struct bio *bio)
1437 {
1438         int rw = bio_data_dir(bio);
1439         struct mapped_device *md = q->queuedata;
1440         int cpu;
1441
1442         down_read(&md->io_lock);
1443
1444         cpu = part_stat_lock();
1445         part_stat_inc(cpu, &dm_disk(md)->part0, ios[rw]);
1446         part_stat_add(cpu, &dm_disk(md)->part0, sectors[rw], bio_sectors(bio));
1447         part_stat_unlock();
1448
1449         /* if we're suspended, we have to queue this io for later */
1450         if (unlikely(test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags))) {
1451                 up_read(&md->io_lock);
1452
1453                 if (bio_rw(bio) != READA)
1454                         queue_io(md, bio);
1455                 else
1456                         bio_io_error(bio);
1457                 return;
1458         }
1459
1460         __split_and_process_bio(md, bio);
1461         up_read(&md->io_lock);
1462         return;
1463 }
1464
1465 static int dm_request_based(struct mapped_device *md)
1466 {
1467         return blk_queue_stackable(md->queue);
1468 }
1469
1470 static void dm_request(struct request_queue *q, struct bio *bio)
1471 {
1472         struct mapped_device *md = q->queuedata;
1473
1474         if (dm_request_based(md))
1475                 blk_queue_bio(q, bio);
1476         else
1477                 _dm_request(q, bio);
1478 }
1479
1480 void dm_dispatch_request(struct request *rq)
1481 {
1482         int r;
1483
1484         if (blk_queue_io_stat(rq->q))
1485                 rq->cmd_flags |= REQ_IO_STAT;
1486
1487         rq->start_time = jiffies;
1488         r = blk_insert_cloned_request(rq->q, rq);
1489         if (r)
1490                 dm_complete_request(rq, r);
1491 }
1492 EXPORT_SYMBOL_GPL(dm_dispatch_request);
1493
1494 static int dm_rq_bio_constructor(struct bio *bio, struct bio *bio_orig,
1495                                  void *data)
1496 {
1497         struct dm_rq_target_io *tio = data;
1498         struct dm_rq_clone_bio_info *info =
1499                 container_of(bio, struct dm_rq_clone_bio_info, clone);
1500
1501         info->orig = bio_orig;
1502         info->tio = tio;
1503         bio->bi_end_io = end_clone_bio;
1504         bio->bi_private = info;
1505
1506         return 0;
1507 }
1508
1509 static int setup_clone(struct request *clone, struct request *rq,
1510                        struct dm_rq_target_io *tio)
1511 {
1512         int r;
1513
1514         r = blk_rq_prep_clone(clone, rq, tio->md->bs, GFP_ATOMIC,
1515                               dm_rq_bio_constructor, tio);
1516         if (r)
1517                 return r;
1518
1519         clone->cmd = rq->cmd;
1520         clone->cmd_len = rq->cmd_len;
1521         clone->sense = rq->sense;
1522         clone->buffer = rq->buffer;
1523         clone->end_io = end_clone_request;
1524         clone->end_io_data = tio;
1525
1526         return 0;
1527 }
1528
1529 static struct request *clone_rq(struct request *rq, struct mapped_device *md,
1530                                 gfp_t gfp_mask)
1531 {
1532         struct request *clone;
1533         struct dm_rq_target_io *tio;
1534
1535         tio = alloc_rq_tio(md, gfp_mask);
1536         if (!tio)
1537                 return NULL;
1538
1539         tio->md = md;
1540         tio->ti = NULL;
1541         tio->orig = rq;
1542         tio->error = 0;
1543         memset(&tio->info, 0, sizeof(tio->info));
1544
1545         clone = &tio->clone;
1546         if (setup_clone(clone, rq, tio)) {
1547                 /* -ENOMEM */
1548                 free_rq_tio(tio);
1549                 return NULL;
1550         }
1551
1552         return clone;
1553 }
1554
1555 /*
1556  * Called with the queue lock held.
1557  */
1558 static int dm_prep_fn(struct request_queue *q, struct request *rq)
1559 {
1560         struct mapped_device *md = q->queuedata;
1561         struct request *clone;
1562
1563         if (unlikely(rq->special)) {
1564                 DMWARN("Already has something in rq->special.");
1565                 return BLKPREP_KILL;
1566         }
1567
1568         clone = clone_rq(rq, md, GFP_ATOMIC);
1569         if (!clone)
1570                 return BLKPREP_DEFER;
1571
1572         rq->special = clone;
1573         rq->cmd_flags |= REQ_DONTPREP;
1574
1575         return BLKPREP_OK;
1576 }
1577
1578 /*
1579  * Returns:
1580  * 0  : the request has been processed (not requeued)
1581  * !0 : the request has been requeued
1582  */
1583 static int map_request(struct dm_target *ti, struct request *clone,
1584                        struct mapped_device *md)
1585 {
1586         int r, requeued = 0;
1587         struct dm_rq_target_io *tio = clone->end_io_data;
1588
1589         tio->ti = ti;
1590         r = ti->type->map_rq(ti, clone, &tio->info);
1591         switch (r) {
1592         case DM_MAPIO_SUBMITTED:
1593                 /* The target has taken the I/O to submit by itself later */
1594                 break;
1595         case DM_MAPIO_REMAPPED:
1596                 /* The target has remapped the I/O so dispatch it */
1597                 trace_block_rq_remap(clone->q, clone, disk_devt(dm_disk(md)),
1598                                      blk_rq_pos(tio->orig));
1599                 dm_dispatch_request(clone);
1600                 break;
1601         case DM_MAPIO_REQUEUE:
1602                 /* The target wants to requeue the I/O */
1603                 dm_requeue_unmapped_request(clone);
1604                 requeued = 1;
1605                 break;
1606         default:
1607                 if (r > 0) {
1608                         DMWARN("unimplemented target map return value: %d", r);
1609                         BUG();
1610                 }
1611
1612                 /* The target wants to complete the I/O */
1613                 dm_kill_unmapped_request(clone, r);
1614                 break;
1615         }
1616
1617         return requeued;
1618 }
1619
1620 static struct request *dm_start_request(struct mapped_device *md, struct request *orig)
1621 {
1622         struct request *clone;
1623
1624         blk_start_request(orig);
1625         clone = orig->special;
1626         atomic_inc(&md->pending[rq_data_dir(clone)]);
1627
1628         /*
1629          * Hold the md reference here for the in-flight I/O.
1630          * We can't rely on the reference count by device opener,
1631          * because the device may be closed during the request completion
1632          * when all bios are completed.
1633          * See the comment in rq_completed() too.
1634          */
1635         dm_get(md);
1636
1637         return clone;
1638 }
1639
1640 /*
1641  * q->request_fn for request-based dm.
1642  * Called with the queue lock held.
1643  */
1644 static void dm_request_fn(struct request_queue *q)
1645 {
1646         struct mapped_device *md = q->queuedata;
1647         struct dm_table *map = dm_get_live_table(md);
1648         struct dm_target *ti;
1649         struct request *rq, *clone;
1650         sector_t pos;
1651
1652         /*
1653          * For suspend, check blk_queue_stopped() and increment
1654          * ->pending within a single queue_lock not to increment the
1655          * number of in-flight I/Os after the queue is stopped in
1656          * dm_suspend().
1657          */
1658         while (!blk_queue_stopped(q)) {
1659                 rq = blk_peek_request(q);
1660                 if (!rq)
1661                         goto delay_and_out;
1662
1663                 /* always use block 0 to find the target for flushes for now */
1664                 pos = 0;
1665                 if (!(rq->cmd_flags & REQ_FLUSH))
1666                         pos = blk_rq_pos(rq);
1667
1668                 ti = dm_table_find_target(map, pos);
1669                 if (!dm_target_is_valid(ti)) {
1670                         /*
1671                          * Must perform setup, that dm_done() requires,
1672                          * before calling dm_kill_unmapped_request
1673                          */
1674                         DMERR_LIMIT("request attempted access beyond the end of device");
1675                         clone = dm_start_request(md, rq);
1676                         dm_kill_unmapped_request(clone, -EIO);
1677                         continue;
1678                 }
1679
1680                 if (ti->type->busy && ti->type->busy(ti))
1681                         goto delay_and_out;
1682
1683                 clone = dm_start_request(md, rq);
1684
1685                 spin_unlock(q->queue_lock);
1686                 if (map_request(ti, clone, md))
1687                         goto requeued;
1688
1689                 BUG_ON(!irqs_disabled());
1690                 spin_lock(q->queue_lock);
1691         }
1692
1693         goto out;
1694
1695 requeued:
1696         BUG_ON(!irqs_disabled());
1697         spin_lock(q->queue_lock);
1698
1699 delay_and_out:
1700         blk_delay_queue(q, HZ / 10);
1701 out:
1702         dm_table_put(map);
1703 }
1704
1705 int dm_underlying_device_busy(struct request_queue *q)
1706 {
1707         return blk_lld_busy(q);
1708 }
1709 EXPORT_SYMBOL_GPL(dm_underlying_device_busy);
1710
1711 static int dm_lld_busy(struct request_queue *q)
1712 {
1713         int r;
1714         struct mapped_device *md = q->queuedata;
1715         struct dm_table *map = dm_get_live_table(md);
1716
1717         if (!map || test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags))
1718                 r = 1;
1719         else
1720                 r = dm_table_any_busy_target(map);
1721
1722         dm_table_put(map);
1723
1724         return r;
1725 }
1726
1727 static int dm_any_congested(void *congested_data, int bdi_bits)
1728 {
1729         int r = bdi_bits;
1730         struct mapped_device *md = congested_data;
1731         struct dm_table *map;
1732
1733         if (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
1734                 map = dm_get_live_table(md);
1735                 if (map) {
1736                         /*
1737                          * Request-based dm cares about only own queue for
1738                          * the query about congestion status of request_queue
1739                          */
1740                         if (dm_request_based(md))
1741                                 r = md->queue->backing_dev_info.state &
1742                                     bdi_bits;
1743                         else
1744                                 r = dm_table_any_congested(map, bdi_bits);
1745
1746                         dm_table_put(map);
1747                 }
1748         }
1749
1750         return r;
1751 }
1752
1753 /*-----------------------------------------------------------------
1754  * An IDR is used to keep track of allocated minor numbers.
1755  *---------------------------------------------------------------*/
1756 static void free_minor(int minor)
1757 {
1758         spin_lock(&_minor_lock);
1759         idr_remove(&_minor_idr, minor);
1760         spin_unlock(&_minor_lock);
1761 }
1762
1763 /*
1764  * See if the device with a specific minor # is free.
1765  */
1766 static int specific_minor(int minor)
1767 {
1768         int r;
1769
1770         if (minor >= (1 << MINORBITS))
1771                 return -EINVAL;
1772
1773         idr_preload(GFP_KERNEL);
1774         spin_lock(&_minor_lock);
1775
1776         r = idr_alloc(&_minor_idr, MINOR_ALLOCED, minor, minor + 1, GFP_NOWAIT);
1777
1778         spin_unlock(&_minor_lock);
1779         idr_preload_end();
1780         if (r < 0)
1781                 return r == -ENOSPC ? -EBUSY : r;
1782         return 0;
1783 }
1784
1785 static int next_free_minor(int *minor)
1786 {
1787         int r;
1788
1789         idr_preload(GFP_KERNEL);
1790         spin_lock(&_minor_lock);
1791
1792         r = idr_alloc(&_minor_idr, MINOR_ALLOCED, 0, 1 << MINORBITS, GFP_NOWAIT);
1793
1794         spin_unlock(&_minor_lock);
1795         idr_preload_end();
1796         if (r < 0)
1797                 return r;
1798         *minor = r;
1799         return 0;
1800 }
1801
1802 static const struct block_device_operations dm_blk_dops;
1803
1804 static void dm_wq_work(struct work_struct *work);
1805
1806 static void dm_init_md_queue(struct mapped_device *md)
1807 {
1808         /*
1809          * Request-based dm devices cannot be stacked on top of bio-based dm
1810          * devices.  The type of this dm device has not been decided yet.
1811          * The type is decided at the first table loading time.
1812          * To prevent problematic device stacking, clear the queue flag
1813          * for request stacking support until then.
1814          *
1815          * This queue is new, so no concurrency on the queue_flags.
1816          */
1817         queue_flag_clear_unlocked(QUEUE_FLAG_STACKABLE, md->queue);
1818
1819         md->queue->queuedata = md;
1820         md->queue->backing_dev_info.congested_fn = dm_any_congested;
1821         md->queue->backing_dev_info.congested_data = md;
1822         blk_queue_make_request(md->queue, dm_request);
1823         blk_queue_bounce_limit(md->queue, BLK_BOUNCE_ANY);
1824         blk_queue_merge_bvec(md->queue, dm_merge_bvec);
1825 }
1826
1827 /*
1828  * Allocate and initialise a blank device with a given minor.
1829  */
1830 static struct mapped_device *alloc_dev(int minor)
1831 {
1832         int r;
1833         struct mapped_device *md = kzalloc(sizeof(*md), GFP_KERNEL);
1834         void *old_md;
1835
1836         if (!md) {
1837                 DMWARN("unable to allocate device, out of memory.");
1838                 return NULL;
1839         }
1840
1841         if (!try_module_get(THIS_MODULE))
1842                 goto bad_module_get;
1843
1844         /* get a minor number for the dev */
1845         if (minor == DM_ANY_MINOR)
1846                 r = next_free_minor(&minor);
1847         else
1848                 r = specific_minor(minor);
1849         if (r < 0)
1850                 goto bad_minor;
1851
1852         md->type = DM_TYPE_NONE;
1853         init_rwsem(&md->io_lock);
1854         mutex_init(&md->suspend_lock);
1855         mutex_init(&md->type_lock);
1856         spin_lock_init(&md->deferred_lock);
1857         rwlock_init(&md->map_lock);
1858         atomic_set(&md->holders, 1);
1859         atomic_set(&md->open_count, 0);
1860         atomic_set(&md->event_nr, 0);
1861         atomic_set(&md->uevent_seq, 0);
1862         INIT_LIST_HEAD(&md->uevent_list);
1863         spin_lock_init(&md->uevent_lock);
1864
1865         md->queue = blk_alloc_queue(GFP_KERNEL);
1866         if (!md->queue)
1867                 goto bad_queue;
1868
1869         dm_init_md_queue(md);
1870
1871         md->disk = alloc_disk(1);
1872         if (!md->disk)
1873                 goto bad_disk;
1874
1875         atomic_set(&md->pending[0], 0);
1876         atomic_set(&md->pending[1], 0);
1877         init_waitqueue_head(&md->wait);
1878         INIT_WORK(&md->work, dm_wq_work);
1879         init_waitqueue_head(&md->eventq);
1880
1881         md->disk->major = _major;
1882         md->disk->first_minor = minor;
1883         md->disk->fops = &dm_blk_dops;
1884         md->disk->queue = md->queue;
1885         md->disk->private_data = md;
1886         sprintf(md->disk->disk_name, "dm-%d", minor);
1887         add_disk(md->disk);
1888         format_dev_t(md->name, MKDEV(_major, minor));
1889
1890         md->wq = alloc_workqueue("kdmflush",
1891                                  WQ_NON_REENTRANT | WQ_MEM_RECLAIM, 0);
1892         if (!md->wq)
1893                 goto bad_thread;
1894
1895         md->bdev = bdget_disk(md->disk, 0);
1896         if (!md->bdev)
1897                 goto bad_bdev;
1898
1899         bio_init(&md->flush_bio);
1900         md->flush_bio.bi_bdev = md->bdev;
1901         md->flush_bio.bi_rw = WRITE_FLUSH;
1902
1903         /* Populate the mapping, nobody knows we exist yet */
1904         spin_lock(&_minor_lock);
1905         old_md = idr_replace(&_minor_idr, md, minor);
1906         spin_unlock(&_minor_lock);
1907
1908         BUG_ON(old_md != MINOR_ALLOCED);
1909
1910         return md;
1911
1912 bad_bdev:
1913         destroy_workqueue(md->wq);
1914 bad_thread:
1915         del_gendisk(md->disk);
1916         put_disk(md->disk);
1917 bad_disk:
1918         blk_cleanup_queue(md->queue);
1919 bad_queue:
1920         free_minor(minor);
1921 bad_minor:
1922         module_put(THIS_MODULE);
1923 bad_module_get:
1924         kfree(md);
1925         return NULL;
1926 }
1927
1928 static void unlock_fs(struct mapped_device *md);
1929
1930 static void free_dev(struct mapped_device *md)
1931 {
1932         int minor = MINOR(disk_devt(md->disk));
1933
1934         unlock_fs(md);
1935         bdput(md->bdev);
1936         destroy_workqueue(md->wq);
1937         if (md->tio_pool)
1938                 mempool_destroy(md->tio_pool);
1939         if (md->io_pool)
1940                 mempool_destroy(md->io_pool);
1941         if (md->bs)
1942                 bioset_free(md->bs);
1943         blk_integrity_unregister(md->disk);
1944         del_gendisk(md->disk);
1945         free_minor(minor);
1946
1947         spin_lock(&_minor_lock);
1948         md->disk->private_data = NULL;
1949         spin_unlock(&_minor_lock);
1950
1951         put_disk(md->disk);
1952         blk_cleanup_queue(md->queue);
1953         module_put(THIS_MODULE);
1954         kfree(md);
1955 }
1956
1957 static void __bind_mempools(struct mapped_device *md, struct dm_table *t)
1958 {
1959         struct dm_md_mempools *p = dm_table_get_md_mempools(t);
1960
1961         if (md->io_pool && md->bs) {
1962                 /* The md already has necessary mempools. */
1963                 if (dm_table_get_type(t) == DM_TYPE_BIO_BASED) {
1964                         /*
1965                          * Reload bioset because front_pad may have changed
1966                          * because a different table was loaded.
1967                          */
1968                         bioset_free(md->bs);
1969                         md->bs = p->bs;
1970                         p->bs = NULL;
1971                 } else if (dm_table_get_type(t) == DM_TYPE_REQUEST_BASED) {
1972                         BUG_ON(!md->tio_pool);
1973                         /*
1974                          * There's no need to reload with request-based dm
1975                          * because the size of front_pad doesn't change.
1976                          * Note for future: If you are to reload bioset,
1977                          * prep-ed requests in the queue may refer
1978                          * to bio from the old bioset, so you must walk
1979                          * through the queue to unprep.
1980                          */
1981                 }
1982                 goto out;
1983         }
1984
1985         BUG_ON(!p || md->io_pool || md->tio_pool || md->bs);
1986
1987         md->io_pool = p->io_pool;
1988         p->io_pool = NULL;
1989         md->tio_pool = p->tio_pool;
1990         p->tio_pool = NULL;
1991         md->bs = p->bs;
1992         p->bs = NULL;
1993
1994 out:
1995         /* mempool bind completed, now no need any mempools in the table */
1996         dm_table_free_md_mempools(t);
1997 }
1998
1999 /*
2000  * Bind a table to the device.
2001  */
2002 static void event_callback(void *context)
2003 {
2004         unsigned long flags;
2005         LIST_HEAD(uevents);
2006         struct mapped_device *md = (struct mapped_device *) context;
2007
2008         spin_lock_irqsave(&md->uevent_lock, flags);
2009         list_splice_init(&md->uevent_list, &uevents);
2010         spin_unlock_irqrestore(&md->uevent_lock, flags);
2011
2012         dm_send_uevents(&uevents, &disk_to_dev(md->disk)->kobj);
2013
2014         atomic_inc(&md->event_nr);
2015         wake_up(&md->eventq);
2016 }
2017
2018 /*
2019  * Protected by md->suspend_lock obtained by dm_swap_table().
2020  */
2021 static void __set_size(struct mapped_device *md, sector_t size)
2022 {
2023         set_capacity(md->disk, size);
2024
2025         i_size_write(md->bdev->bd_inode, (loff_t)size << SECTOR_SHIFT);
2026 }
2027
2028 /*
2029  * Return 1 if the queue has a compulsory merge_bvec_fn function.
2030  *
2031  * If this function returns 0, then the device is either a non-dm
2032  * device without a merge_bvec_fn, or it is a dm device that is
2033  * able to split any bios it receives that are too big.
2034  */
2035 int dm_queue_merge_is_compulsory(struct request_queue *q)
2036 {
2037         struct mapped_device *dev_md;
2038
2039         if (!q->merge_bvec_fn)
2040                 return 0;
2041
2042         if (q->make_request_fn == dm_request) {
2043                 dev_md = q->queuedata;
2044                 if (test_bit(DMF_MERGE_IS_OPTIONAL, &dev_md->flags))
2045                         return 0;
2046         }
2047
2048         return 1;
2049 }
2050
2051 static int dm_device_merge_is_compulsory(struct dm_target *ti,
2052                                          struct dm_dev *dev, sector_t start,
2053                                          sector_t len, void *data)
2054 {
2055         struct block_device *bdev = dev->bdev;
2056         struct request_queue *q = bdev_get_queue(bdev);
2057
2058         return dm_queue_merge_is_compulsory(q);
2059 }
2060
2061 /*
2062  * Return 1 if it is acceptable to ignore merge_bvec_fn based
2063  * on the properties of the underlying devices.
2064  */
2065 static int dm_table_merge_is_optional(struct dm_table *table)
2066 {
2067         unsigned i = 0;
2068         struct dm_target *ti;
2069
2070         while (i < dm_table_get_num_targets(table)) {
2071                 ti = dm_table_get_target(table, i++);
2072
2073                 if (ti->type->iterate_devices &&
2074                     ti->type->iterate_devices(ti, dm_device_merge_is_compulsory, NULL))
2075                         return 0;
2076         }
2077
2078         return 1;
2079 }
2080
2081 /*
2082  * Returns old map, which caller must destroy.
2083  */
2084 static struct dm_table *__bind(struct mapped_device *md, struct dm_table *t,
2085                                struct queue_limits *limits)
2086 {
2087         struct dm_table *old_map;
2088         struct request_queue *q = md->queue;
2089         sector_t size;
2090         unsigned long flags;
2091         int merge_is_optional;
2092
2093         size = dm_table_get_size(t);
2094
2095         /*
2096          * Wipe any geometry if the size of the table changed.
2097          */
2098         if (size != get_capacity(md->disk))
2099                 memset(&md->geometry, 0, sizeof(md->geometry));
2100
2101         __set_size(md, size);
2102
2103         dm_table_event_callback(t, event_callback, md);
2104
2105         /*
2106          * The queue hasn't been stopped yet, if the old table type wasn't
2107          * for request-based during suspension.  So stop it to prevent
2108          * I/O mapping before resume.
2109          * This must be done before setting the queue restrictions,
2110          * because request-based dm may be run just after the setting.
2111          */
2112         if (dm_table_request_based(t) && !blk_queue_stopped(q))
2113                 stop_queue(q);
2114
2115         __bind_mempools(md, t);
2116
2117         merge_is_optional = dm_table_merge_is_optional(t);
2118
2119         write_lock_irqsave(&md->map_lock, flags);
2120         old_map = md->map;
2121         md->map = t;
2122         md->immutable_target_type = dm_table_get_immutable_target_type(t);
2123
2124         dm_table_set_restrictions(t, q, limits);
2125         if (merge_is_optional)
2126                 set_bit(DMF_MERGE_IS_OPTIONAL, &md->flags);
2127         else
2128                 clear_bit(DMF_MERGE_IS_OPTIONAL, &md->flags);
2129         write_unlock_irqrestore(&md->map_lock, flags);
2130
2131         return old_map;
2132 }
2133
2134 /*
2135  * Returns unbound table for the caller to free.
2136  */
2137 static struct dm_table *__unbind(struct mapped_device *md)
2138 {
2139         struct dm_table *map = md->map;
2140         unsigned long flags;
2141
2142         if (!map)
2143                 return NULL;
2144
2145         dm_table_event_callback(map, NULL, NULL);
2146         write_lock_irqsave(&md->map_lock, flags);
2147         md->map = NULL;
2148         write_unlock_irqrestore(&md->map_lock, flags);
2149
2150         return map;
2151 }
2152
2153 /*
2154  * Constructor for a new device.
2155  */
2156 int dm_create(int minor, struct mapped_device **result)
2157 {
2158         struct mapped_device *md;
2159
2160         md = alloc_dev(minor);
2161         if (!md)
2162                 return -ENXIO;
2163
2164         dm_sysfs_init(md);
2165
2166         *result = md;
2167         return 0;
2168 }
2169
2170 /*
2171  * Functions to manage md->type.
2172  * All are required to hold md->type_lock.
2173  */
2174 void dm_lock_md_type(struct mapped_device *md)
2175 {
2176         mutex_lock(&md->type_lock);
2177 }
2178
2179 void dm_unlock_md_type(struct mapped_device *md)
2180 {
2181         mutex_unlock(&md->type_lock);
2182 }
2183
2184 void dm_set_md_type(struct mapped_device *md, unsigned type)
2185 {
2186         md->type = type;
2187 }
2188
2189 unsigned dm_get_md_type(struct mapped_device *md)
2190 {
2191         return md->type;
2192 }
2193
2194 struct target_type *dm_get_immutable_target_type(struct mapped_device *md)
2195 {
2196         return md->immutable_target_type;
2197 }
2198
2199 /*
2200  * Fully initialize a request-based queue (->elevator, ->request_fn, etc).
2201  */
2202 static int dm_init_request_based_queue(struct mapped_device *md)
2203 {
2204         struct request_queue *q = NULL;
2205
2206         if (md->queue->elevator)
2207                 return 1;
2208
2209         /* Fully initialize the queue */
2210         q = blk_init_allocated_queue(md->queue, dm_request_fn, NULL);
2211         if (!q)
2212                 return 0;
2213
2214         md->queue = q;
2215         dm_init_md_queue(md);
2216         blk_queue_softirq_done(md->queue, dm_softirq_done);
2217         blk_queue_prep_rq(md->queue, dm_prep_fn);
2218         blk_queue_lld_busy(md->queue, dm_lld_busy);
2219
2220         elv_register_queue(md->queue);
2221
2222         return 1;
2223 }
2224
2225 /*
2226  * Setup the DM device's queue based on md's type
2227  */
2228 int dm_setup_md_queue(struct mapped_device *md)
2229 {
2230         if ((dm_get_md_type(md) == DM_TYPE_REQUEST_BASED) &&
2231             !dm_init_request_based_queue(md)) {
2232                 DMWARN("Cannot initialize queue for request-based mapped device");
2233                 return -EINVAL;
2234         }
2235
2236         return 0;
2237 }
2238
2239 static struct mapped_device *dm_find_md(dev_t dev)
2240 {
2241         struct mapped_device *md;
2242         unsigned minor = MINOR(dev);
2243
2244         if (MAJOR(dev) != _major || minor >= (1 << MINORBITS))
2245                 return NULL;
2246
2247         spin_lock(&_minor_lock);
2248
2249         md = idr_find(&_minor_idr, minor);
2250         if (md && (md == MINOR_ALLOCED ||
2251                    (MINOR(disk_devt(dm_disk(md))) != minor) ||
2252                    dm_deleting_md(md) ||
2253                    test_bit(DMF_FREEING, &md->flags))) {
2254                 md = NULL;
2255                 goto out;
2256         }
2257
2258 out:
2259         spin_unlock(&_minor_lock);
2260
2261         return md;
2262 }
2263
2264 struct mapped_device *dm_get_md(dev_t dev)
2265 {
2266         struct mapped_device *md = dm_find_md(dev);
2267
2268         if (md)
2269                 dm_get(md);
2270
2271         return md;
2272 }
2273 EXPORT_SYMBOL_GPL(dm_get_md);
2274
2275 void *dm_get_mdptr(struct mapped_device *md)
2276 {
2277         return md->interface_ptr;
2278 }
2279
2280 void dm_set_mdptr(struct mapped_device *md, void *ptr)
2281 {
2282         md->interface_ptr = ptr;
2283 }
2284
2285 void dm_get(struct mapped_device *md)
2286 {
2287         atomic_inc(&md->holders);
2288         BUG_ON(test_bit(DMF_FREEING, &md->flags));
2289 }
2290
2291 const char *dm_device_name(struct mapped_device *md)
2292 {
2293         return md->name;
2294 }
2295 EXPORT_SYMBOL_GPL(dm_device_name);
2296
2297 static void __dm_destroy(struct mapped_device *md, bool wait)
2298 {
2299         struct dm_table *map;
2300
2301         might_sleep();
2302
2303         spin_lock(&_minor_lock);
2304         map = dm_get_live_table(md);
2305         idr_replace(&_minor_idr, MINOR_ALLOCED, MINOR(disk_devt(dm_disk(md))));
2306         set_bit(DMF_FREEING, &md->flags);
2307         spin_unlock(&_minor_lock);
2308
2309         if (!dm_suspended_md(md)) {
2310                 dm_table_presuspend_targets(map);
2311                 dm_table_postsuspend_targets(map);
2312         }
2313
2314         /*
2315          * Rare, but there may be I/O requests still going to complete,
2316          * for example.  Wait for all references to disappear.
2317          * No one should increment the reference count of the mapped_device,
2318          * after the mapped_device state becomes DMF_FREEING.
2319          */
2320         if (wait)
2321                 while (atomic_read(&md->holders))
2322                         msleep(1);
2323         else if (atomic_read(&md->holders))
2324                 DMWARN("%s: Forcibly removing mapped_device still in use! (%d users)",
2325                        dm_device_name(md), atomic_read(&md->holders));
2326
2327         dm_sysfs_exit(md);
2328         dm_table_put(map);
2329         dm_table_destroy(__unbind(md));
2330         free_dev(md);
2331 }
2332
2333 void dm_destroy(struct mapped_device *md)
2334 {
2335         __dm_destroy(md, true);
2336 }
2337
2338 void dm_destroy_immediate(struct mapped_device *md)
2339 {
2340         __dm_destroy(md, false);
2341 }
2342
2343 void dm_put(struct mapped_device *md)
2344 {
2345         atomic_dec(&md->holders);
2346 }
2347 EXPORT_SYMBOL_GPL(dm_put);
2348
2349 static int dm_wait_for_completion(struct mapped_device *md, int interruptible)
2350 {
2351         int r = 0;
2352         DECLARE_WAITQUEUE(wait, current);
2353
2354         add_wait_queue(&md->wait, &wait);
2355
2356         while (1) {
2357                 set_current_state(interruptible);
2358
2359                 if (!md_in_flight(md))
2360                         break;
2361
2362                 if (interruptible == TASK_INTERRUPTIBLE &&
2363                     signal_pending(current)) {
2364                         r = -EINTR;
2365                         break;
2366                 }
2367
2368                 io_schedule();
2369         }
2370         set_current_state(TASK_RUNNING);
2371
2372         remove_wait_queue(&md->wait, &wait);
2373
2374         return r;
2375 }
2376
2377 /*
2378  * Process the deferred bios
2379  */
2380 static void dm_wq_work(struct work_struct *work)
2381 {
2382         struct mapped_device *md = container_of(work, struct mapped_device,
2383                                                 work);
2384         struct bio *c;
2385
2386         down_read(&md->io_lock);
2387
2388         while (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
2389                 spin_lock_irq(&md->deferred_lock);
2390                 c = bio_list_pop(&md->deferred);
2391                 spin_unlock_irq(&md->deferred_lock);
2392
2393                 if (!c)
2394                         break;
2395
2396                 up_read(&md->io_lock);
2397
2398                 if (dm_request_based(md))
2399                         generic_make_request(c);
2400                 else
2401                         __split_and_process_bio(md, c);
2402
2403                 down_read(&md->io_lock);
2404         }
2405
2406         up_read(&md->io_lock);
2407 }
2408
2409 static void dm_queue_flush(struct mapped_device *md)
2410 {
2411         clear_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
2412         smp_mb__after_clear_bit();
2413         queue_work(md->wq, &md->work);
2414 }
2415
2416 /*
2417  * Swap in a new table, returning the old one for the caller to destroy.
2418  */
2419 struct dm_table *dm_swap_table(struct mapped_device *md, struct dm_table *table)
2420 {
2421         struct dm_table *live_map, *map = ERR_PTR(-EINVAL);
2422         struct queue_limits limits;
2423         int r;
2424
2425         mutex_lock(&md->suspend_lock);
2426
2427         /* device must be suspended */
2428         if (!dm_suspended_md(md))
2429                 goto out;
2430
2431         /*
2432          * If the new table has no data devices, retain the existing limits.
2433          * This helps multipath with queue_if_no_path if all paths disappear,
2434          * then new I/O is queued based on these limits, and then some paths
2435          * reappear.
2436          */
2437         if (dm_table_has_no_data_devices(table)) {
2438                 live_map = dm_get_live_table(md);
2439                 if (live_map)
2440                         limits = md->queue->limits;
2441                 dm_table_put(live_map);
2442         }
2443
2444         r = dm_calculate_queue_limits(table, &limits);
2445         if (r) {
2446                 map = ERR_PTR(r);
2447                 goto out;
2448         }
2449
2450         map = __bind(md, table, &limits);
2451
2452 out:
2453         mutex_unlock(&md->suspend_lock);
2454         return map;
2455 }
2456
2457 /*
2458  * Functions to lock and unlock any filesystem running on the
2459  * device.
2460  */
2461 static int lock_fs(struct mapped_device *md)
2462 {
2463         int r;
2464
2465         WARN_ON(md->frozen_sb);
2466
2467         md->frozen_sb = freeze_bdev(md->bdev);
2468         if (IS_ERR(md->frozen_sb)) {
2469                 r = PTR_ERR(md->frozen_sb);
2470                 md->frozen_sb = NULL;
2471                 return r;
2472         }
2473
2474         set_bit(DMF_FROZEN, &md->flags);
2475
2476         return 0;
2477 }
2478
2479 static void unlock_fs(struct mapped_device *md)
2480 {
2481         if (!test_bit(DMF_FROZEN, &md->flags))
2482                 return;
2483
2484         thaw_bdev(md->bdev, md->frozen_sb);
2485         md->frozen_sb = NULL;
2486         clear_bit(DMF_FROZEN, &md->flags);
2487 }
2488
2489 /*
2490  * We need to be able to change a mapping table under a mounted
2491  * filesystem.  For example we might want to move some data in
2492  * the background.  Before the table can be swapped with
2493  * dm_bind_table, dm_suspend must be called to flush any in
2494  * flight bios and ensure that any further io gets deferred.
2495  */
2496 /*
2497  * Suspend mechanism in request-based dm.
2498  *
2499  * 1. Flush all I/Os by lock_fs() if needed.
2500  * 2. Stop dispatching any I/O by stopping the request_queue.
2501  * 3. Wait for all in-flight I/Os to be completed or requeued.
2502  *
2503  * To abort suspend, start the request_queue.
2504  */
2505 int dm_suspend(struct mapped_device *md, unsigned suspend_flags)
2506 {
2507         struct dm_table *map = NULL;
2508         int r = 0;
2509         int do_lockfs = suspend_flags & DM_SUSPEND_LOCKFS_FLAG ? 1 : 0;
2510         int noflush = suspend_flags & DM_SUSPEND_NOFLUSH_FLAG ? 1 : 0;
2511
2512         mutex_lock(&md->suspend_lock);
2513
2514         if (dm_suspended_md(md)) {
2515                 r = -EINVAL;
2516                 goto out_unlock;
2517         }
2518
2519         map = dm_get_live_table(md);
2520
2521         /*
2522          * DMF_NOFLUSH_SUSPENDING must be set before presuspend.
2523          * This flag is cleared before dm_suspend returns.
2524          */
2525         if (noflush)
2526                 set_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
2527
2528         /* This does not get reverted if there's an error later. */
2529         dm_table_presuspend_targets(map);
2530
2531         /*
2532          * Flush I/O to the device.
2533          * Any I/O submitted after lock_fs() may not be flushed.
2534          * noflush takes precedence over do_lockfs.
2535          * (lock_fs() flushes I/Os and waits for them to complete.)
2536          */
2537         if (!noflush && do_lockfs) {
2538                 r = lock_fs(md);
2539                 if (r)
2540                         goto out;
2541         }
2542
2543         /*
2544          * Here we must make sure that no processes are submitting requests
2545          * to target drivers i.e. no one may be executing
2546          * __split_and_process_bio. This is called from dm_request and
2547          * dm_wq_work.
2548          *
2549          * To get all processes out of __split_and_process_bio in dm_request,
2550          * we take the write lock. To prevent any process from reentering
2551          * __split_and_process_bio from dm_request and quiesce the thread
2552          * (dm_wq_work), we set BMF_BLOCK_IO_FOR_SUSPEND and call
2553          * flush_workqueue(md->wq).
2554          */
2555         down_write(&md->io_lock);
2556         set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
2557         up_write(&md->io_lock);
2558
2559         /*
2560          * Stop md->queue before flushing md->wq in case request-based
2561          * dm defers requests to md->wq from md->queue.
2562          */
2563         if (dm_request_based(md))
2564                 stop_queue(md->queue);
2565
2566         flush_workqueue(md->wq);
2567
2568         /*
2569          * At this point no more requests are entering target request routines.
2570          * We call dm_wait_for_completion to wait for all existing requests
2571          * to finish.
2572          */
2573         r = dm_wait_for_completion(md, TASK_INTERRUPTIBLE);
2574
2575         down_write(&md->io_lock);
2576         if (noflush)
2577                 clear_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
2578         up_write(&md->io_lock);
2579
2580         /* were we interrupted ? */
2581         if (r < 0) {
2582                 dm_queue_flush(md);
2583
2584                 if (dm_request_based(md))
2585                         start_queue(md->queue);
2586
2587                 unlock_fs(md);
2588                 goto out; /* pushback list is already flushed, so skip flush */
2589         }
2590
2591         /*
2592          * If dm_wait_for_completion returned 0, the device is completely
2593          * quiescent now. There is no request-processing activity. All new
2594          * requests are being added to md->deferred list.
2595          */
2596
2597         set_bit(DMF_SUSPENDED, &md->flags);
2598
2599         dm_table_postsuspend_targets(map);
2600
2601 out:
2602         dm_table_put(map);
2603
2604 out_unlock:
2605         mutex_unlock(&md->suspend_lock);
2606         return r;
2607 }
2608
2609 int dm_resume(struct mapped_device *md)
2610 {
2611         int r = -EINVAL;
2612         struct dm_table *map = NULL;
2613
2614         mutex_lock(&md->suspend_lock);
2615         if (!dm_suspended_md(md))
2616                 goto out;
2617
2618         map = dm_get_live_table(md);
2619         if (!map || !dm_table_get_size(map))
2620                 goto out;
2621
2622         r = dm_table_resume_targets(map);
2623         if (r)
2624                 goto out;
2625
2626         dm_queue_flush(md);
2627
2628         /*
2629          * Flushing deferred I/Os must be done after targets are resumed
2630          * so that mapping of targets can work correctly.
2631          * Request-based dm is queueing the deferred I/Os in its request_queue.
2632          */
2633         if (dm_request_based(md))
2634                 start_queue(md->queue);
2635
2636         unlock_fs(md);
2637
2638         clear_bit(DMF_SUSPENDED, &md->flags);
2639
2640         r = 0;
2641 out:
2642         dm_table_put(map);
2643         mutex_unlock(&md->suspend_lock);
2644
2645         return r;
2646 }
2647
2648 /*-----------------------------------------------------------------
2649  * Event notification.
2650  *---------------------------------------------------------------*/
2651 int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
2652                        unsigned cookie)
2653 {
2654         char udev_cookie[DM_COOKIE_LENGTH];
2655         char *envp[] = { udev_cookie, NULL };
2656
2657         if (!cookie)
2658                 return kobject_uevent(&disk_to_dev(md->disk)->kobj, action);
2659         else {
2660                 snprintf(udev_cookie, DM_COOKIE_LENGTH, "%s=%u",
2661                          DM_COOKIE_ENV_VAR_NAME, cookie);
2662                 return kobject_uevent_env(&disk_to_dev(md->disk)->kobj,
2663                                           action, envp);
2664         }
2665 }
2666
2667 uint32_t dm_next_uevent_seq(struct mapped_device *md)
2668 {
2669         return atomic_add_return(1, &md->uevent_seq);
2670 }
2671
2672 uint32_t dm_get_event_nr(struct mapped_device *md)
2673 {
2674         return atomic_read(&md->event_nr);
2675 }
2676
2677 int dm_wait_event(struct mapped_device *md, int event_nr)
2678 {
2679         return wait_event_interruptible(md->eventq,
2680                         (event_nr != atomic_read(&md->event_nr)));
2681 }
2682
2683 void dm_uevent_add(struct mapped_device *md, struct list_head *elist)
2684 {
2685         unsigned long flags;
2686
2687         spin_lock_irqsave(&md->uevent_lock, flags);
2688         list_add(elist, &md->uevent_list);
2689         spin_unlock_irqrestore(&md->uevent_lock, flags);
2690 }
2691
2692 /*
2693  * The gendisk is only valid as long as you have a reference
2694  * count on 'md'.
2695  */
2696 struct gendisk *dm_disk(struct mapped_device *md)
2697 {
2698         return md->disk;
2699 }
2700
2701 struct kobject *dm_kobject(struct mapped_device *md)
2702 {
2703         return &md->kobj;
2704 }
2705
2706 /*
2707  * struct mapped_device should not be exported outside of dm.c
2708  * so use this check to verify that kobj is part of md structure
2709  */
2710 struct mapped_device *dm_get_from_kobject(struct kobject *kobj)
2711 {
2712         struct mapped_device *md;
2713
2714         md = container_of(kobj, struct mapped_device, kobj);
2715         if (&md->kobj != kobj)
2716                 return NULL;
2717
2718         if (test_bit(DMF_FREEING, &md->flags) ||
2719             dm_deleting_md(md))
2720                 return NULL;
2721
2722         dm_get(md);
2723         return md;
2724 }
2725
2726 int dm_suspended_md(struct mapped_device *md)
2727 {
2728         return test_bit(DMF_SUSPENDED, &md->flags);
2729 }
2730
2731 int dm_suspended(struct dm_target *ti)
2732 {
2733         return dm_suspended_md(dm_table_get_md(ti->table));
2734 }
2735 EXPORT_SYMBOL_GPL(dm_suspended);
2736
2737 int dm_noflush_suspending(struct dm_target *ti)
2738 {
2739         return __noflush_suspending(dm_table_get_md(ti->table));
2740 }
2741 EXPORT_SYMBOL_GPL(dm_noflush_suspending);
2742
2743 struct dm_md_mempools *dm_alloc_md_mempools(unsigned type, unsigned integrity, unsigned per_bio_data_size)
2744 {
2745         struct dm_md_mempools *pools = kmalloc(sizeof(*pools), GFP_KERNEL);
2746         unsigned int pool_size = (type == DM_TYPE_BIO_BASED) ? 16 : MIN_IOS;
2747
2748         if (!pools)
2749                 return NULL;
2750
2751         per_bio_data_size = roundup(per_bio_data_size, __alignof__(struct dm_target_io));
2752
2753         pools->io_pool = (type == DM_TYPE_BIO_BASED) ?
2754                          mempool_create_slab_pool(MIN_IOS, _io_cache) :
2755                          mempool_create_slab_pool(MIN_IOS, _rq_bio_info_cache);
2756         if (!pools->io_pool)
2757                 goto free_pools_and_out;
2758
2759         pools->tio_pool = NULL;
2760         if (type == DM_TYPE_REQUEST_BASED) {
2761                 pools->tio_pool = mempool_create_slab_pool(MIN_IOS, _rq_tio_cache);
2762                 if (!pools->tio_pool)
2763                         goto free_io_pool_and_out;
2764         }
2765
2766         pools->bs = (type == DM_TYPE_BIO_BASED) ?
2767                 bioset_create(pool_size,
2768                               per_bio_data_size + offsetof(struct dm_target_io, clone)) :
2769                 bioset_create(pool_size,
2770                               offsetof(struct dm_rq_clone_bio_info, clone));
2771         if (!pools->bs)
2772                 goto free_tio_pool_and_out;
2773
2774         if (integrity && bioset_integrity_create(pools->bs, pool_size))
2775                 goto free_bioset_and_out;
2776
2777         return pools;
2778
2779 free_bioset_and_out:
2780         bioset_free(pools->bs);
2781
2782 free_tio_pool_and_out:
2783         if (pools->tio_pool)
2784                 mempool_destroy(pools->tio_pool);
2785
2786 free_io_pool_and_out:
2787         mempool_destroy(pools->io_pool);
2788
2789 free_pools_and_out:
2790         kfree(pools);
2791
2792         return NULL;
2793 }
2794
2795 void dm_free_md_mempools(struct dm_md_mempools *pools)
2796 {
2797         if (!pools)
2798                 return;
2799
2800         if (pools->io_pool)
2801                 mempool_destroy(pools->io_pool);
2802
2803         if (pools->tio_pool)
2804                 mempool_destroy(pools->tio_pool);
2805
2806         if (pools->bs)
2807                 bioset_free(pools->bs);
2808
2809         kfree(pools);
2810 }
2811
2812 static const struct block_device_operations dm_blk_dops = {
2813         .open = dm_blk_open,
2814         .release = dm_blk_close,
2815         .ioctl = dm_blk_ioctl,
2816         .getgeo = dm_blk_getgeo,
2817         .owner = THIS_MODULE
2818 };
2819
2820 EXPORT_SYMBOL(dm_get_mapinfo);
2821
2822 /*
2823  * module hooks
2824  */
2825 module_init(dm_init);
2826 module_exit(dm_exit);
2827
2828 module_param(major, uint, 0);
2829 MODULE_PARM_DESC(major, "The major number of the device mapper");
2830 MODULE_DESCRIPTION(DM_NAME " driver");
2831 MODULE_AUTHOR("Joe Thornber <dm-devel@redhat.com>");
2832 MODULE_LICENSE("GPL");