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