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/mempool.h>
18 #include <linux/slab.h>
19 #include <linux/idr.h>
20 #include <linux/hdreg.h>
21 #include <linux/delay.h>
23 #include <trace/events/block.h>
25 #define DM_MSG_PREFIX "core"
29 * ratelimit state to be used in DMXXX_LIMIT().
31 DEFINE_RATELIMIT_STATE(dm_ratelimit_state,
32 DEFAULT_RATELIMIT_INTERVAL,
33 DEFAULT_RATELIMIT_BURST);
34 EXPORT_SYMBOL(dm_ratelimit_state);
38 * Cookies are numeric values sent with CHANGE and REMOVE
39 * uevents while resuming, removing or renaming the device.
41 #define DM_COOKIE_ENV_VAR_NAME "DM_COOKIE"
42 #define DM_COOKIE_LENGTH 24
44 static const char *_name = DM_NAME;
46 static unsigned int major = 0;
47 static unsigned int _major = 0;
49 static DEFINE_IDR(_minor_idr);
51 static DEFINE_SPINLOCK(_minor_lock);
53 static void do_deferred_remove(struct work_struct *w);
55 static DECLARE_WORK(deferred_remove_work, do_deferred_remove);
57 static struct workqueue_struct *deferred_remove_workqueue;
61 * One of these is allocated per bio.
64 struct mapped_device *md;
68 unsigned long start_time;
69 spinlock_t endio_lock;
70 struct dm_stats_aux stats_aux;
74 * For request-based dm.
75 * One of these is allocated per request.
77 struct dm_rq_target_io {
78 struct mapped_device *md;
80 struct request *orig, clone;
86 * For request-based dm - the bio clones we allocate are embedded in these
89 * We allocate these with bio_alloc_bioset, using the front_pad parameter when
90 * the bioset is created - this means the bio has to come at the end of the
93 struct dm_rq_clone_bio_info {
95 struct dm_rq_target_io *tio;
99 union map_info *dm_get_rq_mapinfo(struct request *rq)
101 if (rq && rq->end_io_data)
102 return &((struct dm_rq_target_io *)rq->end_io_data)->info;
105 EXPORT_SYMBOL_GPL(dm_get_rq_mapinfo);
107 #define MINOR_ALLOCED ((void *)-1)
110 * Bits for the md->flags field.
112 #define DMF_BLOCK_IO_FOR_SUSPEND 0
113 #define DMF_SUSPENDED 1
115 #define DMF_FREEING 3
116 #define DMF_DELETING 4
117 #define DMF_NOFLUSH_SUSPENDING 5
118 #define DMF_MERGE_IS_OPTIONAL 6
119 #define DMF_DEFERRED_REMOVE 7
122 * A dummy definition to make RCU happy.
123 * struct dm_table should never be dereferenced in this file.
130 * Work processed by per-device workqueue.
132 struct mapped_device {
133 struct srcu_struct io_barrier;
134 struct mutex suspend_lock;
139 * The current mapping.
140 * Use dm_get_live_table{_fast} or take suspend_lock for
143 struct dm_table *map;
147 struct request_queue *queue;
149 /* Protect queue and type against concurrent access. */
150 struct mutex type_lock;
152 struct target_type *immutable_target_type;
154 struct gendisk *disk;
160 * A list of ios that arrived while we were suspended.
163 wait_queue_head_t wait;
164 struct work_struct work;
165 struct bio_list deferred;
166 spinlock_t deferred_lock;
169 * Processing queue (flush)
171 struct workqueue_struct *wq;
174 * io objects are allocated from here.
184 wait_queue_head_t eventq;
186 struct list_head uevent_list;
187 spinlock_t uevent_lock; /* Protect access to uevent_list */
190 * freeze/thaw support require holding onto a super block
192 struct super_block *frozen_sb;
193 struct block_device *bdev;
195 /* forced geometry settings */
196 struct hd_geometry geometry;
198 /* kobject and completion */
199 struct dm_kobject_holder kobj_holder;
201 /* zero-length flush that will be cloned and submitted to targets */
202 struct bio flush_bio;
204 struct dm_stats stats;
208 * For mempools pre-allocation at the table loading time.
210 struct dm_md_mempools {
215 #define RESERVED_BIO_BASED_IOS 16
216 #define RESERVED_REQUEST_BASED_IOS 256
217 #define RESERVED_MAX_IOS 1024
218 static struct kmem_cache *_io_cache;
219 static struct kmem_cache *_rq_tio_cache;
222 * Bio-based DM's mempools' reserved IOs set by the user.
224 static unsigned reserved_bio_based_ios = RESERVED_BIO_BASED_IOS;
227 * Request-based DM's mempools' reserved IOs set by the user.
229 static unsigned reserved_rq_based_ios = RESERVED_REQUEST_BASED_IOS;
231 static unsigned __dm_get_reserved_ios(unsigned *reserved_ios,
232 unsigned def, unsigned max)
234 unsigned ios = ACCESS_ONCE(*reserved_ios);
235 unsigned modified_ios = 0;
243 (void)cmpxchg(reserved_ios, ios, modified_ios);
250 unsigned dm_get_reserved_bio_based_ios(void)
252 return __dm_get_reserved_ios(&reserved_bio_based_ios,
253 RESERVED_BIO_BASED_IOS, RESERVED_MAX_IOS);
255 EXPORT_SYMBOL_GPL(dm_get_reserved_bio_based_ios);
257 unsigned dm_get_reserved_rq_based_ios(void)
259 return __dm_get_reserved_ios(&reserved_rq_based_ios,
260 RESERVED_REQUEST_BASED_IOS, RESERVED_MAX_IOS);
262 EXPORT_SYMBOL_GPL(dm_get_reserved_rq_based_ios);
264 static int __init local_init(void)
268 /* allocate a slab for the dm_ios */
269 _io_cache = KMEM_CACHE(dm_io, 0);
273 _rq_tio_cache = KMEM_CACHE(dm_rq_target_io, 0);
275 goto out_free_io_cache;
277 r = dm_uevent_init();
279 goto out_free_rq_tio_cache;
281 deferred_remove_workqueue = alloc_workqueue("kdmremove", WQ_UNBOUND, 1);
282 if (!deferred_remove_workqueue) {
284 goto out_uevent_exit;
288 r = register_blkdev(_major, _name);
290 goto out_free_workqueue;
298 destroy_workqueue(deferred_remove_workqueue);
301 out_free_rq_tio_cache:
302 kmem_cache_destroy(_rq_tio_cache);
304 kmem_cache_destroy(_io_cache);
309 static void local_exit(void)
311 flush_scheduled_work();
312 destroy_workqueue(deferred_remove_workqueue);
314 kmem_cache_destroy(_rq_tio_cache);
315 kmem_cache_destroy(_io_cache);
316 unregister_blkdev(_major, _name);
321 DMINFO("cleaned up");
324 static int (*_inits[])(void) __initdata = {
335 static void (*_exits[])(void) = {
346 static int __init dm_init(void)
348 const int count = ARRAY_SIZE(_inits);
352 for (i = 0; i < count; i++) {
367 static void __exit dm_exit(void)
369 int i = ARRAY_SIZE(_exits);
375 * Should be empty by this point.
377 idr_destroy(&_minor_idr);
381 * Block device functions
383 int dm_deleting_md(struct mapped_device *md)
385 return test_bit(DMF_DELETING, &md->flags);
388 static int dm_blk_open(struct block_device *bdev, fmode_t mode)
390 struct mapped_device *md;
392 spin_lock(&_minor_lock);
394 md = bdev->bd_disk->private_data;
398 if (test_bit(DMF_FREEING, &md->flags) ||
399 dm_deleting_md(md)) {
405 atomic_inc(&md->open_count);
408 spin_unlock(&_minor_lock);
410 return md ? 0 : -ENXIO;
413 static void dm_blk_close(struct gendisk *disk, fmode_t mode)
415 struct mapped_device *md = disk->private_data;
417 spin_lock(&_minor_lock);
419 if (atomic_dec_and_test(&md->open_count) &&
420 (test_bit(DMF_DEFERRED_REMOVE, &md->flags)))
421 queue_work(deferred_remove_workqueue, &deferred_remove_work);
425 spin_unlock(&_minor_lock);
428 int dm_open_count(struct mapped_device *md)
430 return atomic_read(&md->open_count);
434 * Guarantees nothing is using the device before it's deleted.
436 int dm_lock_for_deletion(struct mapped_device *md, bool mark_deferred, bool only_deferred)
440 spin_lock(&_minor_lock);
442 if (dm_open_count(md)) {
445 set_bit(DMF_DEFERRED_REMOVE, &md->flags);
446 } else if (only_deferred && !test_bit(DMF_DEFERRED_REMOVE, &md->flags))
449 set_bit(DMF_DELETING, &md->flags);
451 spin_unlock(&_minor_lock);
456 int dm_cancel_deferred_remove(struct mapped_device *md)
460 spin_lock(&_minor_lock);
462 if (test_bit(DMF_DELETING, &md->flags))
465 clear_bit(DMF_DEFERRED_REMOVE, &md->flags);
467 spin_unlock(&_minor_lock);
472 static void do_deferred_remove(struct work_struct *w)
474 dm_deferred_remove();
477 sector_t dm_get_size(struct mapped_device *md)
479 return get_capacity(md->disk);
482 struct request_queue *dm_get_md_queue(struct mapped_device *md)
487 struct dm_stats *dm_get_stats(struct mapped_device *md)
492 static int dm_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
494 struct mapped_device *md = bdev->bd_disk->private_data;
496 return dm_get_geometry(md, geo);
499 static int dm_blk_ioctl(struct block_device *bdev, fmode_t mode,
500 unsigned int cmd, unsigned long arg)
502 struct mapped_device *md = bdev->bd_disk->private_data;
504 struct dm_table *map;
505 struct dm_target *tgt;
509 map = dm_get_live_table(md, &srcu_idx);
511 if (!map || !dm_table_get_size(map))
514 /* We only support devices that have a single target */
515 if (dm_table_get_num_targets(map) != 1)
518 tgt = dm_table_get_target(map, 0);
520 if (dm_suspended_md(md)) {
525 if (tgt->type->ioctl)
526 r = tgt->type->ioctl(tgt, cmd, arg);
529 dm_put_live_table(md, srcu_idx);
531 if (r == -ENOTCONN) {
539 static struct dm_io *alloc_io(struct mapped_device *md)
541 return mempool_alloc(md->io_pool, GFP_NOIO);
544 static void free_io(struct mapped_device *md, struct dm_io *io)
546 mempool_free(io, md->io_pool);
549 static void free_tio(struct mapped_device *md, struct dm_target_io *tio)
551 bio_put(&tio->clone);
554 static struct dm_rq_target_io *alloc_rq_tio(struct mapped_device *md,
557 return mempool_alloc(md->io_pool, gfp_mask);
560 static void free_rq_tio(struct dm_rq_target_io *tio)
562 mempool_free(tio, tio->md->io_pool);
565 static int md_in_flight(struct mapped_device *md)
567 return atomic_read(&md->pending[READ]) +
568 atomic_read(&md->pending[WRITE]);
571 static void start_io_acct(struct dm_io *io)
573 struct mapped_device *md = io->md;
574 struct bio *bio = io->bio;
576 int rw = bio_data_dir(bio);
578 io->start_time = jiffies;
580 cpu = part_stat_lock();
581 part_round_stats(cpu, &dm_disk(md)->part0);
583 atomic_set(&dm_disk(md)->part0.in_flight[rw],
584 atomic_inc_return(&md->pending[rw]));
586 if (unlikely(dm_stats_used(&md->stats)))
587 dm_stats_account_io(&md->stats, bio->bi_rw, bio->bi_iter.bi_sector,
588 bio_sectors(bio), false, 0, &io->stats_aux);
591 static void end_io_acct(struct dm_io *io)
593 struct mapped_device *md = io->md;
594 struct bio *bio = io->bio;
595 unsigned long duration = jiffies - io->start_time;
597 int rw = bio_data_dir(bio);
599 cpu = part_stat_lock();
600 part_round_stats(cpu, &dm_disk(md)->part0);
601 part_stat_add(cpu, &dm_disk(md)->part0, ticks[rw], duration);
604 if (unlikely(dm_stats_used(&md->stats)))
605 dm_stats_account_io(&md->stats, bio->bi_rw, bio->bi_iter.bi_sector,
606 bio_sectors(bio), true, duration, &io->stats_aux);
609 * After this is decremented the bio must not be touched if it is
612 pending = atomic_dec_return(&md->pending[rw]);
613 atomic_set(&dm_disk(md)->part0.in_flight[rw], pending);
614 pending += atomic_read(&md->pending[rw^0x1]);
616 /* nudge anyone waiting on suspend queue */
622 * Add the bio to the list of deferred io.
624 static void queue_io(struct mapped_device *md, struct bio *bio)
628 spin_lock_irqsave(&md->deferred_lock, flags);
629 bio_list_add(&md->deferred, bio);
630 spin_unlock_irqrestore(&md->deferred_lock, flags);
631 queue_work(md->wq, &md->work);
635 * Everyone (including functions in this file), should use this
636 * function to access the md->map field, and make sure they call
637 * dm_put_live_table() when finished.
639 struct dm_table *dm_get_live_table(struct mapped_device *md, int *srcu_idx) __acquires(md->io_barrier)
641 *srcu_idx = srcu_read_lock(&md->io_barrier);
643 return srcu_dereference(md->map, &md->io_barrier);
646 void dm_put_live_table(struct mapped_device *md, int srcu_idx) __releases(md->io_barrier)
648 srcu_read_unlock(&md->io_barrier, srcu_idx);
651 void dm_sync_table(struct mapped_device *md)
653 synchronize_srcu(&md->io_barrier);
654 synchronize_rcu_expedited();
658 * A fast alternative to dm_get_live_table/dm_put_live_table.
659 * The caller must not block between these two functions.
661 static struct dm_table *dm_get_live_table_fast(struct mapped_device *md) __acquires(RCU)
664 return rcu_dereference(md->map);
667 static void dm_put_live_table_fast(struct mapped_device *md) __releases(RCU)
673 * Get the geometry associated with a dm device
675 int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo)
683 * Set the geometry of a device.
685 int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo)
687 sector_t sz = (sector_t)geo->cylinders * geo->heads * geo->sectors;
689 if (geo->start > sz) {
690 DMWARN("Start sector is beyond the geometry limits.");
699 /*-----------------------------------------------------------------
701 * A more elegant soln is in the works that uses the queue
702 * merge fn, unfortunately there are a couple of changes to
703 * the block layer that I want to make for this. So in the
704 * interests of getting something for people to use I give
705 * you this clearly demarcated crap.
706 *---------------------------------------------------------------*/
708 static int __noflush_suspending(struct mapped_device *md)
710 return test_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
714 * Decrements the number of outstanding ios that a bio has been
715 * cloned into, completing the original io if necc.
717 static void dec_pending(struct dm_io *io, int error)
722 struct mapped_device *md = io->md;
724 /* Push-back supersedes any I/O errors */
725 if (unlikely(error)) {
726 spin_lock_irqsave(&io->endio_lock, flags);
727 if (!(io->error > 0 && __noflush_suspending(md)))
729 spin_unlock_irqrestore(&io->endio_lock, flags);
732 if (atomic_dec_and_test(&io->io_count)) {
733 if (io->error == DM_ENDIO_REQUEUE) {
735 * Target requested pushing back the I/O.
737 spin_lock_irqsave(&md->deferred_lock, flags);
738 if (__noflush_suspending(md))
739 bio_list_add_head(&md->deferred, io->bio);
741 /* noflush suspend was interrupted. */
743 spin_unlock_irqrestore(&md->deferred_lock, flags);
746 io_error = io->error;
751 if (io_error == DM_ENDIO_REQUEUE)
754 if ((bio->bi_rw & REQ_FLUSH) && bio->bi_iter.bi_size) {
756 * Preflush done for flush with data, reissue
759 bio->bi_rw &= ~REQ_FLUSH;
762 /* done with normal IO or empty flush */
763 trace_block_bio_complete(md->queue, bio, io_error);
764 bio_endio(bio, io_error);
769 static void disable_write_same(struct mapped_device *md)
771 struct queue_limits *limits = dm_get_queue_limits(md);
773 /* device doesn't really support WRITE SAME, disable it */
774 limits->max_write_same_sectors = 0;
777 static void clone_endio(struct bio *bio, int error)
780 struct dm_target_io *tio = container_of(bio, struct dm_target_io, clone);
781 struct dm_io *io = tio->io;
782 struct mapped_device *md = tio->io->md;
783 dm_endio_fn endio = tio->ti->type->end_io;
785 if (!bio_flagged(bio, BIO_UPTODATE) && !error)
789 r = endio(tio->ti, bio, error);
790 if (r < 0 || r == DM_ENDIO_REQUEUE)
792 * error and requeue request are handled
796 else if (r == DM_ENDIO_INCOMPLETE)
797 /* The target will handle the io */
800 DMWARN("unimplemented target endio return value: %d", r);
805 if (unlikely(r == -EREMOTEIO && (bio->bi_rw & REQ_WRITE_SAME) &&
806 !bdev_get_queue(bio->bi_bdev)->limits.max_write_same_sectors))
807 disable_write_same(md);
810 dec_pending(io, error);
814 * Partial completion handling for request-based dm
816 static void end_clone_bio(struct bio *clone, int error)
818 struct dm_rq_clone_bio_info *info =
819 container_of(clone, struct dm_rq_clone_bio_info, clone);
820 struct dm_rq_target_io *tio = info->tio;
821 struct bio *bio = info->orig;
822 unsigned int nr_bytes = info->orig->bi_iter.bi_size;
828 * An error has already been detected on the request.
829 * Once error occurred, just let clone->end_io() handle
835 * Don't notice the error to the upper layer yet.
836 * The error handling decision is made by the target driver,
837 * when the request is completed.
844 * I/O for the bio successfully completed.
845 * Notice the data completion to the upper layer.
849 * bios are processed from the head of the list.
850 * So the completing bio should always be rq->bio.
851 * If it's not, something wrong is happening.
853 if (tio->orig->bio != bio)
854 DMERR("bio completion is going in the middle of the request");
857 * Update the original request.
858 * Do not use blk_end_request() here, because it may complete
859 * the original request before the clone, and break the ordering.
861 blk_update_request(tio->orig, 0, nr_bytes);
865 * Don't touch any member of the md after calling this function because
866 * the md may be freed in dm_put() at the end of this function.
867 * Or do dm_get() before calling this function and dm_put() later.
869 static void rq_completed(struct mapped_device *md, int rw, int run_queue)
871 atomic_dec(&md->pending[rw]);
873 /* nudge anyone waiting on suspend queue */
874 if (!md_in_flight(md))
878 * Run this off this callpath, as drivers could invoke end_io while
879 * inside their request_fn (and holding the queue lock). Calling
880 * back into ->request_fn() could deadlock attempting to grab the
884 blk_run_queue_async(md->queue);
887 * dm_put() must be at the end of this function. See the comment above
892 static void free_rq_clone(struct request *clone)
894 struct dm_rq_target_io *tio = clone->end_io_data;
896 blk_rq_unprep_clone(clone);
901 * Complete the clone and the original request.
902 * Must be called without queue lock.
904 static void dm_end_request(struct request *clone, int error)
906 int rw = rq_data_dir(clone);
907 struct dm_rq_target_io *tio = clone->end_io_data;
908 struct mapped_device *md = tio->md;
909 struct request *rq = tio->orig;
911 if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
912 rq->errors = clone->errors;
913 rq->resid_len = clone->resid_len;
917 * We are using the sense buffer of the original
919 * So setting the length of the sense data is enough.
921 rq->sense_len = clone->sense_len;
924 free_rq_clone(clone);
925 blk_end_request_all(rq, error);
926 rq_completed(md, rw, true);
929 static void dm_unprep_request(struct request *rq)
931 struct request *clone = rq->special;
934 rq->cmd_flags &= ~REQ_DONTPREP;
936 free_rq_clone(clone);
940 * Requeue the original request of a clone.
942 void dm_requeue_unmapped_request(struct request *clone)
944 int rw = rq_data_dir(clone);
945 struct dm_rq_target_io *tio = clone->end_io_data;
946 struct mapped_device *md = tio->md;
947 struct request *rq = tio->orig;
948 struct request_queue *q = rq->q;
951 dm_unprep_request(rq);
953 spin_lock_irqsave(q->queue_lock, flags);
954 blk_requeue_request(q, rq);
955 spin_unlock_irqrestore(q->queue_lock, flags);
957 rq_completed(md, rw, 0);
959 EXPORT_SYMBOL_GPL(dm_requeue_unmapped_request);
961 static void __stop_queue(struct request_queue *q)
966 static void stop_queue(struct request_queue *q)
970 spin_lock_irqsave(q->queue_lock, flags);
972 spin_unlock_irqrestore(q->queue_lock, flags);
975 static void __start_queue(struct request_queue *q)
977 if (blk_queue_stopped(q))
981 static void start_queue(struct request_queue *q)
985 spin_lock_irqsave(q->queue_lock, flags);
987 spin_unlock_irqrestore(q->queue_lock, flags);
990 static void dm_done(struct request *clone, int error, bool mapped)
993 struct dm_rq_target_io *tio = clone->end_io_data;
994 dm_request_endio_fn rq_end_io = NULL;
997 rq_end_io = tio->ti->type->rq_end_io;
999 if (mapped && rq_end_io)
1000 r = rq_end_io(tio->ti, clone, error, &tio->info);
1003 if (unlikely(r == -EREMOTEIO && (clone->cmd_flags & REQ_WRITE_SAME) &&
1004 !clone->q->limits.max_write_same_sectors))
1005 disable_write_same(tio->md);
1008 /* The target wants to complete the I/O */
1009 dm_end_request(clone, r);
1010 else if (r == DM_ENDIO_INCOMPLETE)
1011 /* The target will handle the I/O */
1013 else if (r == DM_ENDIO_REQUEUE)
1014 /* The target wants to requeue the I/O */
1015 dm_requeue_unmapped_request(clone);
1017 DMWARN("unimplemented target endio return value: %d", r);
1023 * Request completion handler for request-based dm
1025 static void dm_softirq_done(struct request *rq)
1028 struct request *clone = rq->completion_data;
1029 struct dm_rq_target_io *tio = clone->end_io_data;
1031 if (rq->cmd_flags & REQ_FAILED)
1034 dm_done(clone, tio->error, mapped);
1038 * Complete the clone and the original request with the error status
1039 * through softirq context.
1041 static void dm_complete_request(struct request *clone, int error)
1043 struct dm_rq_target_io *tio = clone->end_io_data;
1044 struct request *rq = tio->orig;
1047 rq->completion_data = clone;
1048 blk_complete_request(rq);
1052 * Complete the not-mapped clone and the original request with the error status
1053 * through softirq context.
1054 * Target's rq_end_io() function isn't called.
1055 * This may be used when the target's map_rq() function fails.
1057 void dm_kill_unmapped_request(struct request *clone, int error)
1059 struct dm_rq_target_io *tio = clone->end_io_data;
1060 struct request *rq = tio->orig;
1062 rq->cmd_flags |= REQ_FAILED;
1063 dm_complete_request(clone, error);
1065 EXPORT_SYMBOL_GPL(dm_kill_unmapped_request);
1068 * Called with the queue lock held
1070 static void end_clone_request(struct request *clone, int error)
1073 * For just cleaning up the information of the queue in which
1074 * the clone was dispatched.
1075 * The clone is *NOT* freed actually here because it is alloced from
1076 * dm own mempool and REQ_ALLOCED isn't set in clone->cmd_flags.
1078 __blk_put_request(clone->q, clone);
1081 * Actual request completion is done in a softirq context which doesn't
1082 * hold the queue lock. Otherwise, deadlock could occur because:
1083 * - another request may be submitted by the upper level driver
1084 * of the stacking during the completion
1085 * - the submission which requires queue lock may be done
1086 * against this queue
1088 dm_complete_request(clone, error);
1092 * Return maximum size of I/O possible at the supplied sector up to the current
1095 static sector_t max_io_len_target_boundary(sector_t sector, struct dm_target *ti)
1097 sector_t target_offset = dm_target_offset(ti, sector);
1099 return ti->len - target_offset;
1102 static sector_t max_io_len(sector_t sector, struct dm_target *ti)
1104 sector_t len = max_io_len_target_boundary(sector, ti);
1105 sector_t offset, max_len;
1108 * Does the target need to split even further?
1110 if (ti->max_io_len) {
1111 offset = dm_target_offset(ti, sector);
1112 if (unlikely(ti->max_io_len & (ti->max_io_len - 1)))
1113 max_len = sector_div(offset, ti->max_io_len);
1115 max_len = offset & (ti->max_io_len - 1);
1116 max_len = ti->max_io_len - max_len;
1125 int dm_set_target_max_io_len(struct dm_target *ti, sector_t len)
1127 if (len > UINT_MAX) {
1128 DMERR("Specified maximum size of target IO (%llu) exceeds limit (%u)",
1129 (unsigned long long)len, UINT_MAX);
1130 ti->error = "Maximum size of target IO is too large";
1134 ti->max_io_len = (uint32_t) len;
1138 EXPORT_SYMBOL_GPL(dm_set_target_max_io_len);
1141 * A target may call dm_accept_partial_bio only from the map routine. It is
1142 * allowed for all bio types except REQ_FLUSH.
1144 * dm_accept_partial_bio informs the dm that the target only wants to process
1145 * additional n_sectors sectors of the bio and the rest of the data should be
1146 * sent in a next bio.
1148 * A diagram that explains the arithmetics:
1149 * +--------------------+---------------+-------+
1151 * +--------------------+---------------+-------+
1153 * <-------------- *tio->len_ptr --------------->
1154 * <------- bi_size ------->
1157 * Region 1 was already iterated over with bio_advance or similar function.
1158 * (it may be empty if the target doesn't use bio_advance)
1159 * Region 2 is the remaining bio size that the target wants to process.
1160 * (it may be empty if region 1 is non-empty, although there is no reason
1162 * The target requires that region 3 is to be sent in the next bio.
1164 * If the target wants to receive multiple copies of the bio (via num_*bios, etc),
1165 * the partially processed part (the sum of regions 1+2) must be the same for all
1166 * copies of the bio.
1168 void dm_accept_partial_bio(struct bio *bio, unsigned n_sectors)
1170 struct dm_target_io *tio = container_of(bio, struct dm_target_io, clone);
1171 unsigned bi_size = bio->bi_iter.bi_size >> SECTOR_SHIFT;
1172 BUG_ON(bio->bi_rw & REQ_FLUSH);
1173 BUG_ON(bi_size > *tio->len_ptr);
1174 BUG_ON(n_sectors > bi_size);
1175 *tio->len_ptr -= bi_size - n_sectors;
1176 bio->bi_iter.bi_size = n_sectors << SECTOR_SHIFT;
1178 EXPORT_SYMBOL_GPL(dm_accept_partial_bio);
1180 static void __map_bio(struct dm_target_io *tio)
1184 struct mapped_device *md;
1185 struct bio *clone = &tio->clone;
1186 struct dm_target *ti = tio->ti;
1188 clone->bi_end_io = clone_endio;
1191 * Map the clone. If r == 0 we don't need to do
1192 * anything, the target has assumed ownership of
1195 atomic_inc(&tio->io->io_count);
1196 sector = clone->bi_iter.bi_sector;
1197 r = ti->type->map(ti, clone);
1198 if (r == DM_MAPIO_REMAPPED) {
1199 /* the bio has been remapped so dispatch it */
1201 trace_block_bio_remap(bdev_get_queue(clone->bi_bdev), clone,
1202 tio->io->bio->bi_bdev->bd_dev, sector);
1204 generic_make_request(clone);
1205 } else if (r < 0 || r == DM_MAPIO_REQUEUE) {
1206 /* error the io and bail out, or requeue it if needed */
1208 dec_pending(tio->io, r);
1211 DMWARN("unimplemented target map return value: %d", r);
1217 struct mapped_device *md;
1218 struct dm_table *map;
1222 unsigned sector_count;
1225 static void bio_setup_sector(struct bio *bio, sector_t sector, unsigned len)
1227 bio->bi_iter.bi_sector = sector;
1228 bio->bi_iter.bi_size = to_bytes(len);
1232 * Creates a bio that consists of range of complete bvecs.
1234 static void clone_bio(struct dm_target_io *tio, struct bio *bio,
1235 sector_t sector, unsigned len)
1237 struct bio *clone = &tio->clone;
1239 __bio_clone_fast(clone, bio);
1241 if (bio_integrity(bio))
1242 bio_integrity_clone(clone, bio, GFP_NOIO);
1244 bio_advance(clone, to_bytes(sector - clone->bi_iter.bi_sector));
1245 clone->bi_iter.bi_size = to_bytes(len);
1247 if (bio_integrity(bio))
1248 bio_integrity_trim(clone, 0, len);
1251 static struct dm_target_io *alloc_tio(struct clone_info *ci,
1252 struct dm_target *ti,
1253 unsigned target_bio_nr)
1255 struct dm_target_io *tio;
1258 clone = bio_alloc_bioset(GFP_NOIO, 0, ci->md->bs);
1259 tio = container_of(clone, struct dm_target_io, clone);
1263 tio->target_bio_nr = target_bio_nr;
1268 static void __clone_and_map_simple_bio(struct clone_info *ci,
1269 struct dm_target *ti,
1270 unsigned target_bio_nr, unsigned *len)
1272 struct dm_target_io *tio = alloc_tio(ci, ti, target_bio_nr);
1273 struct bio *clone = &tio->clone;
1277 __bio_clone_fast(clone, ci->bio);
1279 bio_setup_sector(clone, ci->sector, *len);
1284 static void __send_duplicate_bios(struct clone_info *ci, struct dm_target *ti,
1285 unsigned num_bios, unsigned *len)
1287 unsigned target_bio_nr;
1289 for (target_bio_nr = 0; target_bio_nr < num_bios; target_bio_nr++)
1290 __clone_and_map_simple_bio(ci, ti, target_bio_nr, len);
1293 static int __send_empty_flush(struct clone_info *ci)
1295 unsigned target_nr = 0;
1296 struct dm_target *ti;
1298 BUG_ON(bio_has_data(ci->bio));
1299 while ((ti = dm_table_get_target(ci->map, target_nr++)))
1300 __send_duplicate_bios(ci, ti, ti->num_flush_bios, NULL);
1305 static void __clone_and_map_data_bio(struct clone_info *ci, struct dm_target *ti,
1306 sector_t sector, unsigned *len)
1308 struct bio *bio = ci->bio;
1309 struct dm_target_io *tio;
1310 unsigned target_bio_nr;
1311 unsigned num_target_bios = 1;
1314 * Does the target want to receive duplicate copies of the bio?
1316 if (bio_data_dir(bio) == WRITE && ti->num_write_bios)
1317 num_target_bios = ti->num_write_bios(ti, bio);
1319 for (target_bio_nr = 0; target_bio_nr < num_target_bios; target_bio_nr++) {
1320 tio = alloc_tio(ci, ti, target_bio_nr);
1322 clone_bio(tio, bio, sector, *len);
1327 typedef unsigned (*get_num_bios_fn)(struct dm_target *ti);
1329 static unsigned get_num_discard_bios(struct dm_target *ti)
1331 return ti->num_discard_bios;
1334 static unsigned get_num_write_same_bios(struct dm_target *ti)
1336 return ti->num_write_same_bios;
1339 typedef bool (*is_split_required_fn)(struct dm_target *ti);
1341 static bool is_split_required_for_discard(struct dm_target *ti)
1343 return ti->split_discard_bios;
1346 static int __send_changing_extent_only(struct clone_info *ci,
1347 get_num_bios_fn get_num_bios,
1348 is_split_required_fn is_split_required)
1350 struct dm_target *ti;
1355 ti = dm_table_find_target(ci->map, ci->sector);
1356 if (!dm_target_is_valid(ti))
1360 * Even though the device advertised support for this type of
1361 * request, that does not mean every target supports it, and
1362 * reconfiguration might also have changed that since the
1363 * check was performed.
1365 num_bios = get_num_bios ? get_num_bios(ti) : 0;
1369 if (is_split_required && !is_split_required(ti))
1370 len = min((sector_t)ci->sector_count, max_io_len_target_boundary(ci->sector, ti));
1372 len = min((sector_t)ci->sector_count, max_io_len(ci->sector, ti));
1374 __send_duplicate_bios(ci, ti, num_bios, &len);
1377 } while (ci->sector_count -= len);
1382 static int __send_discard(struct clone_info *ci)
1384 return __send_changing_extent_only(ci, get_num_discard_bios,
1385 is_split_required_for_discard);
1388 static int __send_write_same(struct clone_info *ci)
1390 return __send_changing_extent_only(ci, get_num_write_same_bios, NULL);
1394 * Select the correct strategy for processing a non-flush bio.
1396 static int __split_and_process_non_flush(struct clone_info *ci)
1398 struct bio *bio = ci->bio;
1399 struct dm_target *ti;
1402 if (unlikely(bio->bi_rw & REQ_DISCARD))
1403 return __send_discard(ci);
1404 else if (unlikely(bio->bi_rw & REQ_WRITE_SAME))
1405 return __send_write_same(ci);
1407 ti = dm_table_find_target(ci->map, ci->sector);
1408 if (!dm_target_is_valid(ti))
1411 len = min_t(sector_t, max_io_len(ci->sector, ti), ci->sector_count);
1413 __clone_and_map_data_bio(ci, ti, ci->sector, &len);
1416 ci->sector_count -= len;
1422 * Entry point to split a bio into clones and submit them to the targets.
1424 static void __split_and_process_bio(struct mapped_device *md,
1425 struct dm_table *map, struct bio *bio)
1427 struct clone_info ci;
1430 if (unlikely(!map)) {
1437 ci.io = alloc_io(md);
1439 atomic_set(&ci.io->io_count, 1);
1442 spin_lock_init(&ci.io->endio_lock);
1443 ci.sector = bio->bi_iter.bi_sector;
1445 start_io_acct(ci.io);
1447 if (bio->bi_rw & REQ_FLUSH) {
1448 ci.bio = &ci.md->flush_bio;
1449 ci.sector_count = 0;
1450 error = __send_empty_flush(&ci);
1451 /* dec_pending submits any data associated with flush */
1454 ci.sector_count = bio_sectors(bio);
1455 while (ci.sector_count && !error)
1456 error = __split_and_process_non_flush(&ci);
1459 /* drop the extra reference count */
1460 dec_pending(ci.io, error);
1462 /*-----------------------------------------------------------------
1464 *---------------------------------------------------------------*/
1466 static int dm_merge_bvec(struct request_queue *q,
1467 struct bvec_merge_data *bvm,
1468 struct bio_vec *biovec)
1470 struct mapped_device *md = q->queuedata;
1471 struct dm_table *map = dm_get_live_table_fast(md);
1472 struct dm_target *ti;
1473 sector_t max_sectors;
1479 ti = dm_table_find_target(map, bvm->bi_sector);
1480 if (!dm_target_is_valid(ti))
1484 * Find maximum amount of I/O that won't need splitting
1486 max_sectors = min(max_io_len(bvm->bi_sector, ti),
1487 (sector_t) BIO_MAX_SECTORS);
1488 max_size = (max_sectors << SECTOR_SHIFT) - bvm->bi_size;
1493 * merge_bvec_fn() returns number of bytes
1494 * it can accept at this offset
1495 * max is precomputed maximal io size
1497 if (max_size && ti->type->merge)
1498 max_size = ti->type->merge(ti, bvm, biovec, max_size);
1500 * If the target doesn't support merge method and some of the devices
1501 * provided their merge_bvec method (we know this by looking at
1502 * queue_max_hw_sectors), then we can't allow bios with multiple vector
1503 * entries. So always set max_size to 0, and the code below allows
1506 else if (queue_max_hw_sectors(q) <= PAGE_SIZE >> 9)
1510 dm_put_live_table_fast(md);
1512 * Always allow an entire first page
1514 if (max_size <= biovec->bv_len && !(bvm->bi_size >> SECTOR_SHIFT))
1515 max_size = biovec->bv_len;
1521 * The request function that just remaps the bio built up by
1524 static void _dm_request(struct request_queue *q, struct bio *bio)
1526 int rw = bio_data_dir(bio);
1527 struct mapped_device *md = q->queuedata;
1530 struct dm_table *map;
1532 map = dm_get_live_table(md, &srcu_idx);
1534 cpu = part_stat_lock();
1535 part_stat_inc(cpu, &dm_disk(md)->part0, ios[rw]);
1536 part_stat_add(cpu, &dm_disk(md)->part0, sectors[rw], bio_sectors(bio));
1539 /* if we're suspended, we have to queue this io for later */
1540 if (unlikely(test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags))) {
1541 dm_put_live_table(md, srcu_idx);
1543 if (bio_rw(bio) != READA)
1550 __split_and_process_bio(md, map, bio);
1551 dm_put_live_table(md, srcu_idx);
1555 int dm_request_based(struct mapped_device *md)
1557 return blk_queue_stackable(md->queue);
1560 static void dm_request(struct request_queue *q, struct bio *bio)
1562 struct mapped_device *md = q->queuedata;
1564 if (dm_request_based(md))
1565 blk_queue_bio(q, bio);
1567 _dm_request(q, bio);
1570 void dm_dispatch_request(struct request *rq)
1574 if (blk_queue_io_stat(rq->q))
1575 rq->cmd_flags |= REQ_IO_STAT;
1577 rq->start_time = jiffies;
1578 r = blk_insert_cloned_request(rq->q, rq);
1580 dm_complete_request(rq, r);
1582 EXPORT_SYMBOL_GPL(dm_dispatch_request);
1584 static int dm_rq_bio_constructor(struct bio *bio, struct bio *bio_orig,
1587 struct dm_rq_target_io *tio = data;
1588 struct dm_rq_clone_bio_info *info =
1589 container_of(bio, struct dm_rq_clone_bio_info, clone);
1591 info->orig = bio_orig;
1593 bio->bi_end_io = end_clone_bio;
1598 static int setup_clone(struct request *clone, struct request *rq,
1599 struct dm_rq_target_io *tio)
1603 r = blk_rq_prep_clone(clone, rq, tio->md->bs, GFP_ATOMIC,
1604 dm_rq_bio_constructor, tio);
1608 clone->cmd = rq->cmd;
1609 clone->cmd_len = rq->cmd_len;
1610 clone->sense = rq->sense;
1611 clone->end_io = end_clone_request;
1612 clone->end_io_data = tio;
1617 static struct request *clone_rq(struct request *rq, struct mapped_device *md,
1620 struct request *clone;
1621 struct dm_rq_target_io *tio;
1623 tio = alloc_rq_tio(md, gfp_mask);
1631 memset(&tio->info, 0, sizeof(tio->info));
1633 clone = &tio->clone;
1634 if (setup_clone(clone, rq, tio)) {
1644 * Called with the queue lock held.
1646 static int dm_prep_fn(struct request_queue *q, struct request *rq)
1648 struct mapped_device *md = q->queuedata;
1649 struct request *clone;
1651 if (unlikely(rq->special)) {
1652 DMWARN("Already has something in rq->special.");
1653 return BLKPREP_KILL;
1656 clone = clone_rq(rq, md, GFP_ATOMIC);
1658 return BLKPREP_DEFER;
1660 rq->special = clone;
1661 rq->cmd_flags |= REQ_DONTPREP;
1668 * 0 : the request has been processed (not requeued)
1669 * !0 : the request has been requeued
1671 static int map_request(struct dm_target *ti, struct request *clone,
1672 struct mapped_device *md)
1674 int r, requeued = 0;
1675 struct dm_rq_target_io *tio = clone->end_io_data;
1678 r = ti->type->map_rq(ti, clone, &tio->info);
1680 case DM_MAPIO_SUBMITTED:
1681 /* The target has taken the I/O to submit by itself later */
1683 case DM_MAPIO_REMAPPED:
1684 /* The target has remapped the I/O so dispatch it */
1685 trace_block_rq_remap(clone->q, clone, disk_devt(dm_disk(md)),
1686 blk_rq_pos(tio->orig));
1687 dm_dispatch_request(clone);
1689 case DM_MAPIO_REQUEUE:
1690 /* The target wants to requeue the I/O */
1691 dm_requeue_unmapped_request(clone);
1696 DMWARN("unimplemented target map return value: %d", r);
1700 /* The target wants to complete the I/O */
1701 dm_kill_unmapped_request(clone, r);
1708 static struct request *dm_start_request(struct mapped_device *md, struct request *orig)
1710 struct request *clone;
1712 blk_start_request(orig);
1713 clone = orig->special;
1714 atomic_inc(&md->pending[rq_data_dir(clone)]);
1717 * Hold the md reference here for the in-flight I/O.
1718 * We can't rely on the reference count by device opener,
1719 * because the device may be closed during the request completion
1720 * when all bios are completed.
1721 * See the comment in rq_completed() too.
1729 * q->request_fn for request-based dm.
1730 * Called with the queue lock held.
1732 static void dm_request_fn(struct request_queue *q)
1734 struct mapped_device *md = q->queuedata;
1736 struct dm_table *map = dm_get_live_table(md, &srcu_idx);
1737 struct dm_target *ti;
1738 struct request *rq, *clone;
1742 * For suspend, check blk_queue_stopped() and increment
1743 * ->pending within a single queue_lock not to increment the
1744 * number of in-flight I/Os after the queue is stopped in
1747 while (!blk_queue_stopped(q)) {
1748 rq = blk_peek_request(q);
1752 /* always use block 0 to find the target for flushes for now */
1754 if (!(rq->cmd_flags & REQ_FLUSH))
1755 pos = blk_rq_pos(rq);
1757 ti = dm_table_find_target(map, pos);
1758 if (!dm_target_is_valid(ti)) {
1760 * Must perform setup, that dm_done() requires,
1761 * before calling dm_kill_unmapped_request
1763 DMERR_LIMIT("request attempted access beyond the end of device");
1764 clone = dm_start_request(md, rq);
1765 dm_kill_unmapped_request(clone, -EIO);
1769 if (ti->type->busy && ti->type->busy(ti))
1772 clone = dm_start_request(md, rq);
1774 spin_unlock(q->queue_lock);
1775 if (map_request(ti, clone, md))
1778 BUG_ON(!irqs_disabled());
1779 spin_lock(q->queue_lock);
1785 BUG_ON(!irqs_disabled());
1786 spin_lock(q->queue_lock);
1789 blk_delay_queue(q, HZ / 10);
1791 dm_put_live_table(md, srcu_idx);
1794 int dm_underlying_device_busy(struct request_queue *q)
1796 return blk_lld_busy(q);
1798 EXPORT_SYMBOL_GPL(dm_underlying_device_busy);
1800 static int dm_lld_busy(struct request_queue *q)
1803 struct mapped_device *md = q->queuedata;
1804 struct dm_table *map = dm_get_live_table_fast(md);
1806 if (!map || test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags))
1809 r = dm_table_any_busy_target(map);
1811 dm_put_live_table_fast(md);
1816 static int dm_any_congested(void *congested_data, int bdi_bits)
1819 struct mapped_device *md = congested_data;
1820 struct dm_table *map;
1822 if (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
1823 map = dm_get_live_table_fast(md);
1826 * Request-based dm cares about only own queue for
1827 * the query about congestion status of request_queue
1829 if (dm_request_based(md))
1830 r = md->queue->backing_dev_info.state &
1833 r = dm_table_any_congested(map, bdi_bits);
1835 dm_put_live_table_fast(md);
1841 /*-----------------------------------------------------------------
1842 * An IDR is used to keep track of allocated minor numbers.
1843 *---------------------------------------------------------------*/
1844 static void free_minor(int minor)
1846 spin_lock(&_minor_lock);
1847 idr_remove(&_minor_idr, minor);
1848 spin_unlock(&_minor_lock);
1852 * See if the device with a specific minor # is free.
1854 static int specific_minor(int minor)
1858 if (minor >= (1 << MINORBITS))
1861 idr_preload(GFP_KERNEL);
1862 spin_lock(&_minor_lock);
1864 r = idr_alloc(&_minor_idr, MINOR_ALLOCED, minor, minor + 1, GFP_NOWAIT);
1866 spin_unlock(&_minor_lock);
1869 return r == -ENOSPC ? -EBUSY : r;
1873 static int next_free_minor(int *minor)
1877 idr_preload(GFP_KERNEL);
1878 spin_lock(&_minor_lock);
1880 r = idr_alloc(&_minor_idr, MINOR_ALLOCED, 0, 1 << MINORBITS, GFP_NOWAIT);
1882 spin_unlock(&_minor_lock);
1890 static const struct block_device_operations dm_blk_dops;
1892 static void dm_wq_work(struct work_struct *work);
1894 static void dm_init_md_queue(struct mapped_device *md)
1897 * Request-based dm devices cannot be stacked on top of bio-based dm
1898 * devices. The type of this dm device has not been decided yet.
1899 * The type is decided at the first table loading time.
1900 * To prevent problematic device stacking, clear the queue flag
1901 * for request stacking support until then.
1903 * This queue is new, so no concurrency on the queue_flags.
1905 queue_flag_clear_unlocked(QUEUE_FLAG_STACKABLE, md->queue);
1907 md->queue->queuedata = md;
1908 md->queue->backing_dev_info.congested_fn = dm_any_congested;
1909 md->queue->backing_dev_info.congested_data = md;
1910 blk_queue_make_request(md->queue, dm_request);
1911 blk_queue_bounce_limit(md->queue, BLK_BOUNCE_ANY);
1912 blk_queue_merge_bvec(md->queue, dm_merge_bvec);
1916 * Allocate and initialise a blank device with a given minor.
1918 static struct mapped_device *alloc_dev(int minor)
1921 struct mapped_device *md = kzalloc(sizeof(*md), GFP_KERNEL);
1925 DMWARN("unable to allocate device, out of memory.");
1929 if (!try_module_get(THIS_MODULE))
1930 goto bad_module_get;
1932 /* get a minor number for the dev */
1933 if (minor == DM_ANY_MINOR)
1934 r = next_free_minor(&minor);
1936 r = specific_minor(minor);
1940 r = init_srcu_struct(&md->io_barrier);
1942 goto bad_io_barrier;
1944 md->type = DM_TYPE_NONE;
1945 mutex_init(&md->suspend_lock);
1946 mutex_init(&md->type_lock);
1947 spin_lock_init(&md->deferred_lock);
1948 atomic_set(&md->holders, 1);
1949 atomic_set(&md->open_count, 0);
1950 atomic_set(&md->event_nr, 0);
1951 atomic_set(&md->uevent_seq, 0);
1952 INIT_LIST_HEAD(&md->uevent_list);
1953 spin_lock_init(&md->uevent_lock);
1955 md->queue = blk_alloc_queue(GFP_KERNEL);
1959 dm_init_md_queue(md);
1961 md->disk = alloc_disk(1);
1965 atomic_set(&md->pending[0], 0);
1966 atomic_set(&md->pending[1], 0);
1967 init_waitqueue_head(&md->wait);
1968 INIT_WORK(&md->work, dm_wq_work);
1969 init_waitqueue_head(&md->eventq);
1970 init_completion(&md->kobj_holder.completion);
1972 md->disk->major = _major;
1973 md->disk->first_minor = minor;
1974 md->disk->fops = &dm_blk_dops;
1975 md->disk->queue = md->queue;
1976 md->disk->private_data = md;
1977 sprintf(md->disk->disk_name, "dm-%d", minor);
1979 format_dev_t(md->name, MKDEV(_major, minor));
1981 md->wq = alloc_workqueue("kdmflush", WQ_MEM_RECLAIM, 0);
1985 md->bdev = bdget_disk(md->disk, 0);
1989 bio_init(&md->flush_bio);
1990 md->flush_bio.bi_bdev = md->bdev;
1991 md->flush_bio.bi_rw = WRITE_FLUSH;
1993 dm_stats_init(&md->stats);
1995 /* Populate the mapping, nobody knows we exist yet */
1996 spin_lock(&_minor_lock);
1997 old_md = idr_replace(&_minor_idr, md, minor);
1998 spin_unlock(&_minor_lock);
2000 BUG_ON(old_md != MINOR_ALLOCED);
2005 destroy_workqueue(md->wq);
2007 del_gendisk(md->disk);
2010 blk_cleanup_queue(md->queue);
2012 cleanup_srcu_struct(&md->io_barrier);
2016 module_put(THIS_MODULE);
2022 static void unlock_fs(struct mapped_device *md);
2024 static void free_dev(struct mapped_device *md)
2026 int minor = MINOR(disk_devt(md->disk));
2030 destroy_workqueue(md->wq);
2032 mempool_destroy(md->io_pool);
2034 bioset_free(md->bs);
2035 blk_integrity_unregister(md->disk);
2036 del_gendisk(md->disk);
2037 cleanup_srcu_struct(&md->io_barrier);
2040 spin_lock(&_minor_lock);
2041 md->disk->private_data = NULL;
2042 spin_unlock(&_minor_lock);
2045 blk_cleanup_queue(md->queue);
2046 dm_stats_cleanup(&md->stats);
2047 module_put(THIS_MODULE);
2051 static void __bind_mempools(struct mapped_device *md, struct dm_table *t)
2053 struct dm_md_mempools *p = dm_table_get_md_mempools(t);
2055 if (md->io_pool && md->bs) {
2056 /* The md already has necessary mempools. */
2057 if (dm_table_get_type(t) == DM_TYPE_BIO_BASED) {
2059 * Reload bioset because front_pad may have changed
2060 * because a different table was loaded.
2062 bioset_free(md->bs);
2065 } else if (dm_table_get_type(t) == DM_TYPE_REQUEST_BASED) {
2067 * There's no need to reload with request-based dm
2068 * because the size of front_pad doesn't change.
2069 * Note for future: If you are to reload bioset,
2070 * prep-ed requests in the queue may refer
2071 * to bio from the old bioset, so you must walk
2072 * through the queue to unprep.
2078 BUG_ON(!p || md->io_pool || md->bs);
2080 md->io_pool = p->io_pool;
2086 /* mempool bind completed, now no need any mempools in the table */
2087 dm_table_free_md_mempools(t);
2091 * Bind a table to the device.
2093 static void event_callback(void *context)
2095 unsigned long flags;
2097 struct mapped_device *md = (struct mapped_device *) context;
2099 spin_lock_irqsave(&md->uevent_lock, flags);
2100 list_splice_init(&md->uevent_list, &uevents);
2101 spin_unlock_irqrestore(&md->uevent_lock, flags);
2103 dm_send_uevents(&uevents, &disk_to_dev(md->disk)->kobj);
2105 atomic_inc(&md->event_nr);
2106 wake_up(&md->eventq);
2110 * Protected by md->suspend_lock obtained by dm_swap_table().
2112 static void __set_size(struct mapped_device *md, sector_t size)
2114 set_capacity(md->disk, size);
2116 i_size_write(md->bdev->bd_inode, (loff_t)size << SECTOR_SHIFT);
2120 * Return 1 if the queue has a compulsory merge_bvec_fn function.
2122 * If this function returns 0, then the device is either a non-dm
2123 * device without a merge_bvec_fn, or it is a dm device that is
2124 * able to split any bios it receives that are too big.
2126 int dm_queue_merge_is_compulsory(struct request_queue *q)
2128 struct mapped_device *dev_md;
2130 if (!q->merge_bvec_fn)
2133 if (q->make_request_fn == dm_request) {
2134 dev_md = q->queuedata;
2135 if (test_bit(DMF_MERGE_IS_OPTIONAL, &dev_md->flags))
2142 static int dm_device_merge_is_compulsory(struct dm_target *ti,
2143 struct dm_dev *dev, sector_t start,
2144 sector_t len, void *data)
2146 struct block_device *bdev = dev->bdev;
2147 struct request_queue *q = bdev_get_queue(bdev);
2149 return dm_queue_merge_is_compulsory(q);
2153 * Return 1 if it is acceptable to ignore merge_bvec_fn based
2154 * on the properties of the underlying devices.
2156 static int dm_table_merge_is_optional(struct dm_table *table)
2159 struct dm_target *ti;
2161 while (i < dm_table_get_num_targets(table)) {
2162 ti = dm_table_get_target(table, i++);
2164 if (ti->type->iterate_devices &&
2165 ti->type->iterate_devices(ti, dm_device_merge_is_compulsory, NULL))
2173 * Returns old map, which caller must destroy.
2175 static struct dm_table *__bind(struct mapped_device *md, struct dm_table *t,
2176 struct queue_limits *limits)
2178 struct dm_table *old_map;
2179 struct request_queue *q = md->queue;
2181 int merge_is_optional;
2183 size = dm_table_get_size(t);
2186 * Wipe any geometry if the size of the table changed.
2188 if (size != dm_get_size(md))
2189 memset(&md->geometry, 0, sizeof(md->geometry));
2191 __set_size(md, size);
2193 dm_table_event_callback(t, event_callback, md);
2196 * The queue hasn't been stopped yet, if the old table type wasn't
2197 * for request-based during suspension. So stop it to prevent
2198 * I/O mapping before resume.
2199 * This must be done before setting the queue restrictions,
2200 * because request-based dm may be run just after the setting.
2202 if (dm_table_request_based(t) && !blk_queue_stopped(q))
2205 __bind_mempools(md, t);
2207 merge_is_optional = dm_table_merge_is_optional(t);
2210 rcu_assign_pointer(md->map, t);
2211 md->immutable_target_type = dm_table_get_immutable_target_type(t);
2213 dm_table_set_restrictions(t, q, limits);
2214 if (merge_is_optional)
2215 set_bit(DMF_MERGE_IS_OPTIONAL, &md->flags);
2217 clear_bit(DMF_MERGE_IS_OPTIONAL, &md->flags);
2224 * Returns unbound table for the caller to free.
2226 static struct dm_table *__unbind(struct mapped_device *md)
2228 struct dm_table *map = md->map;
2233 dm_table_event_callback(map, NULL, NULL);
2234 RCU_INIT_POINTER(md->map, NULL);
2241 * Constructor for a new device.
2243 int dm_create(int minor, struct mapped_device **result)
2245 struct mapped_device *md;
2247 md = alloc_dev(minor);
2258 * Functions to manage md->type.
2259 * All are required to hold md->type_lock.
2261 void dm_lock_md_type(struct mapped_device *md)
2263 mutex_lock(&md->type_lock);
2266 void dm_unlock_md_type(struct mapped_device *md)
2268 mutex_unlock(&md->type_lock);
2271 void dm_set_md_type(struct mapped_device *md, unsigned type)
2273 BUG_ON(!mutex_is_locked(&md->type_lock));
2277 unsigned dm_get_md_type(struct mapped_device *md)
2279 BUG_ON(!mutex_is_locked(&md->type_lock));
2283 struct target_type *dm_get_immutable_target_type(struct mapped_device *md)
2285 return md->immutable_target_type;
2289 * The queue_limits are only valid as long as you have a reference
2292 struct queue_limits *dm_get_queue_limits(struct mapped_device *md)
2294 BUG_ON(!atomic_read(&md->holders));
2295 return &md->queue->limits;
2297 EXPORT_SYMBOL_GPL(dm_get_queue_limits);
2300 * Fully initialize a request-based queue (->elevator, ->request_fn, etc).
2302 static int dm_init_request_based_queue(struct mapped_device *md)
2304 struct request_queue *q = NULL;
2306 if (md->queue->elevator)
2309 /* Fully initialize the queue */
2310 q = blk_init_allocated_queue(md->queue, dm_request_fn, NULL);
2315 dm_init_md_queue(md);
2316 blk_queue_softirq_done(md->queue, dm_softirq_done);
2317 blk_queue_prep_rq(md->queue, dm_prep_fn);
2318 blk_queue_lld_busy(md->queue, dm_lld_busy);
2320 elv_register_queue(md->queue);
2326 * Setup the DM device's queue based on md's type
2328 int dm_setup_md_queue(struct mapped_device *md)
2330 if ((dm_get_md_type(md) == DM_TYPE_REQUEST_BASED) &&
2331 !dm_init_request_based_queue(md)) {
2332 DMWARN("Cannot initialize queue for request-based mapped device");
2339 static struct mapped_device *dm_find_md(dev_t dev)
2341 struct mapped_device *md;
2342 unsigned minor = MINOR(dev);
2344 if (MAJOR(dev) != _major || minor >= (1 << MINORBITS))
2347 spin_lock(&_minor_lock);
2349 md = idr_find(&_minor_idr, minor);
2350 if (md && (md == MINOR_ALLOCED ||
2351 (MINOR(disk_devt(dm_disk(md))) != minor) ||
2352 dm_deleting_md(md) ||
2353 test_bit(DMF_FREEING, &md->flags))) {
2359 spin_unlock(&_minor_lock);
2364 struct mapped_device *dm_get_md(dev_t dev)
2366 struct mapped_device *md = dm_find_md(dev);
2373 EXPORT_SYMBOL_GPL(dm_get_md);
2375 void *dm_get_mdptr(struct mapped_device *md)
2377 return md->interface_ptr;
2380 void dm_set_mdptr(struct mapped_device *md, void *ptr)
2382 md->interface_ptr = ptr;
2385 void dm_get(struct mapped_device *md)
2387 atomic_inc(&md->holders);
2388 BUG_ON(test_bit(DMF_FREEING, &md->flags));
2391 const char *dm_device_name(struct mapped_device *md)
2395 EXPORT_SYMBOL_GPL(dm_device_name);
2397 static void __dm_destroy(struct mapped_device *md, bool wait)
2399 struct dm_table *map;
2404 spin_lock(&_minor_lock);
2405 map = dm_get_live_table(md, &srcu_idx);
2406 idr_replace(&_minor_idr, MINOR_ALLOCED, MINOR(disk_devt(dm_disk(md))));
2407 set_bit(DMF_FREEING, &md->flags);
2408 spin_unlock(&_minor_lock);
2410 if (!dm_suspended_md(md)) {
2411 dm_table_presuspend_targets(map);
2412 dm_table_postsuspend_targets(map);
2415 /* dm_put_live_table must be before msleep, otherwise deadlock is possible */
2416 dm_put_live_table(md, srcu_idx);
2419 * Rare, but there may be I/O requests still going to complete,
2420 * for example. Wait for all references to disappear.
2421 * No one should increment the reference count of the mapped_device,
2422 * after the mapped_device state becomes DMF_FREEING.
2425 while (atomic_read(&md->holders))
2427 else if (atomic_read(&md->holders))
2428 DMWARN("%s: Forcibly removing mapped_device still in use! (%d users)",
2429 dm_device_name(md), atomic_read(&md->holders));
2432 dm_table_destroy(__unbind(md));
2436 void dm_destroy(struct mapped_device *md)
2438 __dm_destroy(md, true);
2441 void dm_destroy_immediate(struct mapped_device *md)
2443 __dm_destroy(md, false);
2446 void dm_put(struct mapped_device *md)
2448 atomic_dec(&md->holders);
2450 EXPORT_SYMBOL_GPL(dm_put);
2452 static int dm_wait_for_completion(struct mapped_device *md, int interruptible)
2455 DECLARE_WAITQUEUE(wait, current);
2457 add_wait_queue(&md->wait, &wait);
2460 set_current_state(interruptible);
2462 if (!md_in_flight(md))
2465 if (interruptible == TASK_INTERRUPTIBLE &&
2466 signal_pending(current)) {
2473 set_current_state(TASK_RUNNING);
2475 remove_wait_queue(&md->wait, &wait);
2481 * Process the deferred bios
2483 static void dm_wq_work(struct work_struct *work)
2485 struct mapped_device *md = container_of(work, struct mapped_device,
2489 struct dm_table *map;
2491 map = dm_get_live_table(md, &srcu_idx);
2493 while (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
2494 spin_lock_irq(&md->deferred_lock);
2495 c = bio_list_pop(&md->deferred);
2496 spin_unlock_irq(&md->deferred_lock);
2501 if (dm_request_based(md))
2502 generic_make_request(c);
2504 __split_and_process_bio(md, map, c);
2507 dm_put_live_table(md, srcu_idx);
2510 static void dm_queue_flush(struct mapped_device *md)
2512 clear_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
2513 smp_mb__after_atomic();
2514 queue_work(md->wq, &md->work);
2518 * Swap in a new table, returning the old one for the caller to destroy.
2520 struct dm_table *dm_swap_table(struct mapped_device *md, struct dm_table *table)
2522 struct dm_table *live_map = NULL, *map = ERR_PTR(-EINVAL);
2523 struct queue_limits limits;
2526 mutex_lock(&md->suspend_lock);
2528 /* device must be suspended */
2529 if (!dm_suspended_md(md))
2533 * If the new table has no data devices, retain the existing limits.
2534 * This helps multipath with queue_if_no_path if all paths disappear,
2535 * then new I/O is queued based on these limits, and then some paths
2538 if (dm_table_has_no_data_devices(table)) {
2539 live_map = dm_get_live_table_fast(md);
2541 limits = md->queue->limits;
2542 dm_put_live_table_fast(md);
2546 r = dm_calculate_queue_limits(table, &limits);
2553 map = __bind(md, table, &limits);
2556 mutex_unlock(&md->suspend_lock);
2561 * Functions to lock and unlock any filesystem running on the
2564 static int lock_fs(struct mapped_device *md)
2568 WARN_ON(md->frozen_sb);
2570 md->frozen_sb = freeze_bdev(md->bdev);
2571 if (IS_ERR(md->frozen_sb)) {
2572 r = PTR_ERR(md->frozen_sb);
2573 md->frozen_sb = NULL;
2577 set_bit(DMF_FROZEN, &md->flags);
2582 static void unlock_fs(struct mapped_device *md)
2584 if (!test_bit(DMF_FROZEN, &md->flags))
2587 thaw_bdev(md->bdev, md->frozen_sb);
2588 md->frozen_sb = NULL;
2589 clear_bit(DMF_FROZEN, &md->flags);
2593 * We need to be able to change a mapping table under a mounted
2594 * filesystem. For example we might want to move some data in
2595 * the background. Before the table can be swapped with
2596 * dm_bind_table, dm_suspend must be called to flush any in
2597 * flight bios and ensure that any further io gets deferred.
2600 * Suspend mechanism in request-based dm.
2602 * 1. Flush all I/Os by lock_fs() if needed.
2603 * 2. Stop dispatching any I/O by stopping the request_queue.
2604 * 3. Wait for all in-flight I/Os to be completed or requeued.
2606 * To abort suspend, start the request_queue.
2608 int dm_suspend(struct mapped_device *md, unsigned suspend_flags)
2610 struct dm_table *map = NULL;
2612 int do_lockfs = suspend_flags & DM_SUSPEND_LOCKFS_FLAG ? 1 : 0;
2613 int noflush = suspend_flags & DM_SUSPEND_NOFLUSH_FLAG ? 1 : 0;
2615 mutex_lock(&md->suspend_lock);
2617 if (dm_suspended_md(md)) {
2625 * DMF_NOFLUSH_SUSPENDING must be set before presuspend.
2626 * This flag is cleared before dm_suspend returns.
2629 set_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
2631 /* This does not get reverted if there's an error later. */
2632 dm_table_presuspend_targets(map);
2635 * Flush I/O to the device.
2636 * Any I/O submitted after lock_fs() may not be flushed.
2637 * noflush takes precedence over do_lockfs.
2638 * (lock_fs() flushes I/Os and waits for them to complete.)
2640 if (!noflush && do_lockfs) {
2647 * Here we must make sure that no processes are submitting requests
2648 * to target drivers i.e. no one may be executing
2649 * __split_and_process_bio. This is called from dm_request and
2652 * To get all processes out of __split_and_process_bio in dm_request,
2653 * we take the write lock. To prevent any process from reentering
2654 * __split_and_process_bio from dm_request and quiesce the thread
2655 * (dm_wq_work), we set BMF_BLOCK_IO_FOR_SUSPEND and call
2656 * flush_workqueue(md->wq).
2658 set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
2659 synchronize_srcu(&md->io_barrier);
2662 * Stop md->queue before flushing md->wq in case request-based
2663 * dm defers requests to md->wq from md->queue.
2665 if (dm_request_based(md))
2666 stop_queue(md->queue);
2668 flush_workqueue(md->wq);
2671 * At this point no more requests are entering target request routines.
2672 * We call dm_wait_for_completion to wait for all existing requests
2675 r = dm_wait_for_completion(md, TASK_INTERRUPTIBLE);
2678 clear_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
2679 synchronize_srcu(&md->io_barrier);
2681 /* were we interrupted ? */
2685 if (dm_request_based(md))
2686 start_queue(md->queue);
2689 goto out_unlock; /* pushback list is already flushed, so skip flush */
2693 * If dm_wait_for_completion returned 0, the device is completely
2694 * quiescent now. There is no request-processing activity. All new
2695 * requests are being added to md->deferred list.
2698 set_bit(DMF_SUSPENDED, &md->flags);
2700 dm_table_postsuspend_targets(map);
2703 mutex_unlock(&md->suspend_lock);
2707 int dm_resume(struct mapped_device *md)
2710 struct dm_table *map = NULL;
2712 mutex_lock(&md->suspend_lock);
2713 if (!dm_suspended_md(md))
2717 if (!map || !dm_table_get_size(map))
2720 r = dm_table_resume_targets(map);
2727 * Flushing deferred I/Os must be done after targets are resumed
2728 * so that mapping of targets can work correctly.
2729 * Request-based dm is queueing the deferred I/Os in its request_queue.
2731 if (dm_request_based(md))
2732 start_queue(md->queue);
2736 clear_bit(DMF_SUSPENDED, &md->flags);
2740 mutex_unlock(&md->suspend_lock);
2746 * Internal suspend/resume works like userspace-driven suspend. It waits
2747 * until all bios finish and prevents issuing new bios to the target drivers.
2748 * It may be used only from the kernel.
2750 * Internal suspend holds md->suspend_lock, which prevents interaction with
2751 * userspace-driven suspend.
2754 void dm_internal_suspend(struct mapped_device *md)
2756 mutex_lock(&md->suspend_lock);
2757 if (dm_suspended_md(md))
2760 set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
2761 synchronize_srcu(&md->io_barrier);
2762 flush_workqueue(md->wq);
2763 dm_wait_for_completion(md, TASK_UNINTERRUPTIBLE);
2766 void dm_internal_resume(struct mapped_device *md)
2768 if (dm_suspended_md(md))
2774 mutex_unlock(&md->suspend_lock);
2777 /*-----------------------------------------------------------------
2778 * Event notification.
2779 *---------------------------------------------------------------*/
2780 int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
2783 char udev_cookie[DM_COOKIE_LENGTH];
2784 char *envp[] = { udev_cookie, NULL };
2787 return kobject_uevent(&disk_to_dev(md->disk)->kobj, action);
2789 snprintf(udev_cookie, DM_COOKIE_LENGTH, "%s=%u",
2790 DM_COOKIE_ENV_VAR_NAME, cookie);
2791 return kobject_uevent_env(&disk_to_dev(md->disk)->kobj,
2796 uint32_t dm_next_uevent_seq(struct mapped_device *md)
2798 return atomic_add_return(1, &md->uevent_seq);
2801 uint32_t dm_get_event_nr(struct mapped_device *md)
2803 return atomic_read(&md->event_nr);
2806 int dm_wait_event(struct mapped_device *md, int event_nr)
2808 return wait_event_interruptible(md->eventq,
2809 (event_nr != atomic_read(&md->event_nr)));
2812 void dm_uevent_add(struct mapped_device *md, struct list_head *elist)
2814 unsigned long flags;
2816 spin_lock_irqsave(&md->uevent_lock, flags);
2817 list_add(elist, &md->uevent_list);
2818 spin_unlock_irqrestore(&md->uevent_lock, flags);
2822 * The gendisk is only valid as long as you have a reference
2825 struct gendisk *dm_disk(struct mapped_device *md)
2830 struct kobject *dm_kobject(struct mapped_device *md)
2832 return &md->kobj_holder.kobj;
2835 struct mapped_device *dm_get_from_kobject(struct kobject *kobj)
2837 struct mapped_device *md;
2839 md = container_of(kobj, struct mapped_device, kobj_holder.kobj);
2841 if (test_bit(DMF_FREEING, &md->flags) ||
2849 int dm_suspended_md(struct mapped_device *md)
2851 return test_bit(DMF_SUSPENDED, &md->flags);
2854 int dm_test_deferred_remove_flag(struct mapped_device *md)
2856 return test_bit(DMF_DEFERRED_REMOVE, &md->flags);
2859 int dm_suspended(struct dm_target *ti)
2861 return dm_suspended_md(dm_table_get_md(ti->table));
2863 EXPORT_SYMBOL_GPL(dm_suspended);
2865 int dm_noflush_suspending(struct dm_target *ti)
2867 return __noflush_suspending(dm_table_get_md(ti->table));
2869 EXPORT_SYMBOL_GPL(dm_noflush_suspending);
2871 struct dm_md_mempools *dm_alloc_md_mempools(unsigned type, unsigned integrity, unsigned per_bio_data_size)
2873 struct dm_md_mempools *pools = kzalloc(sizeof(*pools), GFP_KERNEL);
2874 struct kmem_cache *cachep;
2875 unsigned int pool_size;
2876 unsigned int front_pad;
2881 if (type == DM_TYPE_BIO_BASED) {
2883 pool_size = dm_get_reserved_bio_based_ios();
2884 front_pad = roundup(per_bio_data_size, __alignof__(struct dm_target_io)) + offsetof(struct dm_target_io, clone);
2885 } else if (type == DM_TYPE_REQUEST_BASED) {
2886 cachep = _rq_tio_cache;
2887 pool_size = dm_get_reserved_rq_based_ios();
2888 front_pad = offsetof(struct dm_rq_clone_bio_info, clone);
2889 /* per_bio_data_size is not used. See __bind_mempools(). */
2890 WARN_ON(per_bio_data_size != 0);
2894 pools->io_pool = mempool_create_slab_pool(pool_size, cachep);
2895 if (!pools->io_pool)
2898 pools->bs = bioset_create_nobvec(pool_size, front_pad);
2902 if (integrity && bioset_integrity_create(pools->bs, pool_size))
2908 dm_free_md_mempools(pools);
2913 void dm_free_md_mempools(struct dm_md_mempools *pools)
2919 mempool_destroy(pools->io_pool);
2922 bioset_free(pools->bs);
2927 static const struct block_device_operations dm_blk_dops = {
2928 .open = dm_blk_open,
2929 .release = dm_blk_close,
2930 .ioctl = dm_blk_ioctl,
2931 .getgeo = dm_blk_getgeo,
2932 .owner = THIS_MODULE
2938 module_init(dm_init);
2939 module_exit(dm_exit);
2941 module_param(major, uint, 0);
2942 MODULE_PARM_DESC(major, "The major number of the device mapper");
2944 module_param(reserved_bio_based_ios, uint, S_IRUGO | S_IWUSR);
2945 MODULE_PARM_DESC(reserved_bio_based_ios, "Reserved IOs in bio-based mempools");
2947 module_param(reserved_rq_based_ios, uint, S_IRUGO | S_IWUSR);
2948 MODULE_PARM_DESC(reserved_rq_based_ios, "Reserved IOs in request-based mempools");
2950 MODULE_DESCRIPTION(DM_NAME " driver");
2951 MODULE_AUTHOR("Joe Thornber <dm-devel@redhat.com>");
2952 MODULE_LICENSE("GPL");