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