2 * Copyright (C) 2001, 2002 Sistina Software (UK) Limited.
3 * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved.
5 * This file is released under the GPL.
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/smp_lock.h>
19 #include <linux/mempool.h>
20 #include <linux/slab.h>
21 #include <linux/idr.h>
22 #include <linux/hdreg.h>
23 #include <linux/delay.h>
25 #include <trace/events/block.h>
27 #define DM_MSG_PREFIX "core"
30 * Cookies are numeric values sent with CHANGE and REMOVE
31 * uevents while resuming, removing or renaming the device.
33 #define DM_COOKIE_ENV_VAR_NAME "DM_COOKIE"
34 #define DM_COOKIE_LENGTH 24
36 static const char *_name = DM_NAME;
38 static unsigned int major = 0;
39 static unsigned int _major = 0;
41 static DEFINE_SPINLOCK(_minor_lock);
44 * One of these is allocated per bio.
47 struct mapped_device *md;
51 unsigned long start_time;
52 spinlock_t endio_lock;
57 * One of these is allocated per target within a bio. Hopefully
58 * this will be simplified out one day.
67 * For request-based dm.
68 * One of these is allocated per request.
70 struct dm_rq_target_io {
71 struct mapped_device *md;
73 struct request *orig, clone;
79 * For request-based dm.
80 * One of these is allocated per bio.
82 struct dm_rq_clone_bio_info {
84 struct dm_rq_target_io *tio;
87 union map_info *dm_get_mapinfo(struct bio *bio)
89 if (bio && bio->bi_private)
90 return &((struct dm_target_io *)bio->bi_private)->info;
94 union map_info *dm_get_rq_mapinfo(struct request *rq)
96 if (rq && rq->end_io_data)
97 return &((struct dm_rq_target_io *)rq->end_io_data)->info;
100 EXPORT_SYMBOL_GPL(dm_get_rq_mapinfo);
102 #define MINOR_ALLOCED ((void *)-1)
105 * Bits for the md->flags field.
107 #define DMF_BLOCK_IO_FOR_SUSPEND 0
108 #define DMF_SUSPENDED 1
110 #define DMF_FREEING 3
111 #define DMF_DELETING 4
112 #define DMF_NOFLUSH_SUSPENDING 5
113 #define DMF_QUEUE_IO_TO_THREAD 6
116 * Work processed by per-device workqueue.
118 struct mapped_device {
119 struct rw_semaphore io_lock;
120 struct mutex suspend_lock;
127 struct request_queue *queue;
129 /* Protect type against concurrent access. */
130 struct mutex type_lock;
132 struct gendisk *disk;
138 * A list of ios that arrived while we were suspended.
141 wait_queue_head_t wait;
142 struct work_struct work;
143 struct bio_list deferred;
144 spinlock_t deferred_lock;
147 * An error from the barrier request currently being processed.
152 * Protect barrier_error from concurrent endio processing
153 * in request-based dm.
155 spinlock_t barrier_error_lock;
158 * Processing queue (flush/barriers)
160 struct workqueue_struct *wq;
161 struct work_struct barrier_work;
163 /* A pointer to the currently processing pre/post flush request */
164 struct request *flush_request;
167 * The current mapping.
169 struct dm_table *map;
172 * io objects are allocated from here.
183 wait_queue_head_t eventq;
185 struct list_head uevent_list;
186 spinlock_t uevent_lock; /* Protect access to uevent_list */
189 * freeze/thaw support require holding onto a super block
191 struct super_block *frozen_sb;
192 struct block_device *bdev;
194 /* forced geometry settings */
195 struct hd_geometry geometry;
197 /* For saving the address of __make_request for request based dm */
198 make_request_fn *saved_make_request_fn;
203 /* zero-length barrier that will be cloned and submitted to targets */
204 struct bio barrier_bio;
208 * For mempools pre-allocation at the table loading time.
210 struct dm_md_mempools {
217 static struct kmem_cache *_io_cache;
218 static struct kmem_cache *_tio_cache;
219 static struct kmem_cache *_rq_tio_cache;
220 static struct kmem_cache *_rq_bio_info_cache;
222 static int __init local_init(void)
226 /* allocate a slab for the dm_ios */
227 _io_cache = KMEM_CACHE(dm_io, 0);
231 /* allocate a slab for the target ios */
232 _tio_cache = KMEM_CACHE(dm_target_io, 0);
234 goto out_free_io_cache;
236 _rq_tio_cache = KMEM_CACHE(dm_rq_target_io, 0);
238 goto out_free_tio_cache;
240 _rq_bio_info_cache = KMEM_CACHE(dm_rq_clone_bio_info, 0);
241 if (!_rq_bio_info_cache)
242 goto out_free_rq_tio_cache;
244 r = dm_uevent_init();
246 goto out_free_rq_bio_info_cache;
249 r = register_blkdev(_major, _name);
251 goto out_uevent_exit;
260 out_free_rq_bio_info_cache:
261 kmem_cache_destroy(_rq_bio_info_cache);
262 out_free_rq_tio_cache:
263 kmem_cache_destroy(_rq_tio_cache);
265 kmem_cache_destroy(_tio_cache);
267 kmem_cache_destroy(_io_cache);
272 static void local_exit(void)
274 kmem_cache_destroy(_rq_bio_info_cache);
275 kmem_cache_destroy(_rq_tio_cache);
276 kmem_cache_destroy(_tio_cache);
277 kmem_cache_destroy(_io_cache);
278 unregister_blkdev(_major, _name);
283 DMINFO("cleaned up");
286 static int (*_inits[])(void) __initdata = {
296 static void (*_exits[])(void) = {
306 static int __init dm_init(void)
308 const int count = ARRAY_SIZE(_inits);
312 for (i = 0; i < count; i++) {
327 static void __exit dm_exit(void)
329 int i = ARRAY_SIZE(_exits);
336 * Block device functions
338 int dm_deleting_md(struct mapped_device *md)
340 return test_bit(DMF_DELETING, &md->flags);
343 static int dm_blk_open(struct block_device *bdev, fmode_t mode)
345 struct mapped_device *md;
348 spin_lock(&_minor_lock);
350 md = bdev->bd_disk->private_data;
354 if (test_bit(DMF_FREEING, &md->flags) ||
355 dm_deleting_md(md)) {
361 atomic_inc(&md->open_count);
364 spin_unlock(&_minor_lock);
367 return md ? 0 : -ENXIO;
370 static int dm_blk_close(struct gendisk *disk, fmode_t mode)
372 struct mapped_device *md = disk->private_data;
375 atomic_dec(&md->open_count);
382 int dm_open_count(struct mapped_device *md)
384 return atomic_read(&md->open_count);
388 * Guarantees nothing is using the device before it's deleted.
390 int dm_lock_for_deletion(struct mapped_device *md)
394 spin_lock(&_minor_lock);
396 if (dm_open_count(md))
399 set_bit(DMF_DELETING, &md->flags);
401 spin_unlock(&_minor_lock);
406 static int dm_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
408 struct mapped_device *md = bdev->bd_disk->private_data;
410 return dm_get_geometry(md, geo);
413 static int dm_blk_ioctl(struct block_device *bdev, fmode_t mode,
414 unsigned int cmd, unsigned long arg)
416 struct mapped_device *md = bdev->bd_disk->private_data;
417 struct dm_table *map = dm_get_live_table(md);
418 struct dm_target *tgt;
421 if (!map || !dm_table_get_size(map))
424 /* We only support devices that have a single target */
425 if (dm_table_get_num_targets(map) != 1)
428 tgt = dm_table_get_target(map, 0);
430 if (dm_suspended_md(md)) {
435 if (tgt->type->ioctl)
436 r = tgt->type->ioctl(tgt, cmd, arg);
444 static struct dm_io *alloc_io(struct mapped_device *md)
446 return mempool_alloc(md->io_pool, GFP_NOIO);
449 static void free_io(struct mapped_device *md, struct dm_io *io)
451 mempool_free(io, md->io_pool);
454 static void free_tio(struct mapped_device *md, struct dm_target_io *tio)
456 mempool_free(tio, md->tio_pool);
459 static struct dm_rq_target_io *alloc_rq_tio(struct mapped_device *md,
462 return mempool_alloc(md->tio_pool, gfp_mask);
465 static void free_rq_tio(struct dm_rq_target_io *tio)
467 mempool_free(tio, tio->md->tio_pool);
470 static struct dm_rq_clone_bio_info *alloc_bio_info(struct mapped_device *md)
472 return mempool_alloc(md->io_pool, GFP_ATOMIC);
475 static void free_bio_info(struct dm_rq_clone_bio_info *info)
477 mempool_free(info, info->tio->md->io_pool);
480 static int md_in_flight(struct mapped_device *md)
482 return atomic_read(&md->pending[READ]) +
483 atomic_read(&md->pending[WRITE]);
486 static void start_io_acct(struct dm_io *io)
488 struct mapped_device *md = io->md;
490 int rw = bio_data_dir(io->bio);
492 io->start_time = jiffies;
494 cpu = part_stat_lock();
495 part_round_stats(cpu, &dm_disk(md)->part0);
497 dm_disk(md)->part0.in_flight[rw] = atomic_inc_return(&md->pending[rw]);
500 static void end_io_acct(struct dm_io *io)
502 struct mapped_device *md = io->md;
503 struct bio *bio = io->bio;
504 unsigned long duration = jiffies - io->start_time;
506 int rw = bio_data_dir(bio);
508 cpu = part_stat_lock();
509 part_round_stats(cpu, &dm_disk(md)->part0);
510 part_stat_add(cpu, &dm_disk(md)->part0, ticks[rw], duration);
514 * After this is decremented the bio must not be touched if it is
517 dm_disk(md)->part0.in_flight[rw] = pending =
518 atomic_dec_return(&md->pending[rw]);
519 pending += atomic_read(&md->pending[rw^0x1]);
521 /* nudge anyone waiting on suspend queue */
527 * Add the bio to the list of deferred io.
529 static void queue_io(struct mapped_device *md, struct bio *bio)
531 down_write(&md->io_lock);
533 spin_lock_irq(&md->deferred_lock);
534 bio_list_add(&md->deferred, bio);
535 spin_unlock_irq(&md->deferred_lock);
537 if (!test_and_set_bit(DMF_QUEUE_IO_TO_THREAD, &md->flags))
538 queue_work(md->wq, &md->work);
540 up_write(&md->io_lock);
544 * Everyone (including functions in this file), should use this
545 * function to access the md->map field, and make sure they call
546 * dm_table_put() when finished.
548 struct dm_table *dm_get_live_table(struct mapped_device *md)
553 read_lock_irqsave(&md->map_lock, flags);
557 read_unlock_irqrestore(&md->map_lock, flags);
563 * Get the geometry associated with a dm device
565 int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo)
573 * Set the geometry of a device.
575 int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo)
577 sector_t sz = (sector_t)geo->cylinders * geo->heads * geo->sectors;
579 if (geo->start > sz) {
580 DMWARN("Start sector is beyond the geometry limits.");
589 /*-----------------------------------------------------------------
591 * A more elegant soln is in the works that uses the queue
592 * merge fn, unfortunately there are a couple of changes to
593 * the block layer that I want to make for this. So in the
594 * interests of getting something for people to use I give
595 * you this clearly demarcated crap.
596 *---------------------------------------------------------------*/
598 static int __noflush_suspending(struct mapped_device *md)
600 return test_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
604 * Decrements the number of outstanding ios that a bio has been
605 * cloned into, completing the original io if necc.
607 static void dec_pending(struct dm_io *io, int error)
612 struct mapped_device *md = io->md;
614 /* Push-back supersedes any I/O errors */
615 if (unlikely(error)) {
616 spin_lock_irqsave(&io->endio_lock, flags);
617 if (!(io->error > 0 && __noflush_suspending(md)))
619 spin_unlock_irqrestore(&io->endio_lock, flags);
622 if (atomic_dec_and_test(&io->io_count)) {
623 if (io->error == DM_ENDIO_REQUEUE) {
625 * Target requested pushing back the I/O.
627 spin_lock_irqsave(&md->deferred_lock, flags);
628 if (__noflush_suspending(md)) {
629 if (!(io->bio->bi_rw & REQ_HARDBARRIER))
630 bio_list_add_head(&md->deferred,
633 /* noflush suspend was interrupted. */
635 spin_unlock_irqrestore(&md->deferred_lock, flags);
638 io_error = io->error;
641 if (bio->bi_rw & REQ_HARDBARRIER) {
643 * There can be just one barrier request so we use
644 * a per-device variable for error reporting.
645 * Note that you can't touch the bio after end_io_acct
647 * We ignore -EOPNOTSUPP for empty flush reported by
648 * underlying devices. We assume that if the device
649 * doesn't support empty barriers, it doesn't need
650 * cache flushing commands.
652 if (!md->barrier_error &&
653 !(bio_empty_barrier(bio) && io_error == -EOPNOTSUPP))
654 md->barrier_error = io_error;
661 if (io_error != DM_ENDIO_REQUEUE) {
662 trace_block_bio_complete(md->queue, bio);
664 bio_endio(bio, io_error);
670 static void clone_endio(struct bio *bio, int error)
673 struct dm_target_io *tio = bio->bi_private;
674 struct dm_io *io = tio->io;
675 struct mapped_device *md = tio->io->md;
676 dm_endio_fn endio = tio->ti->type->end_io;
678 if (!bio_flagged(bio, BIO_UPTODATE) && !error)
682 r = endio(tio->ti, bio, error, &tio->info);
683 if (r < 0 || r == DM_ENDIO_REQUEUE)
685 * error and requeue request are handled
689 else if (r == DM_ENDIO_INCOMPLETE)
690 /* The target will handle the io */
693 DMWARN("unimplemented target endio return value: %d", r);
699 * Store md for cleanup instead of tio which is about to get freed.
701 bio->bi_private = md->bs;
705 dec_pending(io, error);
709 * Partial completion handling for request-based dm
711 static void end_clone_bio(struct bio *clone, int error)
713 struct dm_rq_clone_bio_info *info = clone->bi_private;
714 struct dm_rq_target_io *tio = info->tio;
715 struct bio *bio = info->orig;
716 unsigned int nr_bytes = info->orig->bi_size;
722 * An error has already been detected on the request.
723 * Once error occurred, just let clone->end_io() handle
729 * Don't notice the error to the upper layer yet.
730 * The error handling decision is made by the target driver,
731 * when the request is completed.
738 * I/O for the bio successfully completed.
739 * Notice the data completion to the upper layer.
743 * bios are processed from the head of the list.
744 * So the completing bio should always be rq->bio.
745 * If it's not, something wrong is happening.
747 if (tio->orig->bio != bio)
748 DMERR("bio completion is going in the middle of the request");
751 * Update the original request.
752 * Do not use blk_end_request() here, because it may complete
753 * the original request before the clone, and break the ordering.
755 blk_update_request(tio->orig, 0, nr_bytes);
758 static void store_barrier_error(struct mapped_device *md, int error)
762 spin_lock_irqsave(&md->barrier_error_lock, flags);
764 * Basically, the first error is taken, but:
765 * -EOPNOTSUPP supersedes any I/O error.
766 * Requeue request supersedes any I/O error but -EOPNOTSUPP.
768 if (!md->barrier_error || error == -EOPNOTSUPP ||
769 (md->barrier_error != -EOPNOTSUPP &&
770 error == DM_ENDIO_REQUEUE))
771 md->barrier_error = error;
772 spin_unlock_irqrestore(&md->barrier_error_lock, flags);
776 * Don't touch any member of the md after calling this function because
777 * the md may be freed in dm_put() at the end of this function.
778 * Or do dm_get() before calling this function and dm_put() later.
780 static void rq_completed(struct mapped_device *md, int rw, int run_queue)
782 atomic_dec(&md->pending[rw]);
784 /* nudge anyone waiting on suspend queue */
785 if (!md_in_flight(md))
789 blk_run_queue(md->queue);
792 * dm_put() must be at the end of this function. See the comment above
797 static void free_rq_clone(struct request *clone)
799 struct dm_rq_target_io *tio = clone->end_io_data;
801 blk_rq_unprep_clone(clone);
806 * Complete the clone and the original request.
807 * Must be called without queue lock.
809 static void dm_end_request(struct request *clone, int error)
811 int rw = rq_data_dir(clone);
813 bool is_barrier = clone->cmd_flags & REQ_HARDBARRIER;
814 struct dm_rq_target_io *tio = clone->end_io_data;
815 struct mapped_device *md = tio->md;
816 struct request *rq = tio->orig;
818 if (rq->cmd_type == REQ_TYPE_BLOCK_PC && !is_barrier) {
819 rq->errors = clone->errors;
820 rq->resid_len = clone->resid_len;
824 * We are using the sense buffer of the original
826 * So setting the length of the sense data is enough.
828 rq->sense_len = clone->sense_len;
831 free_rq_clone(clone);
833 if (unlikely(is_barrier)) {
835 store_barrier_error(md, error);
838 blk_end_request_all(rq, error);
840 rq_completed(md, rw, run_queue);
843 static void dm_unprep_request(struct request *rq)
845 struct request *clone = rq->special;
848 rq->cmd_flags &= ~REQ_DONTPREP;
850 free_rq_clone(clone);
854 * Requeue the original request of a clone.
856 void dm_requeue_unmapped_request(struct request *clone)
858 int rw = rq_data_dir(clone);
859 struct dm_rq_target_io *tio = clone->end_io_data;
860 struct mapped_device *md = tio->md;
861 struct request *rq = tio->orig;
862 struct request_queue *q = rq->q;
865 if (unlikely(clone->cmd_flags & REQ_HARDBARRIER)) {
867 * Barrier clones share an original request.
868 * Leave it to dm_end_request(), which handles this special
871 dm_end_request(clone, DM_ENDIO_REQUEUE);
875 dm_unprep_request(rq);
877 spin_lock_irqsave(q->queue_lock, flags);
878 if (elv_queue_empty(q))
880 blk_requeue_request(q, rq);
881 spin_unlock_irqrestore(q->queue_lock, flags);
883 rq_completed(md, rw, 0);
885 EXPORT_SYMBOL_GPL(dm_requeue_unmapped_request);
887 static void __stop_queue(struct request_queue *q)
892 static void stop_queue(struct request_queue *q)
896 spin_lock_irqsave(q->queue_lock, flags);
898 spin_unlock_irqrestore(q->queue_lock, flags);
901 static void __start_queue(struct request_queue *q)
903 if (blk_queue_stopped(q))
907 static void start_queue(struct request_queue *q)
911 spin_lock_irqsave(q->queue_lock, flags);
913 spin_unlock_irqrestore(q->queue_lock, flags);
916 static void dm_done(struct request *clone, int error, bool mapped)
919 struct dm_rq_target_io *tio = clone->end_io_data;
920 dm_request_endio_fn rq_end_io = tio->ti->type->rq_end_io;
922 if (mapped && rq_end_io)
923 r = rq_end_io(tio->ti, clone, error, &tio->info);
926 /* The target wants to complete the I/O */
927 dm_end_request(clone, r);
928 else if (r == DM_ENDIO_INCOMPLETE)
929 /* The target will handle the I/O */
931 else if (r == DM_ENDIO_REQUEUE)
932 /* The target wants to requeue the I/O */
933 dm_requeue_unmapped_request(clone);
935 DMWARN("unimplemented target endio return value: %d", r);
941 * Request completion handler for request-based dm
943 static void dm_softirq_done(struct request *rq)
946 struct request *clone = rq->completion_data;
947 struct dm_rq_target_io *tio = clone->end_io_data;
949 if (rq->cmd_flags & REQ_FAILED)
952 dm_done(clone, tio->error, mapped);
956 * Complete the clone and the original request with the error status
957 * through softirq context.
959 static void dm_complete_request(struct request *clone, int error)
961 struct dm_rq_target_io *tio = clone->end_io_data;
962 struct request *rq = tio->orig;
964 if (unlikely(clone->cmd_flags & REQ_HARDBARRIER)) {
966 * Barrier clones share an original request. So can't use
967 * softirq_done with the original.
968 * Pass the clone to dm_done() directly in this special case.
969 * It is safe (even if clone->q->queue_lock is held here)
970 * because there is no I/O dispatching during the completion
973 dm_done(clone, error, true);
978 rq->completion_data = clone;
979 blk_complete_request(rq);
983 * Complete the not-mapped clone and the original request with the error status
984 * through softirq context.
985 * Target's rq_end_io() function isn't called.
986 * This may be used when the target's map_rq() function fails.
988 void dm_kill_unmapped_request(struct request *clone, int error)
990 struct dm_rq_target_io *tio = clone->end_io_data;
991 struct request *rq = tio->orig;
993 if (unlikely(clone->cmd_flags & REQ_HARDBARRIER)) {
995 * Barrier clones share an original request.
996 * Leave it to dm_end_request(), which handles this special
1000 dm_end_request(clone, error);
1004 rq->cmd_flags |= REQ_FAILED;
1005 dm_complete_request(clone, error);
1007 EXPORT_SYMBOL_GPL(dm_kill_unmapped_request);
1010 * Called with the queue lock held
1012 static void end_clone_request(struct request *clone, int error)
1015 * For just cleaning up the information of the queue in which
1016 * the clone was dispatched.
1017 * The clone is *NOT* freed actually here because it is alloced from
1018 * dm own mempool and REQ_ALLOCED isn't set in clone->cmd_flags.
1020 __blk_put_request(clone->q, clone);
1023 * Actual request completion is done in a softirq context which doesn't
1024 * hold the queue lock. Otherwise, deadlock could occur because:
1025 * - another request may be submitted by the upper level driver
1026 * of the stacking during the completion
1027 * - the submission which requires queue lock may be done
1028 * against this queue
1030 dm_complete_request(clone, error);
1033 static sector_t max_io_len(struct mapped_device *md,
1034 sector_t sector, struct dm_target *ti)
1036 sector_t offset = sector - ti->begin;
1037 sector_t len = ti->len - offset;
1040 * Does the target need to split even further ?
1044 boundary = ((offset + ti->split_io) & ~(ti->split_io - 1))
1053 static void __map_bio(struct dm_target *ti, struct bio *clone,
1054 struct dm_target_io *tio)
1058 struct mapped_device *md;
1060 clone->bi_end_io = clone_endio;
1061 clone->bi_private = tio;
1064 * Map the clone. If r == 0 we don't need to do
1065 * anything, the target has assumed ownership of
1068 atomic_inc(&tio->io->io_count);
1069 sector = clone->bi_sector;
1070 r = ti->type->map(ti, clone, &tio->info);
1071 if (r == DM_MAPIO_REMAPPED) {
1072 /* the bio has been remapped so dispatch it */
1074 trace_block_remap(bdev_get_queue(clone->bi_bdev), clone,
1075 tio->io->bio->bi_bdev->bd_dev, sector);
1077 generic_make_request(clone);
1078 } else if (r < 0 || r == DM_MAPIO_REQUEUE) {
1079 /* error the io and bail out, or requeue it if needed */
1081 dec_pending(tio->io, r);
1083 * Store bio_set for cleanup.
1085 clone->bi_private = md->bs;
1089 DMWARN("unimplemented target map return value: %d", r);
1095 struct mapped_device *md;
1096 struct dm_table *map;
1100 sector_t sector_count;
1104 static void dm_bio_destructor(struct bio *bio)
1106 struct bio_set *bs = bio->bi_private;
1112 * Creates a little bio that is just does part of a bvec.
1114 static struct bio *split_bvec(struct bio *bio, sector_t sector,
1115 unsigned short idx, unsigned int offset,
1116 unsigned int len, struct bio_set *bs)
1119 struct bio_vec *bv = bio->bi_io_vec + idx;
1121 clone = bio_alloc_bioset(GFP_NOIO, 1, bs);
1122 clone->bi_destructor = dm_bio_destructor;
1123 *clone->bi_io_vec = *bv;
1125 clone->bi_sector = sector;
1126 clone->bi_bdev = bio->bi_bdev;
1127 clone->bi_rw = bio->bi_rw & ~REQ_HARDBARRIER;
1129 clone->bi_size = to_bytes(len);
1130 clone->bi_io_vec->bv_offset = offset;
1131 clone->bi_io_vec->bv_len = clone->bi_size;
1132 clone->bi_flags |= 1 << BIO_CLONED;
1134 if (bio_integrity(bio)) {
1135 bio_integrity_clone(clone, bio, GFP_NOIO, bs);
1136 bio_integrity_trim(clone,
1137 bio_sector_offset(bio, idx, offset), len);
1144 * Creates a bio that consists of range of complete bvecs.
1146 static struct bio *clone_bio(struct bio *bio, sector_t sector,
1147 unsigned short idx, unsigned short bv_count,
1148 unsigned int len, struct bio_set *bs)
1152 clone = bio_alloc_bioset(GFP_NOIO, bio->bi_max_vecs, bs);
1153 __bio_clone(clone, bio);
1154 clone->bi_rw &= ~REQ_HARDBARRIER;
1155 clone->bi_destructor = dm_bio_destructor;
1156 clone->bi_sector = sector;
1157 clone->bi_idx = idx;
1158 clone->bi_vcnt = idx + bv_count;
1159 clone->bi_size = to_bytes(len);
1160 clone->bi_flags &= ~(1 << BIO_SEG_VALID);
1162 if (bio_integrity(bio)) {
1163 bio_integrity_clone(clone, bio, GFP_NOIO, bs);
1165 if (idx != bio->bi_idx || clone->bi_size < bio->bi_size)
1166 bio_integrity_trim(clone,
1167 bio_sector_offset(bio, idx, 0), len);
1173 static struct dm_target_io *alloc_tio(struct clone_info *ci,
1174 struct dm_target *ti)
1176 struct dm_target_io *tio = mempool_alloc(ci->md->tio_pool, GFP_NOIO);
1180 memset(&tio->info, 0, sizeof(tio->info));
1185 static void __flush_target(struct clone_info *ci, struct dm_target *ti,
1188 struct dm_target_io *tio = alloc_tio(ci, ti);
1191 tio->info.flush_request = flush_nr;
1193 clone = bio_alloc_bioset(GFP_NOIO, 0, ci->md->bs);
1194 __bio_clone(clone, ci->bio);
1195 clone->bi_destructor = dm_bio_destructor;
1197 __map_bio(ti, clone, tio);
1200 static int __clone_and_map_empty_barrier(struct clone_info *ci)
1202 unsigned target_nr = 0, flush_nr;
1203 struct dm_target *ti;
1205 while ((ti = dm_table_get_target(ci->map, target_nr++)))
1206 for (flush_nr = 0; flush_nr < ti->num_flush_requests;
1208 __flush_target(ci, ti, flush_nr);
1210 ci->sector_count = 0;
1215 static int __clone_and_map(struct clone_info *ci)
1217 struct bio *clone, *bio = ci->bio;
1218 struct dm_target *ti;
1219 sector_t len = 0, max;
1220 struct dm_target_io *tio;
1222 if (unlikely(bio_empty_barrier(bio)))
1223 return __clone_and_map_empty_barrier(ci);
1225 ti = dm_table_find_target(ci->map, ci->sector);
1226 if (!dm_target_is_valid(ti))
1229 max = max_io_len(ci->md, ci->sector, ti);
1232 * Allocate a target io object.
1234 tio = alloc_tio(ci, ti);
1236 if (ci->sector_count <= max) {
1238 * Optimise for the simple case where we can do all of
1239 * the remaining io with a single clone.
1241 clone = clone_bio(bio, ci->sector, ci->idx,
1242 bio->bi_vcnt - ci->idx, ci->sector_count,
1244 __map_bio(ti, clone, tio);
1245 ci->sector_count = 0;
1247 } else if (to_sector(bio->bi_io_vec[ci->idx].bv_len) <= max) {
1249 * There are some bvecs that don't span targets.
1250 * Do as many of these as possible.
1253 sector_t remaining = max;
1256 for (i = ci->idx; remaining && (i < bio->bi_vcnt); i++) {
1257 bv_len = to_sector(bio->bi_io_vec[i].bv_len);
1259 if (bv_len > remaining)
1262 remaining -= bv_len;
1266 clone = clone_bio(bio, ci->sector, ci->idx, i - ci->idx, len,
1268 __map_bio(ti, clone, tio);
1271 ci->sector_count -= len;
1276 * Handle a bvec that must be split between two or more targets.
1278 struct bio_vec *bv = bio->bi_io_vec + ci->idx;
1279 sector_t remaining = to_sector(bv->bv_len);
1280 unsigned int offset = 0;
1284 ti = dm_table_find_target(ci->map, ci->sector);
1285 if (!dm_target_is_valid(ti))
1288 max = max_io_len(ci->md, ci->sector, ti);
1290 tio = alloc_tio(ci, ti);
1293 len = min(remaining, max);
1295 clone = split_bvec(bio, ci->sector, ci->idx,
1296 bv->bv_offset + offset, len,
1299 __map_bio(ti, clone, tio);
1302 ci->sector_count -= len;
1303 offset += to_bytes(len);
1304 } while (remaining -= len);
1313 * Split the bio into several clones and submit it to targets.
1315 static void __split_and_process_bio(struct mapped_device *md, struct bio *bio)
1317 struct clone_info ci;
1320 ci.map = dm_get_live_table(md);
1321 if (unlikely(!ci.map)) {
1322 if (!(bio->bi_rw & REQ_HARDBARRIER))
1325 if (!md->barrier_error)
1326 md->barrier_error = -EIO;
1332 ci.io = alloc_io(md);
1334 atomic_set(&ci.io->io_count, 1);
1337 spin_lock_init(&ci.io->endio_lock);
1338 ci.sector = bio->bi_sector;
1339 ci.sector_count = bio_sectors(bio);
1340 if (unlikely(bio_empty_barrier(bio)))
1341 ci.sector_count = 1;
1342 ci.idx = bio->bi_idx;
1344 start_io_acct(ci.io);
1345 while (ci.sector_count && !error)
1346 error = __clone_and_map(&ci);
1348 /* drop the extra reference count */
1349 dec_pending(ci.io, error);
1350 dm_table_put(ci.map);
1352 /*-----------------------------------------------------------------
1354 *---------------------------------------------------------------*/
1356 static int dm_merge_bvec(struct request_queue *q,
1357 struct bvec_merge_data *bvm,
1358 struct bio_vec *biovec)
1360 struct mapped_device *md = q->queuedata;
1361 struct dm_table *map = dm_get_live_table(md);
1362 struct dm_target *ti;
1363 sector_t max_sectors;
1369 ti = dm_table_find_target(map, bvm->bi_sector);
1370 if (!dm_target_is_valid(ti))
1374 * Find maximum amount of I/O that won't need splitting
1376 max_sectors = min(max_io_len(md, bvm->bi_sector, ti),
1377 (sector_t) BIO_MAX_SECTORS);
1378 max_size = (max_sectors << SECTOR_SHIFT) - bvm->bi_size;
1383 * merge_bvec_fn() returns number of bytes
1384 * it can accept at this offset
1385 * max is precomputed maximal io size
1387 if (max_size && ti->type->merge)
1388 max_size = ti->type->merge(ti, bvm, biovec, max_size);
1390 * If the target doesn't support merge method and some of the devices
1391 * provided their merge_bvec method (we know this by looking at
1392 * queue_max_hw_sectors), then we can't allow bios with multiple vector
1393 * entries. So always set max_size to 0, and the code below allows
1396 else if (queue_max_hw_sectors(q) <= PAGE_SIZE >> 9)
1405 * Always allow an entire first page
1407 if (max_size <= biovec->bv_len && !(bvm->bi_size >> SECTOR_SHIFT))
1408 max_size = biovec->bv_len;
1414 * The request function that just remaps the bio built up by
1417 static int _dm_request(struct request_queue *q, struct bio *bio)
1419 int rw = bio_data_dir(bio);
1420 struct mapped_device *md = q->queuedata;
1423 down_read(&md->io_lock);
1425 cpu = part_stat_lock();
1426 part_stat_inc(cpu, &dm_disk(md)->part0, ios[rw]);
1427 part_stat_add(cpu, &dm_disk(md)->part0, sectors[rw], bio_sectors(bio));
1431 * If we're suspended or the thread is processing barriers
1432 * we have to queue this io for later.
1434 if (unlikely(test_bit(DMF_QUEUE_IO_TO_THREAD, &md->flags)) ||
1435 unlikely(bio->bi_rw & REQ_HARDBARRIER)) {
1436 up_read(&md->io_lock);
1438 if (unlikely(test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) &&
1439 bio_rw(bio) == READA) {
1449 __split_and_process_bio(md, bio);
1450 up_read(&md->io_lock);
1454 static int dm_make_request(struct request_queue *q, struct bio *bio)
1456 struct mapped_device *md = q->queuedata;
1458 return md->saved_make_request_fn(q, bio); /* call __make_request() */
1461 static int dm_request_based(struct mapped_device *md)
1463 return blk_queue_stackable(md->queue);
1466 static int dm_request(struct request_queue *q, struct bio *bio)
1468 struct mapped_device *md = q->queuedata;
1470 if (dm_request_based(md))
1471 return dm_make_request(q, bio);
1473 return _dm_request(q, bio);
1476 static bool dm_rq_is_flush_request(struct request *rq)
1478 if (rq->cmd_flags & REQ_FLUSH)
1484 void dm_dispatch_request(struct request *rq)
1488 if (blk_queue_io_stat(rq->q))
1489 rq->cmd_flags |= REQ_IO_STAT;
1491 rq->start_time = jiffies;
1492 r = blk_insert_cloned_request(rq->q, rq);
1494 dm_complete_request(rq, r);
1496 EXPORT_SYMBOL_GPL(dm_dispatch_request);
1498 static void dm_rq_bio_destructor(struct bio *bio)
1500 struct dm_rq_clone_bio_info *info = bio->bi_private;
1501 struct mapped_device *md = info->tio->md;
1503 free_bio_info(info);
1504 bio_free(bio, md->bs);
1507 static int dm_rq_bio_constructor(struct bio *bio, struct bio *bio_orig,
1510 struct dm_rq_target_io *tio = data;
1511 struct mapped_device *md = tio->md;
1512 struct dm_rq_clone_bio_info *info = alloc_bio_info(md);
1517 info->orig = bio_orig;
1519 bio->bi_end_io = end_clone_bio;
1520 bio->bi_private = info;
1521 bio->bi_destructor = dm_rq_bio_destructor;
1526 static int setup_clone(struct request *clone, struct request *rq,
1527 struct dm_rq_target_io *tio)
1531 if (dm_rq_is_flush_request(rq)) {
1532 blk_rq_init(NULL, clone);
1533 clone->cmd_type = REQ_TYPE_FS;
1534 clone->cmd_flags |= (REQ_HARDBARRIER | WRITE);
1536 r = blk_rq_prep_clone(clone, rq, tio->md->bs, GFP_ATOMIC,
1537 dm_rq_bio_constructor, tio);
1541 clone->cmd = rq->cmd;
1542 clone->cmd_len = rq->cmd_len;
1543 clone->sense = rq->sense;
1544 clone->buffer = rq->buffer;
1547 clone->end_io = end_clone_request;
1548 clone->end_io_data = tio;
1553 static struct request *clone_rq(struct request *rq, struct mapped_device *md,
1556 struct request *clone;
1557 struct dm_rq_target_io *tio;
1559 tio = alloc_rq_tio(md, gfp_mask);
1567 memset(&tio->info, 0, sizeof(tio->info));
1569 clone = &tio->clone;
1570 if (setup_clone(clone, rq, tio)) {
1580 * Called with the queue lock held.
1582 static int dm_prep_fn(struct request_queue *q, struct request *rq)
1584 struct mapped_device *md = q->queuedata;
1585 struct request *clone;
1587 if (unlikely(dm_rq_is_flush_request(rq)))
1590 if (unlikely(rq->special)) {
1591 DMWARN("Already has something in rq->special.");
1592 return BLKPREP_KILL;
1595 clone = clone_rq(rq, md, GFP_ATOMIC);
1597 return BLKPREP_DEFER;
1599 rq->special = clone;
1600 rq->cmd_flags |= REQ_DONTPREP;
1607 * 0 : the request has been processed (not requeued)
1608 * !0 : the request has been requeued
1610 static int map_request(struct dm_target *ti, struct request *clone,
1611 struct mapped_device *md)
1613 int r, requeued = 0;
1614 struct dm_rq_target_io *tio = clone->end_io_data;
1617 * Hold the md reference here for the in-flight I/O.
1618 * We can't rely on the reference count by device opener,
1619 * because the device may be closed during the request completion
1620 * when all bios are completed.
1621 * See the comment in rq_completed() too.
1626 r = ti->type->map_rq(ti, clone, &tio->info);
1628 case DM_MAPIO_SUBMITTED:
1629 /* The target has taken the I/O to submit by itself later */
1631 case DM_MAPIO_REMAPPED:
1632 /* The target has remapped the I/O so dispatch it */
1633 trace_block_rq_remap(clone->q, clone, disk_devt(dm_disk(md)),
1634 blk_rq_pos(tio->orig));
1635 dm_dispatch_request(clone);
1637 case DM_MAPIO_REQUEUE:
1638 /* The target wants to requeue the I/O */
1639 dm_requeue_unmapped_request(clone);
1644 DMWARN("unimplemented target map return value: %d", r);
1648 /* The target wants to complete the I/O */
1649 dm_kill_unmapped_request(clone, r);
1657 * q->request_fn for request-based dm.
1658 * Called with the queue lock held.
1660 static void dm_request_fn(struct request_queue *q)
1662 struct mapped_device *md = q->queuedata;
1663 struct dm_table *map = dm_get_live_table(md);
1664 struct dm_target *ti;
1665 struct request *rq, *clone;
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
1673 while (!blk_queue_plugged(q) && !blk_queue_stopped(q)) {
1674 rq = blk_peek_request(q);
1678 if (unlikely(dm_rq_is_flush_request(rq))) {
1679 BUG_ON(md->flush_request);
1680 md->flush_request = rq;
1681 blk_start_request(rq);
1682 queue_work(md->wq, &md->barrier_work);
1686 ti = dm_table_find_target(map, blk_rq_pos(rq));
1687 if (ti->type->busy && ti->type->busy(ti))
1690 blk_start_request(rq);
1691 clone = rq->special;
1692 atomic_inc(&md->pending[rq_data_dir(clone)]);
1694 spin_unlock(q->queue_lock);
1695 if (map_request(ti, clone, md))
1698 spin_lock_irq(q->queue_lock);
1704 spin_lock_irq(q->queue_lock);
1707 if (!elv_queue_empty(q))
1708 /* Some requests still remain, retry later */
1717 int dm_underlying_device_busy(struct request_queue *q)
1719 return blk_lld_busy(q);
1721 EXPORT_SYMBOL_GPL(dm_underlying_device_busy);
1723 static int dm_lld_busy(struct request_queue *q)
1726 struct mapped_device *md = q->queuedata;
1727 struct dm_table *map = dm_get_live_table(md);
1729 if (!map || test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags))
1732 r = dm_table_any_busy_target(map);
1739 static void dm_unplug_all(struct request_queue *q)
1741 struct mapped_device *md = q->queuedata;
1742 struct dm_table *map = dm_get_live_table(md);
1745 if (dm_request_based(md))
1746 generic_unplug_device(q);
1748 dm_table_unplug_all(map);
1753 static int dm_any_congested(void *congested_data, int bdi_bits)
1756 struct mapped_device *md = congested_data;
1757 struct dm_table *map;
1759 if (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
1760 map = dm_get_live_table(md);
1763 * Request-based dm cares about only own queue for
1764 * the query about congestion status of request_queue
1766 if (dm_request_based(md))
1767 r = md->queue->backing_dev_info.state &
1770 r = dm_table_any_congested(map, bdi_bits);
1779 /*-----------------------------------------------------------------
1780 * An IDR is used to keep track of allocated minor numbers.
1781 *---------------------------------------------------------------*/
1782 static DEFINE_IDR(_minor_idr);
1784 static void free_minor(int minor)
1786 spin_lock(&_minor_lock);
1787 idr_remove(&_minor_idr, minor);
1788 spin_unlock(&_minor_lock);
1792 * See if the device with a specific minor # is free.
1794 static int specific_minor(int minor)
1798 if (minor >= (1 << MINORBITS))
1801 r = idr_pre_get(&_minor_idr, GFP_KERNEL);
1805 spin_lock(&_minor_lock);
1807 if (idr_find(&_minor_idr, minor)) {
1812 r = idr_get_new_above(&_minor_idr, MINOR_ALLOCED, minor, &m);
1817 idr_remove(&_minor_idr, m);
1823 spin_unlock(&_minor_lock);
1827 static int next_free_minor(int *minor)
1831 r = idr_pre_get(&_minor_idr, GFP_KERNEL);
1835 spin_lock(&_minor_lock);
1837 r = idr_get_new(&_minor_idr, MINOR_ALLOCED, &m);
1841 if (m >= (1 << MINORBITS)) {
1842 idr_remove(&_minor_idr, m);
1850 spin_unlock(&_minor_lock);
1854 static const struct block_device_operations dm_blk_dops;
1856 static void dm_wq_work(struct work_struct *work);
1857 static void dm_rq_barrier_work(struct work_struct *work);
1860 * Allocate and initialise a blank device with a given minor.
1862 static struct mapped_device *alloc_dev(int minor)
1865 struct mapped_device *md = kzalloc(sizeof(*md), GFP_KERNEL);
1869 DMWARN("unable to allocate device, out of memory.");
1873 if (!try_module_get(THIS_MODULE))
1874 goto bad_module_get;
1876 /* get a minor number for the dev */
1877 if (minor == DM_ANY_MINOR)
1878 r = next_free_minor(&minor);
1880 r = specific_minor(minor);
1884 md->type = DM_TYPE_NONE;
1885 init_rwsem(&md->io_lock);
1886 mutex_init(&md->suspend_lock);
1887 mutex_init(&md->type_lock);
1888 spin_lock_init(&md->deferred_lock);
1889 spin_lock_init(&md->barrier_error_lock);
1890 rwlock_init(&md->map_lock);
1891 atomic_set(&md->holders, 1);
1892 atomic_set(&md->open_count, 0);
1893 atomic_set(&md->event_nr, 0);
1894 atomic_set(&md->uevent_seq, 0);
1895 INIT_LIST_HEAD(&md->uevent_list);
1896 spin_lock_init(&md->uevent_lock);
1898 md->queue = blk_init_queue(dm_request_fn, NULL);
1903 * Request-based dm devices cannot be stacked on top of bio-based dm
1904 * devices. The type of this dm device has not been decided yet,
1905 * although we initialized the queue using blk_init_queue().
1906 * The type is decided at the first table loading time.
1907 * To prevent problematic device stacking, clear the queue flag
1908 * for request stacking support until then.
1910 * This queue is new, so no concurrency on the queue_flags.
1912 queue_flag_clear_unlocked(QUEUE_FLAG_STACKABLE, md->queue);
1913 md->saved_make_request_fn = md->queue->make_request_fn;
1914 md->queue->queuedata = md;
1915 md->queue->backing_dev_info.congested_fn = dm_any_congested;
1916 md->queue->backing_dev_info.congested_data = md;
1917 blk_queue_make_request(md->queue, dm_request);
1918 blk_queue_bounce_limit(md->queue, BLK_BOUNCE_ANY);
1919 md->queue->unplug_fn = dm_unplug_all;
1920 blk_queue_merge_bvec(md->queue, dm_merge_bvec);
1921 blk_queue_softirq_done(md->queue, dm_softirq_done);
1922 blk_queue_prep_rq(md->queue, dm_prep_fn);
1923 blk_queue_lld_busy(md->queue, dm_lld_busy);
1924 blk_queue_ordered(md->queue, QUEUE_ORDERED_DRAIN_FLUSH);
1926 md->disk = alloc_disk(1);
1930 atomic_set(&md->pending[0], 0);
1931 atomic_set(&md->pending[1], 0);
1932 init_waitqueue_head(&md->wait);
1933 INIT_WORK(&md->work, dm_wq_work);
1934 INIT_WORK(&md->barrier_work, dm_rq_barrier_work);
1935 init_waitqueue_head(&md->eventq);
1937 md->disk->major = _major;
1938 md->disk->first_minor = minor;
1939 md->disk->fops = &dm_blk_dops;
1940 md->disk->queue = md->queue;
1941 md->disk->private_data = md;
1942 sprintf(md->disk->disk_name, "dm-%d", minor);
1944 format_dev_t(md->name, MKDEV(_major, minor));
1946 md->wq = create_singlethread_workqueue("kdmflush");
1950 md->bdev = bdget_disk(md->disk, 0);
1954 /* Populate the mapping, nobody knows we exist yet */
1955 spin_lock(&_minor_lock);
1956 old_md = idr_replace(&_minor_idr, md, minor);
1957 spin_unlock(&_minor_lock);
1959 BUG_ON(old_md != MINOR_ALLOCED);
1964 destroy_workqueue(md->wq);
1966 del_gendisk(md->disk);
1969 blk_cleanup_queue(md->queue);
1973 module_put(THIS_MODULE);
1979 static void unlock_fs(struct mapped_device *md);
1981 static void free_dev(struct mapped_device *md)
1983 int minor = MINOR(disk_devt(md->disk));
1987 destroy_workqueue(md->wq);
1989 mempool_destroy(md->tio_pool);
1991 mempool_destroy(md->io_pool);
1993 bioset_free(md->bs);
1994 blk_integrity_unregister(md->disk);
1995 del_gendisk(md->disk);
1998 spin_lock(&_minor_lock);
1999 md->disk->private_data = NULL;
2000 spin_unlock(&_minor_lock);
2003 blk_cleanup_queue(md->queue);
2004 module_put(THIS_MODULE);
2008 static void __bind_mempools(struct mapped_device *md, struct dm_table *t)
2010 struct dm_md_mempools *p;
2012 if (md->io_pool && md->tio_pool && md->bs)
2013 /* the md already has necessary mempools */
2016 p = dm_table_get_md_mempools(t);
2017 BUG_ON(!p || md->io_pool || md->tio_pool || md->bs);
2019 md->io_pool = p->io_pool;
2021 md->tio_pool = p->tio_pool;
2027 /* mempool bind completed, now no need any mempools in the table */
2028 dm_table_free_md_mempools(t);
2032 * Bind a table to the device.
2034 static void event_callback(void *context)
2036 unsigned long flags;
2038 struct mapped_device *md = (struct mapped_device *) context;
2040 spin_lock_irqsave(&md->uevent_lock, flags);
2041 list_splice_init(&md->uevent_list, &uevents);
2042 spin_unlock_irqrestore(&md->uevent_lock, flags);
2044 dm_send_uevents(&uevents, &disk_to_dev(md->disk)->kobj);
2046 atomic_inc(&md->event_nr);
2047 wake_up(&md->eventq);
2050 static void __set_size(struct mapped_device *md, sector_t size)
2052 set_capacity(md->disk, size);
2054 mutex_lock(&md->bdev->bd_inode->i_mutex);
2055 i_size_write(md->bdev->bd_inode, (loff_t)size << SECTOR_SHIFT);
2056 mutex_unlock(&md->bdev->bd_inode->i_mutex);
2060 * Returns old map, which caller must destroy.
2062 static struct dm_table *__bind(struct mapped_device *md, struct dm_table *t,
2063 struct queue_limits *limits)
2065 struct dm_table *old_map;
2066 struct request_queue *q = md->queue;
2068 unsigned long flags;
2070 size = dm_table_get_size(t);
2073 * Wipe any geometry if the size of the table changed.
2075 if (size != get_capacity(md->disk))
2076 memset(&md->geometry, 0, sizeof(md->geometry));
2078 __set_size(md, size);
2080 dm_table_event_callback(t, event_callback, md);
2083 * The queue hasn't been stopped yet, if the old table type wasn't
2084 * for request-based during suspension. So stop it to prevent
2085 * I/O mapping before resume.
2086 * This must be done before setting the queue restrictions,
2087 * because request-based dm may be run just after the setting.
2089 if (dm_table_request_based(t) && !blk_queue_stopped(q))
2092 __bind_mempools(md, t);
2094 write_lock_irqsave(&md->map_lock, flags);
2097 dm_table_set_restrictions(t, q, limits);
2098 write_unlock_irqrestore(&md->map_lock, flags);
2104 * Returns unbound table for the caller to free.
2106 static struct dm_table *__unbind(struct mapped_device *md)
2108 struct dm_table *map = md->map;
2109 unsigned long flags;
2114 dm_table_event_callback(map, NULL, NULL);
2115 write_lock_irqsave(&md->map_lock, flags);
2117 write_unlock_irqrestore(&md->map_lock, flags);
2123 * Constructor for a new device.
2125 int dm_create(int minor, struct mapped_device **result)
2127 struct mapped_device *md;
2129 md = alloc_dev(minor);
2140 * Functions to manage md->type.
2141 * All are required to hold md->type_lock.
2143 void dm_lock_md_type(struct mapped_device *md)
2145 mutex_lock(&md->type_lock);
2148 void dm_unlock_md_type(struct mapped_device *md)
2150 mutex_unlock(&md->type_lock);
2153 void dm_set_md_type(struct mapped_device *md, unsigned type)
2158 unsigned dm_get_md_type(struct mapped_device *md)
2163 static struct mapped_device *dm_find_md(dev_t dev)
2165 struct mapped_device *md;
2166 unsigned minor = MINOR(dev);
2168 if (MAJOR(dev) != _major || minor >= (1 << MINORBITS))
2171 spin_lock(&_minor_lock);
2173 md = idr_find(&_minor_idr, minor);
2174 if (md && (md == MINOR_ALLOCED ||
2175 (MINOR(disk_devt(dm_disk(md))) != minor) ||
2176 dm_deleting_md(md) ||
2177 test_bit(DMF_FREEING, &md->flags))) {
2183 spin_unlock(&_minor_lock);
2188 struct mapped_device *dm_get_md(dev_t dev)
2190 struct mapped_device *md = dm_find_md(dev);
2198 void *dm_get_mdptr(struct mapped_device *md)
2200 return md->interface_ptr;
2203 void dm_set_mdptr(struct mapped_device *md, void *ptr)
2205 md->interface_ptr = ptr;
2208 void dm_get(struct mapped_device *md)
2210 atomic_inc(&md->holders);
2211 BUG_ON(test_bit(DMF_FREEING, &md->flags));
2214 const char *dm_device_name(struct mapped_device *md)
2218 EXPORT_SYMBOL_GPL(dm_device_name);
2220 static void __dm_destroy(struct mapped_device *md, bool wait)
2222 struct dm_table *map;
2226 spin_lock(&_minor_lock);
2227 map = dm_get_live_table(md);
2228 idr_replace(&_minor_idr, MINOR_ALLOCED, MINOR(disk_devt(dm_disk(md))));
2229 set_bit(DMF_FREEING, &md->flags);
2230 spin_unlock(&_minor_lock);
2232 if (!dm_suspended_md(md)) {
2233 dm_table_presuspend_targets(map);
2234 dm_table_postsuspend_targets(map);
2238 * Rare, but there may be I/O requests still going to complete,
2239 * for example. Wait for all references to disappear.
2240 * No one should increment the reference count of the mapped_device,
2241 * after the mapped_device state becomes DMF_FREEING.
2244 while (atomic_read(&md->holders))
2246 else if (atomic_read(&md->holders))
2247 DMWARN("%s: Forcibly removing mapped_device still in use! (%d users)",
2248 dm_device_name(md), atomic_read(&md->holders));
2252 dm_table_destroy(__unbind(md));
2256 void dm_destroy(struct mapped_device *md)
2258 __dm_destroy(md, true);
2261 void dm_destroy_immediate(struct mapped_device *md)
2263 __dm_destroy(md, false);
2266 void dm_put(struct mapped_device *md)
2268 atomic_dec(&md->holders);
2270 EXPORT_SYMBOL_GPL(dm_put);
2272 static int dm_wait_for_completion(struct mapped_device *md, int interruptible)
2275 DECLARE_WAITQUEUE(wait, current);
2277 dm_unplug_all(md->queue);
2279 add_wait_queue(&md->wait, &wait);
2282 set_current_state(interruptible);
2285 if (!md_in_flight(md))
2288 if (interruptible == TASK_INTERRUPTIBLE &&
2289 signal_pending(current)) {
2296 set_current_state(TASK_RUNNING);
2298 remove_wait_queue(&md->wait, &wait);
2303 static void dm_flush(struct mapped_device *md)
2305 dm_wait_for_completion(md, TASK_UNINTERRUPTIBLE);
2307 bio_init(&md->barrier_bio);
2308 md->barrier_bio.bi_bdev = md->bdev;
2309 md->barrier_bio.bi_rw = WRITE_BARRIER;
2310 __split_and_process_bio(md, &md->barrier_bio);
2312 dm_wait_for_completion(md, TASK_UNINTERRUPTIBLE);
2315 static void process_barrier(struct mapped_device *md, struct bio *bio)
2317 md->barrier_error = 0;
2321 if (!bio_empty_barrier(bio)) {
2322 __split_and_process_bio(md, bio);
2324 * If the request isn't supported, don't waste time with
2327 if (md->barrier_error != -EOPNOTSUPP)
2331 if (md->barrier_error != DM_ENDIO_REQUEUE)
2332 bio_endio(bio, md->barrier_error);
2334 spin_lock_irq(&md->deferred_lock);
2335 bio_list_add_head(&md->deferred, bio);
2336 spin_unlock_irq(&md->deferred_lock);
2341 * Process the deferred bios
2343 static void dm_wq_work(struct work_struct *work)
2345 struct mapped_device *md = container_of(work, struct mapped_device,
2349 down_write(&md->io_lock);
2351 while (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
2352 spin_lock_irq(&md->deferred_lock);
2353 c = bio_list_pop(&md->deferred);
2354 spin_unlock_irq(&md->deferred_lock);
2357 clear_bit(DMF_QUEUE_IO_TO_THREAD, &md->flags);
2361 up_write(&md->io_lock);
2363 if (dm_request_based(md))
2364 generic_make_request(c);
2366 if (c->bi_rw & REQ_HARDBARRIER)
2367 process_barrier(md, c);
2369 __split_and_process_bio(md, c);
2372 down_write(&md->io_lock);
2375 up_write(&md->io_lock);
2378 static void dm_queue_flush(struct mapped_device *md)
2380 clear_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
2381 smp_mb__after_clear_bit();
2382 queue_work(md->wq, &md->work);
2385 static void dm_rq_set_flush_nr(struct request *clone, unsigned flush_nr)
2387 struct dm_rq_target_io *tio = clone->end_io_data;
2389 tio->info.flush_request = flush_nr;
2392 /* Issue barrier requests to targets and wait for their completion. */
2393 static int dm_rq_barrier(struct mapped_device *md)
2396 struct dm_table *map = dm_get_live_table(md);
2397 unsigned num_targets = dm_table_get_num_targets(map);
2398 struct dm_target *ti;
2399 struct request *clone;
2401 md->barrier_error = 0;
2403 for (i = 0; i < num_targets; i++) {
2404 ti = dm_table_get_target(map, i);
2405 for (j = 0; j < ti->num_flush_requests; j++) {
2406 clone = clone_rq(md->flush_request, md, GFP_NOIO);
2407 dm_rq_set_flush_nr(clone, j);
2408 atomic_inc(&md->pending[rq_data_dir(clone)]);
2409 map_request(ti, clone, md);
2413 dm_wait_for_completion(md, TASK_UNINTERRUPTIBLE);
2416 return md->barrier_error;
2419 static void dm_rq_barrier_work(struct work_struct *work)
2422 struct mapped_device *md = container_of(work, struct mapped_device,
2424 struct request_queue *q = md->queue;
2426 unsigned long flags;
2429 * Hold the md reference here and leave it at the last part so that
2430 * the md can't be deleted by device opener when the barrier request
2435 error = dm_rq_barrier(md);
2437 rq = md->flush_request;
2438 md->flush_request = NULL;
2440 if (error == DM_ENDIO_REQUEUE) {
2441 spin_lock_irqsave(q->queue_lock, flags);
2442 blk_requeue_request(q, rq);
2443 spin_unlock_irqrestore(q->queue_lock, flags);
2445 blk_end_request_all(rq, error);
2453 * Swap in a new table, returning the old one for the caller to destroy.
2455 struct dm_table *dm_swap_table(struct mapped_device *md, struct dm_table *table)
2457 struct dm_table *map = ERR_PTR(-EINVAL);
2458 struct queue_limits limits;
2461 mutex_lock(&md->suspend_lock);
2463 /* device must be suspended */
2464 if (!dm_suspended_md(md))
2467 r = dm_calculate_queue_limits(table, &limits);
2473 map = __bind(md, table, &limits);
2476 mutex_unlock(&md->suspend_lock);
2481 * Functions to lock and unlock any filesystem running on the
2484 static int lock_fs(struct mapped_device *md)
2488 WARN_ON(md->frozen_sb);
2490 md->frozen_sb = freeze_bdev(md->bdev);
2491 if (IS_ERR(md->frozen_sb)) {
2492 r = PTR_ERR(md->frozen_sb);
2493 md->frozen_sb = NULL;
2497 set_bit(DMF_FROZEN, &md->flags);
2502 static void unlock_fs(struct mapped_device *md)
2504 if (!test_bit(DMF_FROZEN, &md->flags))
2507 thaw_bdev(md->bdev, md->frozen_sb);
2508 md->frozen_sb = NULL;
2509 clear_bit(DMF_FROZEN, &md->flags);
2513 * We need to be able to change a mapping table under a mounted
2514 * filesystem. For example we might want to move some data in
2515 * the background. Before the table can be swapped with
2516 * dm_bind_table, dm_suspend must be called to flush any in
2517 * flight bios and ensure that any further io gets deferred.
2520 * Suspend mechanism in request-based dm.
2522 * 1. Flush all I/Os by lock_fs() if needed.
2523 * 2. Stop dispatching any I/O by stopping the request_queue.
2524 * 3. Wait for all in-flight I/Os to be completed or requeued.
2526 * To abort suspend, start the request_queue.
2528 int dm_suspend(struct mapped_device *md, unsigned suspend_flags)
2530 struct dm_table *map = NULL;
2532 int do_lockfs = suspend_flags & DM_SUSPEND_LOCKFS_FLAG ? 1 : 0;
2533 int noflush = suspend_flags & DM_SUSPEND_NOFLUSH_FLAG ? 1 : 0;
2535 mutex_lock(&md->suspend_lock);
2537 if (dm_suspended_md(md)) {
2542 map = dm_get_live_table(md);
2545 * DMF_NOFLUSH_SUSPENDING must be set before presuspend.
2546 * This flag is cleared before dm_suspend returns.
2549 set_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
2551 /* This does not get reverted if there's an error later. */
2552 dm_table_presuspend_targets(map);
2555 * Flush I/O to the device.
2556 * Any I/O submitted after lock_fs() may not be flushed.
2557 * noflush takes precedence over do_lockfs.
2558 * (lock_fs() flushes I/Os and waits for them to complete.)
2560 if (!noflush && do_lockfs) {
2567 * Here we must make sure that no processes are submitting requests
2568 * to target drivers i.e. no one may be executing
2569 * __split_and_process_bio. This is called from dm_request and
2572 * To get all processes out of __split_and_process_bio in dm_request,
2573 * we take the write lock. To prevent any process from reentering
2574 * __split_and_process_bio from dm_request, we set
2575 * DMF_QUEUE_IO_TO_THREAD.
2577 * To quiesce the thread (dm_wq_work), we set DMF_BLOCK_IO_FOR_SUSPEND
2578 * and call flush_workqueue(md->wq). flush_workqueue will wait until
2579 * dm_wq_work exits and DMF_BLOCK_IO_FOR_SUSPEND will prevent any
2580 * further calls to __split_and_process_bio from dm_wq_work.
2582 down_write(&md->io_lock);
2583 set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
2584 set_bit(DMF_QUEUE_IO_TO_THREAD, &md->flags);
2585 up_write(&md->io_lock);
2588 * Request-based dm uses md->wq for barrier (dm_rq_barrier_work) which
2589 * can be kicked until md->queue is stopped. So stop md->queue before
2592 if (dm_request_based(md))
2593 stop_queue(md->queue);
2595 flush_workqueue(md->wq);
2598 * At this point no more requests are entering target request routines.
2599 * We call dm_wait_for_completion to wait for all existing requests
2602 r = dm_wait_for_completion(md, TASK_INTERRUPTIBLE);
2604 down_write(&md->io_lock);
2606 clear_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
2607 up_write(&md->io_lock);
2609 /* were we interrupted ? */
2613 if (dm_request_based(md))
2614 start_queue(md->queue);
2617 goto out; /* pushback list is already flushed, so skip flush */
2621 * If dm_wait_for_completion returned 0, the device is completely
2622 * quiescent now. There is no request-processing activity. All new
2623 * requests are being added to md->deferred list.
2626 set_bit(DMF_SUSPENDED, &md->flags);
2628 dm_table_postsuspend_targets(map);
2634 mutex_unlock(&md->suspend_lock);
2638 int dm_resume(struct mapped_device *md)
2641 struct dm_table *map = NULL;
2643 mutex_lock(&md->suspend_lock);
2644 if (!dm_suspended_md(md))
2647 map = dm_get_live_table(md);
2648 if (!map || !dm_table_get_size(map))
2651 r = dm_table_resume_targets(map);
2658 * Flushing deferred I/Os must be done after targets are resumed
2659 * so that mapping of targets can work correctly.
2660 * Request-based dm is queueing the deferred I/Os in its request_queue.
2662 if (dm_request_based(md))
2663 start_queue(md->queue);
2667 clear_bit(DMF_SUSPENDED, &md->flags);
2669 dm_table_unplug_all(map);
2673 mutex_unlock(&md->suspend_lock);
2678 /*-----------------------------------------------------------------
2679 * Event notification.
2680 *---------------------------------------------------------------*/
2681 int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
2684 char udev_cookie[DM_COOKIE_LENGTH];
2685 char *envp[] = { udev_cookie, NULL };
2688 return kobject_uevent(&disk_to_dev(md->disk)->kobj, action);
2690 snprintf(udev_cookie, DM_COOKIE_LENGTH, "%s=%u",
2691 DM_COOKIE_ENV_VAR_NAME, cookie);
2692 return kobject_uevent_env(&disk_to_dev(md->disk)->kobj,
2697 uint32_t dm_next_uevent_seq(struct mapped_device *md)
2699 return atomic_add_return(1, &md->uevent_seq);
2702 uint32_t dm_get_event_nr(struct mapped_device *md)
2704 return atomic_read(&md->event_nr);
2707 int dm_wait_event(struct mapped_device *md, int event_nr)
2709 return wait_event_interruptible(md->eventq,
2710 (event_nr != atomic_read(&md->event_nr)));
2713 void dm_uevent_add(struct mapped_device *md, struct list_head *elist)
2715 unsigned long flags;
2717 spin_lock_irqsave(&md->uevent_lock, flags);
2718 list_add(elist, &md->uevent_list);
2719 spin_unlock_irqrestore(&md->uevent_lock, flags);
2723 * The gendisk is only valid as long as you have a reference
2726 struct gendisk *dm_disk(struct mapped_device *md)
2731 struct kobject *dm_kobject(struct mapped_device *md)
2737 * struct mapped_device should not be exported outside of dm.c
2738 * so use this check to verify that kobj is part of md structure
2740 struct mapped_device *dm_get_from_kobject(struct kobject *kobj)
2742 struct mapped_device *md;
2744 md = container_of(kobj, struct mapped_device, kobj);
2745 if (&md->kobj != kobj)
2748 if (test_bit(DMF_FREEING, &md->flags) ||
2756 int dm_suspended_md(struct mapped_device *md)
2758 return test_bit(DMF_SUSPENDED, &md->flags);
2761 int dm_suspended(struct dm_target *ti)
2763 return dm_suspended_md(dm_table_get_md(ti->table));
2765 EXPORT_SYMBOL_GPL(dm_suspended);
2767 int dm_noflush_suspending(struct dm_target *ti)
2769 return __noflush_suspending(dm_table_get_md(ti->table));
2771 EXPORT_SYMBOL_GPL(dm_noflush_suspending);
2773 struct dm_md_mempools *dm_alloc_md_mempools(unsigned type)
2775 struct dm_md_mempools *pools = kmalloc(sizeof(*pools), GFP_KERNEL);
2780 pools->io_pool = (type == DM_TYPE_BIO_BASED) ?
2781 mempool_create_slab_pool(MIN_IOS, _io_cache) :
2782 mempool_create_slab_pool(MIN_IOS, _rq_bio_info_cache);
2783 if (!pools->io_pool)
2784 goto free_pools_and_out;
2786 pools->tio_pool = (type == DM_TYPE_BIO_BASED) ?
2787 mempool_create_slab_pool(MIN_IOS, _tio_cache) :
2788 mempool_create_slab_pool(MIN_IOS, _rq_tio_cache);
2789 if (!pools->tio_pool)
2790 goto free_io_pool_and_out;
2792 pools->bs = (type == DM_TYPE_BIO_BASED) ?
2793 bioset_create(16, 0) : bioset_create(MIN_IOS, 0);
2795 goto free_tio_pool_and_out;
2799 free_tio_pool_and_out:
2800 mempool_destroy(pools->tio_pool);
2802 free_io_pool_and_out:
2803 mempool_destroy(pools->io_pool);
2811 void dm_free_md_mempools(struct dm_md_mempools *pools)
2817 mempool_destroy(pools->io_pool);
2819 if (pools->tio_pool)
2820 mempool_destroy(pools->tio_pool);
2823 bioset_free(pools->bs);
2828 static const struct block_device_operations dm_blk_dops = {
2829 .open = dm_blk_open,
2830 .release = dm_blk_close,
2831 .ioctl = dm_blk_ioctl,
2832 .getgeo = dm_blk_getgeo,
2833 .owner = THIS_MODULE
2836 EXPORT_SYMBOL(dm_get_mapinfo);
2841 module_init(dm_init);
2842 module_exit(dm_exit);
2844 module_param(major, uint, 0);
2845 MODULE_PARM_DESC(major, "The major number of the device mapper");
2846 MODULE_DESCRIPTION(DM_NAME " driver");
2847 MODULE_AUTHOR("Joe Thornber <dm-devel@redhat.com>");
2848 MODULE_LICENSE("GPL");