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