Merge remote-tracking branch 'jens/for-4.2/core' into dm-4.2
[deliverable/linux.git] / drivers / md / dm.c
CommitLineData
1da177e4
LT
1/*
2 * Copyright (C) 2001, 2002 Sistina Software (UK) Limited.
784aae73 3 * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved.
1da177e4
LT
4 *
5 * This file is released under the GPL.
6 */
7
8#include "dm.h"
51e5b2bd 9#include "dm-uevent.h"
1da177e4
LT
10
11#include <linux/init.h>
12#include <linux/module.h>
48c9c27b 13#include <linux/mutex.h>
1da177e4
LT
14#include <linux/moduleparam.h>
15#include <linux/blkpg.h>
16#include <linux/bio.h>
1da177e4
LT
17#include <linux/mempool.h>
18#include <linux/slab.h>
19#include <linux/idr.h>
3ac51e74 20#include <linux/hdreg.h>
3f77316d 21#include <linux/delay.h>
ffcc3936 22#include <linux/wait.h>
2eb6e1e3 23#include <linux/kthread.h>
0ce65797 24#include <linux/ktime.h>
de3ec86d 25#include <linux/elevator.h> /* for rq_end_sector() */
bfebd1cd 26#include <linux/blk-mq.h>
55782138
LZ
27
28#include <trace/events/block.h>
1da177e4 29
72d94861
AK
30#define DM_MSG_PREFIX "core"
31
71a16736
NK
32#ifdef CONFIG_PRINTK
33/*
34 * ratelimit state to be used in DMXXX_LIMIT().
35 */
36DEFINE_RATELIMIT_STATE(dm_ratelimit_state,
37 DEFAULT_RATELIMIT_INTERVAL,
38 DEFAULT_RATELIMIT_BURST);
39EXPORT_SYMBOL(dm_ratelimit_state);
40#endif
41
60935eb2
MB
42/*
43 * Cookies are numeric values sent with CHANGE and REMOVE
44 * uevents while resuming, removing or renaming the device.
45 */
46#define DM_COOKIE_ENV_VAR_NAME "DM_COOKIE"
47#define DM_COOKIE_LENGTH 24
48
1da177e4
LT
49static const char *_name = DM_NAME;
50
51static unsigned int major = 0;
52static unsigned int _major = 0;
53
d15b774c
AK
54static DEFINE_IDR(_minor_idr);
55
f32c10b0 56static DEFINE_SPINLOCK(_minor_lock);
2c140a24
MP
57
58static void do_deferred_remove(struct work_struct *w);
59
60static DECLARE_WORK(deferred_remove_work, do_deferred_remove);
61
acfe0ad7
MP
62static struct workqueue_struct *deferred_remove_workqueue;
63
1da177e4 64/*
8fbf26ad 65 * For bio-based dm.
1da177e4
LT
66 * One of these is allocated per bio.
67 */
68struct dm_io {
69 struct mapped_device *md;
70 int error;
1da177e4 71 atomic_t io_count;
6ae2fa67 72 struct bio *bio;
3eaf840e 73 unsigned long start_time;
f88fb981 74 spinlock_t endio_lock;
fd2ed4d2 75 struct dm_stats_aux stats_aux;
1da177e4
LT
76};
77
8fbf26ad
KU
78/*
79 * For request-based dm.
80 * One of these is allocated per request.
81 */
82struct dm_rq_target_io {
83 struct mapped_device *md;
84 struct dm_target *ti;
1ae49ea2 85 struct request *orig, *clone;
2eb6e1e3 86 struct kthread_work work;
8fbf26ad
KU
87 int error;
88 union map_info info;
89};
90
91/*
94818742
KO
92 * For request-based dm - the bio clones we allocate are embedded in these
93 * structs.
94 *
95 * We allocate these with bio_alloc_bioset, using the front_pad parameter when
96 * the bioset is created - this means the bio has to come at the end of the
97 * struct.
8fbf26ad
KU
98 */
99struct dm_rq_clone_bio_info {
100 struct bio *orig;
cec47e3d 101 struct dm_rq_target_io *tio;
94818742 102 struct bio clone;
8fbf26ad
KU
103};
104
cec47e3d
KU
105union map_info *dm_get_rq_mapinfo(struct request *rq)
106{
107 if (rq && rq->end_io_data)
108 return &((struct dm_rq_target_io *)rq->end_io_data)->info;
109 return NULL;
110}
111EXPORT_SYMBOL_GPL(dm_get_rq_mapinfo);
112
ba61fdd1
JM
113#define MINOR_ALLOCED ((void *)-1)
114
1da177e4
LT
115/*
116 * Bits for the md->flags field.
117 */
1eb787ec 118#define DMF_BLOCK_IO_FOR_SUSPEND 0
1da177e4 119#define DMF_SUSPENDED 1
aa8d7c2f 120#define DMF_FROZEN 2
fba9f90e 121#define DMF_FREEING 3
5c6bd75d 122#define DMF_DELETING 4
2e93ccc1 123#define DMF_NOFLUSH_SUSPENDING 5
d5b9dd04 124#define DMF_MERGE_IS_OPTIONAL 6
2c140a24 125#define DMF_DEFERRED_REMOVE 7
ffcc3936 126#define DMF_SUSPENDED_INTERNALLY 8
1da177e4 127
83d5e5b0
MP
128/*
129 * A dummy definition to make RCU happy.
130 * struct dm_table should never be dereferenced in this file.
131 */
132struct dm_table {
133 int undefined__;
134};
135
304f3f6a
MB
136/*
137 * Work processed by per-device workqueue.
138 */
1da177e4 139struct mapped_device {
83d5e5b0 140 struct srcu_struct io_barrier;
e61290a4 141 struct mutex suspend_lock;
1da177e4 142 atomic_t holders;
5c6bd75d 143 atomic_t open_count;
1da177e4 144
2a7faeb1
MP
145 /*
146 * The current mapping.
147 * Use dm_get_live_table{_fast} or take suspend_lock for
148 * dereference.
149 */
6fa99520 150 struct dm_table __rcu *map;
2a7faeb1 151
86f1152b
BM
152 struct list_head table_devices;
153 struct mutex table_devices_lock;
154
1da177e4
LT
155 unsigned long flags;
156
165125e1 157 struct request_queue *queue;
a5664dad 158 unsigned type;
4a0b4ddf 159 /* Protect queue and type against concurrent access. */
a5664dad
MS
160 struct mutex type_lock;
161
36a0456f
AK
162 struct target_type *immutable_target_type;
163
1da177e4 164 struct gendisk *disk;
7e51f257 165 char name[16];
1da177e4
LT
166
167 void *interface_ptr;
168
169 /*
170 * A list of ios that arrived while we were suspended.
171 */
316d315b 172 atomic_t pending[2];
1da177e4 173 wait_queue_head_t wait;
53d5914f 174 struct work_struct work;
74859364 175 struct bio_list deferred;
022c2611 176 spinlock_t deferred_lock;
1da177e4 177
af7e466a 178 /*
29e4013d 179 * Processing queue (flush)
304f3f6a
MB
180 */
181 struct workqueue_struct *wq;
182
1da177e4
LT
183 /*
184 * io objects are allocated from here.
185 */
186 mempool_t *io_pool;
1ae49ea2 187 mempool_t *rq_pool;
1da177e4 188
9faf400f
SB
189 struct bio_set *bs;
190
1da177e4
LT
191 /*
192 * Event handling.
193 */
194 atomic_t event_nr;
195 wait_queue_head_t eventq;
7a8c3d3b
MA
196 atomic_t uevent_seq;
197 struct list_head uevent_list;
198 spinlock_t uevent_lock; /* Protect access to uevent_list */
1da177e4
LT
199
200 /*
201 * freeze/thaw support require holding onto a super block
202 */
203 struct super_block *frozen_sb;
db8fef4f 204 struct block_device *bdev;
3ac51e74
DW
205
206 /* forced geometry settings */
207 struct hd_geometry geometry;
784aae73 208
2995fa78
MP
209 /* kobject and completion */
210 struct dm_kobject_holder kobj_holder;
be35f486 211
d87f4c14
TH
212 /* zero-length flush that will be cloned and submitted to targets */
213 struct bio flush_bio;
fd2ed4d2 214
96b26c8c
MP
215 /* the number of internal suspends */
216 unsigned internal_suspend_count;
217
fd2ed4d2 218 struct dm_stats stats;
2eb6e1e3
KB
219
220 struct kthread_worker kworker;
221 struct task_struct *kworker_task;
de3ec86d
MS
222
223 /* for request-based merge heuristic in dm_request_fn() */
0ce65797 224 unsigned seq_rq_merge_deadline_usecs;
de3ec86d 225 int last_rq_rw;
0ce65797
MS
226 sector_t last_rq_pos;
227 ktime_t last_rq_start_time;
bfebd1cd
MS
228
229 /* for blk-mq request-based DM support */
230 struct blk_mq_tag_set tag_set;
17e149b8 231 bool use_blk_mq;
1da177e4
LT
232};
233
17e149b8
MS
234#ifdef CONFIG_DM_MQ_DEFAULT
235static bool use_blk_mq = true;
236#else
237static bool use_blk_mq = false;
238#endif
239
240bool dm_use_blk_mq(struct mapped_device *md)
241{
242 return md->use_blk_mq;
243}
244
e6ee8c0b
KU
245/*
246 * For mempools pre-allocation at the table loading time.
247 */
248struct dm_md_mempools {
249 mempool_t *io_pool;
1ae49ea2 250 mempool_t *rq_pool;
e6ee8c0b
KU
251 struct bio_set *bs;
252};
253
86f1152b
BM
254struct table_device {
255 struct list_head list;
256 atomic_t count;
257 struct dm_dev dm_dev;
258};
259
6cfa5857
MS
260#define RESERVED_BIO_BASED_IOS 16
261#define RESERVED_REQUEST_BASED_IOS 256
f4790826 262#define RESERVED_MAX_IOS 1024
e18b890b 263static struct kmem_cache *_io_cache;
8fbf26ad 264static struct kmem_cache *_rq_tio_cache;
1ae49ea2 265static struct kmem_cache *_rq_cache;
94818742 266
e8603136
MS
267/*
268 * Bio-based DM's mempools' reserved IOs set by the user.
269 */
270static unsigned reserved_bio_based_ios = RESERVED_BIO_BASED_IOS;
271
f4790826
MS
272/*
273 * Request-based DM's mempools' reserved IOs set by the user.
274 */
275static unsigned reserved_rq_based_ios = RESERVED_REQUEST_BASED_IOS;
276
09c2d531 277static unsigned __dm_get_module_param(unsigned *module_param,
f4790826
MS
278 unsigned def, unsigned max)
279{
09c2d531
MS
280 unsigned param = ACCESS_ONCE(*module_param);
281 unsigned modified_param = 0;
f4790826 282
09c2d531
MS
283 if (!param)
284 modified_param = def;
285 else if (param > max)
286 modified_param = max;
f4790826 287
09c2d531
MS
288 if (modified_param) {
289 (void)cmpxchg(module_param, param, modified_param);
290 param = modified_param;
f4790826
MS
291 }
292
09c2d531 293 return param;
f4790826
MS
294}
295
e8603136
MS
296unsigned dm_get_reserved_bio_based_ios(void)
297{
09c2d531 298 return __dm_get_module_param(&reserved_bio_based_ios,
e8603136
MS
299 RESERVED_BIO_BASED_IOS, RESERVED_MAX_IOS);
300}
301EXPORT_SYMBOL_GPL(dm_get_reserved_bio_based_ios);
302
f4790826
MS
303unsigned dm_get_reserved_rq_based_ios(void)
304{
09c2d531 305 return __dm_get_module_param(&reserved_rq_based_ios,
f4790826
MS
306 RESERVED_REQUEST_BASED_IOS, RESERVED_MAX_IOS);
307}
308EXPORT_SYMBOL_GPL(dm_get_reserved_rq_based_ios);
309
1da177e4
LT
310static int __init local_init(void)
311{
51157b4a 312 int r = -ENOMEM;
1da177e4 313
1da177e4 314 /* allocate a slab for the dm_ios */
028867ac 315 _io_cache = KMEM_CACHE(dm_io, 0);
1da177e4 316 if (!_io_cache)
51157b4a 317 return r;
1da177e4 318
8fbf26ad
KU
319 _rq_tio_cache = KMEM_CACHE(dm_rq_target_io, 0);
320 if (!_rq_tio_cache)
dba14160 321 goto out_free_io_cache;
8fbf26ad 322
1ae49ea2
MS
323 _rq_cache = kmem_cache_create("dm_clone_request", sizeof(struct request),
324 __alignof__(struct request), 0, NULL);
325 if (!_rq_cache)
326 goto out_free_rq_tio_cache;
327
51e5b2bd 328 r = dm_uevent_init();
51157b4a 329 if (r)
1ae49ea2 330 goto out_free_rq_cache;
51e5b2bd 331
acfe0ad7
MP
332 deferred_remove_workqueue = alloc_workqueue("kdmremove", WQ_UNBOUND, 1);
333 if (!deferred_remove_workqueue) {
334 r = -ENOMEM;
335 goto out_uevent_exit;
336 }
337
1da177e4
LT
338 _major = major;
339 r = register_blkdev(_major, _name);
51157b4a 340 if (r < 0)
acfe0ad7 341 goto out_free_workqueue;
1da177e4
LT
342
343 if (!_major)
344 _major = r;
345
346 return 0;
51157b4a 347
acfe0ad7
MP
348out_free_workqueue:
349 destroy_workqueue(deferred_remove_workqueue);
51157b4a
KU
350out_uevent_exit:
351 dm_uevent_exit();
1ae49ea2
MS
352out_free_rq_cache:
353 kmem_cache_destroy(_rq_cache);
8fbf26ad
KU
354out_free_rq_tio_cache:
355 kmem_cache_destroy(_rq_tio_cache);
51157b4a
KU
356out_free_io_cache:
357 kmem_cache_destroy(_io_cache);
358
359 return r;
1da177e4
LT
360}
361
362static void local_exit(void)
363{
2c140a24 364 flush_scheduled_work();
acfe0ad7 365 destroy_workqueue(deferred_remove_workqueue);
2c140a24 366
1ae49ea2 367 kmem_cache_destroy(_rq_cache);
8fbf26ad 368 kmem_cache_destroy(_rq_tio_cache);
1da177e4 369 kmem_cache_destroy(_io_cache);
00d59405 370 unregister_blkdev(_major, _name);
51e5b2bd 371 dm_uevent_exit();
1da177e4
LT
372
373 _major = 0;
374
375 DMINFO("cleaned up");
376}
377
b9249e55 378static int (*_inits[])(void) __initdata = {
1da177e4
LT
379 local_init,
380 dm_target_init,
381 dm_linear_init,
382 dm_stripe_init,
952b3557 383 dm_io_init,
945fa4d2 384 dm_kcopyd_init,
1da177e4 385 dm_interface_init,
fd2ed4d2 386 dm_statistics_init,
1da177e4
LT
387};
388
b9249e55 389static void (*_exits[])(void) = {
1da177e4
LT
390 local_exit,
391 dm_target_exit,
392 dm_linear_exit,
393 dm_stripe_exit,
952b3557 394 dm_io_exit,
945fa4d2 395 dm_kcopyd_exit,
1da177e4 396 dm_interface_exit,
fd2ed4d2 397 dm_statistics_exit,
1da177e4
LT
398};
399
400static int __init dm_init(void)
401{
402 const int count = ARRAY_SIZE(_inits);
403
404 int r, i;
405
406 for (i = 0; i < count; i++) {
407 r = _inits[i]();
408 if (r)
409 goto bad;
410 }
411
412 return 0;
413
414 bad:
415 while (i--)
416 _exits[i]();
417
418 return r;
419}
420
421static void __exit dm_exit(void)
422{
423 int i = ARRAY_SIZE(_exits);
424
425 while (i--)
426 _exits[i]();
d15b774c
AK
427
428 /*
429 * Should be empty by this point.
430 */
d15b774c 431 idr_destroy(&_minor_idr);
1da177e4
LT
432}
433
434/*
435 * Block device functions
436 */
432a212c
MA
437int dm_deleting_md(struct mapped_device *md)
438{
439 return test_bit(DMF_DELETING, &md->flags);
440}
441
fe5f9f2c 442static int dm_blk_open(struct block_device *bdev, fmode_t mode)
1da177e4
LT
443{
444 struct mapped_device *md;
445
fba9f90e
JM
446 spin_lock(&_minor_lock);
447
fe5f9f2c 448 md = bdev->bd_disk->private_data;
fba9f90e
JM
449 if (!md)
450 goto out;
451
5c6bd75d 452 if (test_bit(DMF_FREEING, &md->flags) ||
432a212c 453 dm_deleting_md(md)) {
fba9f90e
JM
454 md = NULL;
455 goto out;
456 }
457
1da177e4 458 dm_get(md);
5c6bd75d 459 atomic_inc(&md->open_count);
fba9f90e
JM
460out:
461 spin_unlock(&_minor_lock);
462
463 return md ? 0 : -ENXIO;
1da177e4
LT
464}
465
db2a144b 466static void dm_blk_close(struct gendisk *disk, fmode_t mode)
1da177e4 467{
63a4f065 468 struct mapped_device *md;
6e9624b8 469
4a1aeb98
MB
470 spin_lock(&_minor_lock);
471
63a4f065
MS
472 md = disk->private_data;
473 if (WARN_ON(!md))
474 goto out;
475
2c140a24
MP
476 if (atomic_dec_and_test(&md->open_count) &&
477 (test_bit(DMF_DEFERRED_REMOVE, &md->flags)))
acfe0ad7 478 queue_work(deferred_remove_workqueue, &deferred_remove_work);
2c140a24 479
1da177e4 480 dm_put(md);
63a4f065 481out:
4a1aeb98 482 spin_unlock(&_minor_lock);
1da177e4
LT
483}
484
5c6bd75d
AK
485int dm_open_count(struct mapped_device *md)
486{
487 return atomic_read(&md->open_count);
488}
489
490/*
491 * Guarantees nothing is using the device before it's deleted.
492 */
2c140a24 493int dm_lock_for_deletion(struct mapped_device *md, bool mark_deferred, bool only_deferred)
5c6bd75d
AK
494{
495 int r = 0;
496
497 spin_lock(&_minor_lock);
498
2c140a24 499 if (dm_open_count(md)) {
5c6bd75d 500 r = -EBUSY;
2c140a24
MP
501 if (mark_deferred)
502 set_bit(DMF_DEFERRED_REMOVE, &md->flags);
503 } else if (only_deferred && !test_bit(DMF_DEFERRED_REMOVE, &md->flags))
504 r = -EEXIST;
5c6bd75d
AK
505 else
506 set_bit(DMF_DELETING, &md->flags);
507
508 spin_unlock(&_minor_lock);
509
510 return r;
511}
512
2c140a24
MP
513int dm_cancel_deferred_remove(struct mapped_device *md)
514{
515 int r = 0;
516
517 spin_lock(&_minor_lock);
518
519 if (test_bit(DMF_DELETING, &md->flags))
520 r = -EBUSY;
521 else
522 clear_bit(DMF_DEFERRED_REMOVE, &md->flags);
523
524 spin_unlock(&_minor_lock);
525
526 return r;
527}
528
529static void do_deferred_remove(struct work_struct *w)
530{
531 dm_deferred_remove();
532}
533
fd2ed4d2
MP
534sector_t dm_get_size(struct mapped_device *md)
535{
536 return get_capacity(md->disk);
537}
538
9974fa2c
MS
539struct request_queue *dm_get_md_queue(struct mapped_device *md)
540{
541 return md->queue;
542}
543
fd2ed4d2
MP
544struct dm_stats *dm_get_stats(struct mapped_device *md)
545{
546 return &md->stats;
547}
548
3ac51e74
DW
549static int dm_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
550{
551 struct mapped_device *md = bdev->bd_disk->private_data;
552
553 return dm_get_geometry(md, geo);
554}
555
fe5f9f2c 556static int dm_blk_ioctl(struct block_device *bdev, fmode_t mode,
aa129a22
MB
557 unsigned int cmd, unsigned long arg)
558{
fe5f9f2c 559 struct mapped_device *md = bdev->bd_disk->private_data;
83d5e5b0 560 int srcu_idx;
6c182cd8 561 struct dm_table *map;
aa129a22
MB
562 struct dm_target *tgt;
563 int r = -ENOTTY;
564
6c182cd8 565retry:
83d5e5b0
MP
566 map = dm_get_live_table(md, &srcu_idx);
567
aa129a22
MB
568 if (!map || !dm_table_get_size(map))
569 goto out;
570
571 /* We only support devices that have a single target */
572 if (dm_table_get_num_targets(map) != 1)
573 goto out;
574
575 tgt = dm_table_get_target(map, 0);
4d341d82
MS
576 if (!tgt->type->ioctl)
577 goto out;
aa129a22 578
4f186f8b 579 if (dm_suspended_md(md)) {
aa129a22
MB
580 r = -EAGAIN;
581 goto out;
582 }
583
4d341d82 584 r = tgt->type->ioctl(tgt, cmd, arg);
aa129a22
MB
585
586out:
83d5e5b0 587 dm_put_live_table(md, srcu_idx);
aa129a22 588
6c182cd8
HR
589 if (r == -ENOTCONN) {
590 msleep(10);
591 goto retry;
592 }
593
aa129a22
MB
594 return r;
595}
596
028867ac 597static struct dm_io *alloc_io(struct mapped_device *md)
1da177e4
LT
598{
599 return mempool_alloc(md->io_pool, GFP_NOIO);
600}
601
028867ac 602static void free_io(struct mapped_device *md, struct dm_io *io)
1da177e4
LT
603{
604 mempool_free(io, md->io_pool);
605}
606
028867ac 607static void free_tio(struct mapped_device *md, struct dm_target_io *tio)
1da177e4 608{
dba14160 609 bio_put(&tio->clone);
1da177e4
LT
610}
611
08885643
KU
612static struct dm_rq_target_io *alloc_rq_tio(struct mapped_device *md,
613 gfp_t gfp_mask)
cec47e3d 614{
5f015204 615 return mempool_alloc(md->io_pool, gfp_mask);
cec47e3d
KU
616}
617
618static void free_rq_tio(struct dm_rq_target_io *tio)
619{
5f015204 620 mempool_free(tio, tio->md->io_pool);
cec47e3d
KU
621}
622
1ae49ea2
MS
623static struct request *alloc_clone_request(struct mapped_device *md,
624 gfp_t gfp_mask)
625{
626 return mempool_alloc(md->rq_pool, gfp_mask);
627}
628
629static void free_clone_request(struct mapped_device *md, struct request *rq)
630{
631 mempool_free(rq, md->rq_pool);
632}
633
90abb8c4
KU
634static int md_in_flight(struct mapped_device *md)
635{
636 return atomic_read(&md->pending[READ]) +
637 atomic_read(&md->pending[WRITE]);
638}
639
3eaf840e
JNN
640static void start_io_acct(struct dm_io *io)
641{
642 struct mapped_device *md = io->md;
fd2ed4d2 643 struct bio *bio = io->bio;
c9959059 644 int cpu;
fd2ed4d2 645 int rw = bio_data_dir(bio);
3eaf840e
JNN
646
647 io->start_time = jiffies;
648
074a7aca
TH
649 cpu = part_stat_lock();
650 part_round_stats(cpu, &dm_disk(md)->part0);
651 part_stat_unlock();
1e9bb880
SL
652 atomic_set(&dm_disk(md)->part0.in_flight[rw],
653 atomic_inc_return(&md->pending[rw]));
fd2ed4d2
MP
654
655 if (unlikely(dm_stats_used(&md->stats)))
4f024f37 656 dm_stats_account_io(&md->stats, bio->bi_rw, bio->bi_iter.bi_sector,
fd2ed4d2 657 bio_sectors(bio), false, 0, &io->stats_aux);
3eaf840e
JNN
658}
659
d221d2e7 660static void end_io_acct(struct dm_io *io)
3eaf840e
JNN
661{
662 struct mapped_device *md = io->md;
663 struct bio *bio = io->bio;
664 unsigned long duration = jiffies - io->start_time;
18c0b223 665 int pending;
3eaf840e
JNN
666 int rw = bio_data_dir(bio);
667
18c0b223 668 generic_end_io_acct(rw, &dm_disk(md)->part0, io->start_time);
3eaf840e 669
fd2ed4d2 670 if (unlikely(dm_stats_used(&md->stats)))
4f024f37 671 dm_stats_account_io(&md->stats, bio->bi_rw, bio->bi_iter.bi_sector,
fd2ed4d2
MP
672 bio_sectors(bio), true, duration, &io->stats_aux);
673
af7e466a
MP
674 /*
675 * After this is decremented the bio must not be touched if it is
d87f4c14 676 * a flush.
af7e466a 677 */
1e9bb880
SL
678 pending = atomic_dec_return(&md->pending[rw]);
679 atomic_set(&dm_disk(md)->part0.in_flight[rw], pending);
316d315b 680 pending += atomic_read(&md->pending[rw^0x1]);
3eaf840e 681
d221d2e7
MP
682 /* nudge anyone waiting on suspend queue */
683 if (!pending)
684 wake_up(&md->wait);
3eaf840e
JNN
685}
686
1da177e4
LT
687/*
688 * Add the bio to the list of deferred io.
689 */
92c63902 690static void queue_io(struct mapped_device *md, struct bio *bio)
1da177e4 691{
05447420 692 unsigned long flags;
1da177e4 693
05447420 694 spin_lock_irqsave(&md->deferred_lock, flags);
1da177e4 695 bio_list_add(&md->deferred, bio);
05447420 696 spin_unlock_irqrestore(&md->deferred_lock, flags);
6a8736d1 697 queue_work(md->wq, &md->work);
1da177e4
LT
698}
699
700/*
701 * Everyone (including functions in this file), should use this
702 * function to access the md->map field, and make sure they call
83d5e5b0 703 * dm_put_live_table() when finished.
1da177e4 704 */
83d5e5b0 705struct dm_table *dm_get_live_table(struct mapped_device *md, int *srcu_idx) __acquires(md->io_barrier)
1da177e4 706{
83d5e5b0
MP
707 *srcu_idx = srcu_read_lock(&md->io_barrier);
708
709 return srcu_dereference(md->map, &md->io_barrier);
710}
1da177e4 711
83d5e5b0
MP
712void dm_put_live_table(struct mapped_device *md, int srcu_idx) __releases(md->io_barrier)
713{
714 srcu_read_unlock(&md->io_barrier, srcu_idx);
715}
716
717void dm_sync_table(struct mapped_device *md)
718{
719 synchronize_srcu(&md->io_barrier);
720 synchronize_rcu_expedited();
721}
722
723/*
724 * A fast alternative to dm_get_live_table/dm_put_live_table.
725 * The caller must not block between these two functions.
726 */
727static struct dm_table *dm_get_live_table_fast(struct mapped_device *md) __acquires(RCU)
728{
729 rcu_read_lock();
730 return rcu_dereference(md->map);
731}
1da177e4 732
83d5e5b0
MP
733static void dm_put_live_table_fast(struct mapped_device *md) __releases(RCU)
734{
735 rcu_read_unlock();
1da177e4
LT
736}
737
86f1152b
BM
738/*
739 * Open a table device so we can use it as a map destination.
740 */
741static int open_table_device(struct table_device *td, dev_t dev,
742 struct mapped_device *md)
743{
744 static char *_claim_ptr = "I belong to device-mapper";
745 struct block_device *bdev;
746
747 int r;
748
749 BUG_ON(td->dm_dev.bdev);
750
751 bdev = blkdev_get_by_dev(dev, td->dm_dev.mode | FMODE_EXCL, _claim_ptr);
752 if (IS_ERR(bdev))
753 return PTR_ERR(bdev);
754
755 r = bd_link_disk_holder(bdev, dm_disk(md));
756 if (r) {
757 blkdev_put(bdev, td->dm_dev.mode | FMODE_EXCL);
758 return r;
759 }
760
761 td->dm_dev.bdev = bdev;
762 return 0;
763}
764
765/*
766 * Close a table device that we've been using.
767 */
768static void close_table_device(struct table_device *td, struct mapped_device *md)
769{
770 if (!td->dm_dev.bdev)
771 return;
772
773 bd_unlink_disk_holder(td->dm_dev.bdev, dm_disk(md));
774 blkdev_put(td->dm_dev.bdev, td->dm_dev.mode | FMODE_EXCL);
775 td->dm_dev.bdev = NULL;
776}
777
778static struct table_device *find_table_device(struct list_head *l, dev_t dev,
779 fmode_t mode) {
780 struct table_device *td;
781
782 list_for_each_entry(td, l, list)
783 if (td->dm_dev.bdev->bd_dev == dev && td->dm_dev.mode == mode)
784 return td;
785
786 return NULL;
787}
788
789int dm_get_table_device(struct mapped_device *md, dev_t dev, fmode_t mode,
790 struct dm_dev **result) {
791 int r;
792 struct table_device *td;
793
794 mutex_lock(&md->table_devices_lock);
795 td = find_table_device(&md->table_devices, dev, mode);
796 if (!td) {
797 td = kmalloc(sizeof(*td), GFP_KERNEL);
798 if (!td) {
799 mutex_unlock(&md->table_devices_lock);
800 return -ENOMEM;
801 }
802
803 td->dm_dev.mode = mode;
804 td->dm_dev.bdev = NULL;
805
806 if ((r = open_table_device(td, dev, md))) {
807 mutex_unlock(&md->table_devices_lock);
808 kfree(td);
809 return r;
810 }
811
812 format_dev_t(td->dm_dev.name, dev);
813
814 atomic_set(&td->count, 0);
815 list_add(&td->list, &md->table_devices);
816 }
817 atomic_inc(&td->count);
818 mutex_unlock(&md->table_devices_lock);
819
820 *result = &td->dm_dev;
821 return 0;
822}
823EXPORT_SYMBOL_GPL(dm_get_table_device);
824
825void dm_put_table_device(struct mapped_device *md, struct dm_dev *d)
826{
827 struct table_device *td = container_of(d, struct table_device, dm_dev);
828
829 mutex_lock(&md->table_devices_lock);
830 if (atomic_dec_and_test(&td->count)) {
831 close_table_device(td, md);
832 list_del(&td->list);
833 kfree(td);
834 }
835 mutex_unlock(&md->table_devices_lock);
836}
837EXPORT_SYMBOL(dm_put_table_device);
838
839static void free_table_devices(struct list_head *devices)
840{
841 struct list_head *tmp, *next;
842
843 list_for_each_safe(tmp, next, devices) {
844 struct table_device *td = list_entry(tmp, struct table_device, list);
845
846 DMWARN("dm_destroy: %s still exists with %d references",
847 td->dm_dev.name, atomic_read(&td->count));
848 kfree(td);
849 }
850}
851
3ac51e74
DW
852/*
853 * Get the geometry associated with a dm device
854 */
855int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo)
856{
857 *geo = md->geometry;
858
859 return 0;
860}
861
862/*
863 * Set the geometry of a device.
864 */
865int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo)
866{
867 sector_t sz = (sector_t)geo->cylinders * geo->heads * geo->sectors;
868
869 if (geo->start > sz) {
870 DMWARN("Start sector is beyond the geometry limits.");
871 return -EINVAL;
872 }
873
874 md->geometry = *geo;
875
876 return 0;
877}
878
1da177e4
LT
879/*-----------------------------------------------------------------
880 * CRUD START:
881 * A more elegant soln is in the works that uses the queue
882 * merge fn, unfortunately there are a couple of changes to
883 * the block layer that I want to make for this. So in the
884 * interests of getting something for people to use I give
885 * you this clearly demarcated crap.
886 *---------------------------------------------------------------*/
887
2e93ccc1
KU
888static int __noflush_suspending(struct mapped_device *md)
889{
890 return test_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
891}
892
1da177e4
LT
893/*
894 * Decrements the number of outstanding ios that a bio has been
895 * cloned into, completing the original io if necc.
896 */
858119e1 897static void dec_pending(struct dm_io *io, int error)
1da177e4 898{
2e93ccc1 899 unsigned long flags;
b35f8caa
MB
900 int io_error;
901 struct bio *bio;
902 struct mapped_device *md = io->md;
2e93ccc1
KU
903
904 /* Push-back supersedes any I/O errors */
f88fb981
KU
905 if (unlikely(error)) {
906 spin_lock_irqsave(&io->endio_lock, flags);
907 if (!(io->error > 0 && __noflush_suspending(md)))
908 io->error = error;
909 spin_unlock_irqrestore(&io->endio_lock, flags);
910 }
1da177e4
LT
911
912 if (atomic_dec_and_test(&io->io_count)) {
2e93ccc1
KU
913 if (io->error == DM_ENDIO_REQUEUE) {
914 /*
915 * Target requested pushing back the I/O.
2e93ccc1 916 */
022c2611 917 spin_lock_irqsave(&md->deferred_lock, flags);
6a8736d1
TH
918 if (__noflush_suspending(md))
919 bio_list_add_head(&md->deferred, io->bio);
920 else
2e93ccc1
KU
921 /* noflush suspend was interrupted. */
922 io->error = -EIO;
022c2611 923 spin_unlock_irqrestore(&md->deferred_lock, flags);
2e93ccc1
KU
924 }
925
b35f8caa
MB
926 io_error = io->error;
927 bio = io->bio;
6a8736d1
TH
928 end_io_acct(io);
929 free_io(md, io);
930
931 if (io_error == DM_ENDIO_REQUEUE)
932 return;
2e93ccc1 933
4f024f37 934 if ((bio->bi_rw & REQ_FLUSH) && bio->bi_iter.bi_size) {
af7e466a 935 /*
6a8736d1
TH
936 * Preflush done for flush with data, reissue
937 * without REQ_FLUSH.
af7e466a 938 */
6a8736d1
TH
939 bio->bi_rw &= ~REQ_FLUSH;
940 queue_io(md, bio);
af7e466a 941 } else {
b372d360 942 /* done with normal IO or empty flush */
0a82a8d1 943 trace_block_bio_complete(md->queue, bio, io_error);
b372d360 944 bio_endio(bio, io_error);
b35f8caa 945 }
1da177e4
LT
946 }
947}
948
7eee4ae2
MS
949static void disable_write_same(struct mapped_device *md)
950{
951 struct queue_limits *limits = dm_get_queue_limits(md);
952
953 /* device doesn't really support WRITE SAME, disable it */
954 limits->max_write_same_sectors = 0;
955}
956
6712ecf8 957static void clone_endio(struct bio *bio, int error)
1da177e4 958{
5164bece 959 int r = error;
bfc6d41c 960 struct dm_target_io *tio = container_of(bio, struct dm_target_io, clone);
b35f8caa 961 struct dm_io *io = tio->io;
9faf400f 962 struct mapped_device *md = tio->io->md;
1da177e4
LT
963 dm_endio_fn endio = tio->ti->type->end_io;
964
1da177e4
LT
965 if (!bio_flagged(bio, BIO_UPTODATE) && !error)
966 error = -EIO;
967
968 if (endio) {
7de3ee57 969 r = endio(tio->ti, bio, error);
2e93ccc1
KU
970 if (r < 0 || r == DM_ENDIO_REQUEUE)
971 /*
972 * error and requeue request are handled
973 * in dec_pending().
974 */
1da177e4 975 error = r;
45cbcd79
KU
976 else if (r == DM_ENDIO_INCOMPLETE)
977 /* The target will handle the io */
6712ecf8 978 return;
45cbcd79
KU
979 else if (r) {
980 DMWARN("unimplemented target endio return value: %d", r);
981 BUG();
982 }
1da177e4
LT
983 }
984
7eee4ae2
MS
985 if (unlikely(r == -EREMOTEIO && (bio->bi_rw & REQ_WRITE_SAME) &&
986 !bdev_get_queue(bio->bi_bdev)->limits.max_write_same_sectors))
987 disable_write_same(md);
988
9faf400f 989 free_tio(md, tio);
b35f8caa 990 dec_pending(io, error);
1da177e4
LT
991}
992
bfebd1cd
MS
993static struct dm_rq_target_io *tio_from_request(struct request *rq)
994{
995 return (rq->q->mq_ops ? blk_mq_rq_to_pdu(rq) : rq->special);
996}
997
cec47e3d
KU
998/*
999 * Don't touch any member of the md after calling this function because
1000 * the md may be freed in dm_put() at the end of this function.
1001 * Or do dm_get() before calling this function and dm_put() later.
1002 */
466d89a6 1003static void rq_completed(struct mapped_device *md, int rw, bool run_queue)
cec47e3d 1004{
9a0e609e
MS
1005 int nr_requests_pending;
1006
b4324fee 1007 atomic_dec(&md->pending[rw]);
cec47e3d
KU
1008
1009 /* nudge anyone waiting on suspend queue */
9a0e609e
MS
1010 nr_requests_pending = md_in_flight(md);
1011 if (!nr_requests_pending)
cec47e3d
KU
1012 wake_up(&md->wait);
1013
a8c32a5c
JA
1014 /*
1015 * Run this off this callpath, as drivers could invoke end_io while
1016 * inside their request_fn (and holding the queue lock). Calling
1017 * back into ->request_fn() could deadlock attempting to grab the
1018 * queue lock again.
1019 */
9a0e609e 1020 if (run_queue) {
bfebd1cd
MS
1021 if (md->queue->mq_ops)
1022 blk_mq_run_hw_queues(md->queue, true);
1023 else if (!nr_requests_pending ||
1024 (nr_requests_pending >= md->queue->nr_congestion_on))
9a0e609e
MS
1025 blk_run_queue_async(md->queue);
1026 }
cec47e3d
KU
1027
1028 /*
1029 * dm_put() must be at the end of this function. See the comment above
1030 */
1031 dm_put(md);
1032}
1033
e5d8de32 1034static void free_rq_clone(struct request *clone)
a77e28c7
KU
1035{
1036 struct dm_rq_target_io *tio = clone->end_io_data;
bfebd1cd 1037 struct mapped_device *md = tio->md;
a77e28c7 1038
aa6df8dd
MS
1039 if (md->type == DM_TYPE_MQ_REQUEST_BASED)
1040 /* stacked on blk-mq queue(s) */
e5863d9a 1041 tio->ti->type->release_clone_rq(clone);
02233342
MS
1042 else if (!md->queue->mq_ops)
1043 /* request_fn queue stacked on request_fn queue(s) */
bfebd1cd 1044 free_clone_request(md, clone);
aa6df8dd
MS
1045 /*
1046 * NOTE: for the blk-mq queue stacked on request_fn queue(s) case:
1047 * no need to call free_clone_request() because we leverage blk-mq by
1048 * allocating the clone at the end of the blk-mq pdu (see: clone_rq)
1049 */
bfebd1cd
MS
1050
1051 if (!md->queue->mq_ops)
1052 free_rq_tio(tio);
a77e28c7
KU
1053}
1054
980691e5
KU
1055/*
1056 * Complete the clone and the original request.
466d89a6
KB
1057 * Must be called without clone's queue lock held,
1058 * see end_clone_request() for more details.
980691e5
KU
1059 */
1060static void dm_end_request(struct request *clone, int error)
1061{
1062 int rw = rq_data_dir(clone);
1063 struct dm_rq_target_io *tio = clone->end_io_data;
1064 struct mapped_device *md = tio->md;
1065 struct request *rq = tio->orig;
1066
29e4013d 1067 if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
980691e5
KU
1068 rq->errors = clone->errors;
1069 rq->resid_len = clone->resid_len;
1070
1071 if (rq->sense)
1072 /*
1073 * We are using the sense buffer of the original
1074 * request.
1075 * So setting the length of the sense data is enough.
1076 */
1077 rq->sense_len = clone->sense_len;
1078 }
1079
e5d8de32 1080 free_rq_clone(clone);
bfebd1cd
MS
1081 if (!rq->q->mq_ops)
1082 blk_end_request_all(rq, error);
1083 else
1084 blk_mq_end_request(rq, error);
29e4013d 1085 rq_completed(md, rw, true);
980691e5
KU
1086}
1087
cec47e3d
KU
1088static void dm_unprep_request(struct request *rq)
1089{
bfebd1cd 1090 struct dm_rq_target_io *tio = tio_from_request(rq);
466d89a6 1091 struct request *clone = tio->clone;
cec47e3d 1092
bfebd1cd
MS
1093 if (!rq->q->mq_ops) {
1094 rq->special = NULL;
1095 rq->cmd_flags &= ~REQ_DONTPREP;
1096 }
cec47e3d 1097
e5863d9a 1098 if (clone)
e5d8de32 1099 free_rq_clone(clone);
cec47e3d
KU
1100}
1101
1102/*
1103 * Requeue the original request of a clone.
1104 */
bfebd1cd 1105static void old_requeue_request(struct request *rq)
cec47e3d 1106{
cec47e3d
KU
1107 struct request_queue *q = rq->q;
1108 unsigned long flags;
1109
cec47e3d 1110 spin_lock_irqsave(q->queue_lock, flags);
cec47e3d 1111 blk_requeue_request(q, rq);
4ae9944d 1112 blk_run_queue_async(q);
cec47e3d 1113 spin_unlock_irqrestore(q->queue_lock, flags);
bfebd1cd
MS
1114}
1115
1116static void dm_requeue_unmapped_original_request(struct mapped_device *md,
1117 struct request *rq)
1118{
1119 int rw = rq_data_dir(rq);
1120
1121 dm_unprep_request(rq);
1122
1123 if (!rq->q->mq_ops)
1124 old_requeue_request(rq);
1125 else {
1126 blk_mq_requeue_request(rq);
1127 blk_mq_kick_requeue_list(rq->q);
1128 }
cec47e3d 1129
466d89a6
KB
1130 rq_completed(md, rw, false);
1131}
1132
1133static void dm_requeue_unmapped_request(struct request *clone)
1134{
1135 struct dm_rq_target_io *tio = clone->end_io_data;
1136
1137 dm_requeue_unmapped_original_request(tio->md, tio->orig);
cec47e3d 1138}
cec47e3d 1139
bfebd1cd 1140static void old_stop_queue(struct request_queue *q)
cec47e3d
KU
1141{
1142 unsigned long flags;
1143
bfebd1cd
MS
1144 if (blk_queue_stopped(q))
1145 return;
1146
cec47e3d 1147 spin_lock_irqsave(q->queue_lock, flags);
bfebd1cd 1148 blk_stop_queue(q);
cec47e3d
KU
1149 spin_unlock_irqrestore(q->queue_lock, flags);
1150}
1151
bfebd1cd 1152static void stop_queue(struct request_queue *q)
cec47e3d 1153{
bfebd1cd
MS
1154 if (!q->mq_ops)
1155 old_stop_queue(q);
1156 else
1157 blk_mq_stop_hw_queues(q);
cec47e3d
KU
1158}
1159
bfebd1cd 1160static void old_start_queue(struct request_queue *q)
cec47e3d
KU
1161{
1162 unsigned long flags;
1163
1164 spin_lock_irqsave(q->queue_lock, flags);
bfebd1cd
MS
1165 if (blk_queue_stopped(q))
1166 blk_start_queue(q);
cec47e3d
KU
1167 spin_unlock_irqrestore(q->queue_lock, flags);
1168}
1169
bfebd1cd
MS
1170static void start_queue(struct request_queue *q)
1171{
1172 if (!q->mq_ops)
1173 old_start_queue(q);
1174 else
1175 blk_mq_start_stopped_hw_queues(q, true);
1176}
1177
11a68244 1178static void dm_done(struct request *clone, int error, bool mapped)
cec47e3d 1179{
11a68244 1180 int r = error;
cec47e3d 1181 struct dm_rq_target_io *tio = clone->end_io_data;
ba1cbad9 1182 dm_request_endio_fn rq_end_io = NULL;
cec47e3d 1183
ba1cbad9
MS
1184 if (tio->ti) {
1185 rq_end_io = tio->ti->type->rq_end_io;
1186
1187 if (mapped && rq_end_io)
1188 r = rq_end_io(tio->ti, clone, error, &tio->info);
1189 }
cec47e3d 1190
7eee4ae2
MS
1191 if (unlikely(r == -EREMOTEIO && (clone->cmd_flags & REQ_WRITE_SAME) &&
1192 !clone->q->limits.max_write_same_sectors))
1193 disable_write_same(tio->md);
1194
11a68244 1195 if (r <= 0)
cec47e3d 1196 /* The target wants to complete the I/O */
11a68244
KU
1197 dm_end_request(clone, r);
1198 else if (r == DM_ENDIO_INCOMPLETE)
cec47e3d
KU
1199 /* The target will handle the I/O */
1200 return;
11a68244 1201 else if (r == DM_ENDIO_REQUEUE)
cec47e3d
KU
1202 /* The target wants to requeue the I/O */
1203 dm_requeue_unmapped_request(clone);
1204 else {
11a68244 1205 DMWARN("unimplemented target endio return value: %d", r);
cec47e3d
KU
1206 BUG();
1207 }
1208}
1209
11a68244
KU
1210/*
1211 * Request completion handler for request-based dm
1212 */
1213static void dm_softirq_done(struct request *rq)
1214{
1215 bool mapped = true;
bfebd1cd 1216 struct dm_rq_target_io *tio = tio_from_request(rq);
466d89a6 1217 struct request *clone = tio->clone;
bfebd1cd 1218 int rw;
11a68244 1219
e5863d9a 1220 if (!clone) {
bfebd1cd
MS
1221 rw = rq_data_dir(rq);
1222 if (!rq->q->mq_ops) {
1223 blk_end_request_all(rq, tio->error);
1224 rq_completed(tio->md, rw, false);
1225 free_rq_tio(tio);
1226 } else {
1227 blk_mq_end_request(rq, tio->error);
1228 rq_completed(tio->md, rw, false);
1229 }
e5863d9a
MS
1230 return;
1231 }
11a68244
KU
1232
1233 if (rq->cmd_flags & REQ_FAILED)
1234 mapped = false;
1235
1236 dm_done(clone, tio->error, mapped);
1237}
1238
cec47e3d
KU
1239/*
1240 * Complete the clone and the original request with the error status
1241 * through softirq context.
1242 */
466d89a6 1243static void dm_complete_request(struct request *rq, int error)
cec47e3d 1244{
bfebd1cd 1245 struct dm_rq_target_io *tio = tio_from_request(rq);
cec47e3d
KU
1246
1247 tio->error = error;
cec47e3d
KU
1248 blk_complete_request(rq);
1249}
1250
1251/*
1252 * Complete the not-mapped clone and the original request with the error status
1253 * through softirq context.
1254 * Target's rq_end_io() function isn't called.
e5863d9a 1255 * This may be used when the target's map_rq() or clone_and_map_rq() functions fail.
cec47e3d 1256 */
466d89a6 1257static void dm_kill_unmapped_request(struct request *rq, int error)
cec47e3d 1258{
cec47e3d 1259 rq->cmd_flags |= REQ_FAILED;
466d89a6 1260 dm_complete_request(rq, error);
cec47e3d 1261}
cec47e3d
KU
1262
1263/*
bfebd1cd 1264 * Called with the clone's queue lock held (for non-blk-mq)
cec47e3d
KU
1265 */
1266static void end_clone_request(struct request *clone, int error)
1267{
466d89a6
KB
1268 struct dm_rq_target_io *tio = clone->end_io_data;
1269
e5863d9a
MS
1270 if (!clone->q->mq_ops) {
1271 /*
1272 * For just cleaning up the information of the queue in which
1273 * the clone was dispatched.
1274 * The clone is *NOT* freed actually here because it is alloced
1275 * from dm own mempool (REQ_ALLOCED isn't set).
1276 */
1277 __blk_put_request(clone->q, clone);
1278 }
cec47e3d
KU
1279
1280 /*
1281 * Actual request completion is done in a softirq context which doesn't
466d89a6 1282 * hold the clone's queue lock. Otherwise, deadlock could occur because:
cec47e3d
KU
1283 * - another request may be submitted by the upper level driver
1284 * of the stacking during the completion
1285 * - the submission which requires queue lock may be done
466d89a6 1286 * against this clone's queue
cec47e3d 1287 */
466d89a6 1288 dm_complete_request(tio->orig, error);
cec47e3d
KU
1289}
1290
56a67df7
MS
1291/*
1292 * Return maximum size of I/O possible at the supplied sector up to the current
1293 * target boundary.
1294 */
1295static sector_t max_io_len_target_boundary(sector_t sector, struct dm_target *ti)
1296{
1297 sector_t target_offset = dm_target_offset(ti, sector);
1298
1299 return ti->len - target_offset;
1300}
1301
1302static sector_t max_io_len(sector_t sector, struct dm_target *ti)
1da177e4 1303{
56a67df7 1304 sector_t len = max_io_len_target_boundary(sector, ti);
542f9038 1305 sector_t offset, max_len;
1da177e4
LT
1306
1307 /*
542f9038 1308 * Does the target need to split even further?
1da177e4 1309 */
542f9038
MS
1310 if (ti->max_io_len) {
1311 offset = dm_target_offset(ti, sector);
1312 if (unlikely(ti->max_io_len & (ti->max_io_len - 1)))
1313 max_len = sector_div(offset, ti->max_io_len);
1314 else
1315 max_len = offset & (ti->max_io_len - 1);
1316 max_len = ti->max_io_len - max_len;
1317
1318 if (len > max_len)
1319 len = max_len;
1da177e4
LT
1320 }
1321
1322 return len;
1323}
1324
542f9038
MS
1325int dm_set_target_max_io_len(struct dm_target *ti, sector_t len)
1326{
1327 if (len > UINT_MAX) {
1328 DMERR("Specified maximum size of target IO (%llu) exceeds limit (%u)",
1329 (unsigned long long)len, UINT_MAX);
1330 ti->error = "Maximum size of target IO is too large";
1331 return -EINVAL;
1332 }
1333
1334 ti->max_io_len = (uint32_t) len;
1335
1336 return 0;
1337}
1338EXPORT_SYMBOL_GPL(dm_set_target_max_io_len);
1339
1dd40c3e
MP
1340/*
1341 * A target may call dm_accept_partial_bio only from the map routine. It is
1342 * allowed for all bio types except REQ_FLUSH.
1343 *
1344 * dm_accept_partial_bio informs the dm that the target only wants to process
1345 * additional n_sectors sectors of the bio and the rest of the data should be
1346 * sent in a next bio.
1347 *
1348 * A diagram that explains the arithmetics:
1349 * +--------------------+---------------+-------+
1350 * | 1 | 2 | 3 |
1351 * +--------------------+---------------+-------+
1352 *
1353 * <-------------- *tio->len_ptr --------------->
1354 * <------- bi_size ------->
1355 * <-- n_sectors -->
1356 *
1357 * Region 1 was already iterated over with bio_advance or similar function.
1358 * (it may be empty if the target doesn't use bio_advance)
1359 * Region 2 is the remaining bio size that the target wants to process.
1360 * (it may be empty if region 1 is non-empty, although there is no reason
1361 * to make it empty)
1362 * The target requires that region 3 is to be sent in the next bio.
1363 *
1364 * If the target wants to receive multiple copies of the bio (via num_*bios, etc),
1365 * the partially processed part (the sum of regions 1+2) must be the same for all
1366 * copies of the bio.
1367 */
1368void dm_accept_partial_bio(struct bio *bio, unsigned n_sectors)
1369{
1370 struct dm_target_io *tio = container_of(bio, struct dm_target_io, clone);
1371 unsigned bi_size = bio->bi_iter.bi_size >> SECTOR_SHIFT;
1372 BUG_ON(bio->bi_rw & REQ_FLUSH);
1373 BUG_ON(bi_size > *tio->len_ptr);
1374 BUG_ON(n_sectors > bi_size);
1375 *tio->len_ptr -= bi_size - n_sectors;
1376 bio->bi_iter.bi_size = n_sectors << SECTOR_SHIFT;
1377}
1378EXPORT_SYMBOL_GPL(dm_accept_partial_bio);
1379
bd2a49b8 1380static void __map_bio(struct dm_target_io *tio)
1da177e4
LT
1381{
1382 int r;
2056a782 1383 sector_t sector;
9faf400f 1384 struct mapped_device *md;
dba14160 1385 struct bio *clone = &tio->clone;
bd2a49b8 1386 struct dm_target *ti = tio->ti;
1da177e4 1387
1da177e4 1388 clone->bi_end_io = clone_endio;
1da177e4
LT
1389
1390 /*
1391 * Map the clone. If r == 0 we don't need to do
1392 * anything, the target has assumed ownership of
1393 * this io.
1394 */
1395 atomic_inc(&tio->io->io_count);
4f024f37 1396 sector = clone->bi_iter.bi_sector;
7de3ee57 1397 r = ti->type->map(ti, clone);
45cbcd79 1398 if (r == DM_MAPIO_REMAPPED) {
1da177e4 1399 /* the bio has been remapped so dispatch it */
2056a782 1400
d07335e5
MS
1401 trace_block_bio_remap(bdev_get_queue(clone->bi_bdev), clone,
1402 tio->io->bio->bi_bdev->bd_dev, sector);
2056a782 1403
1da177e4 1404 generic_make_request(clone);
2e93ccc1
KU
1405 } else if (r < 0 || r == DM_MAPIO_REQUEUE) {
1406 /* error the io and bail out, or requeue it if needed */
9faf400f
SB
1407 md = tio->io->md;
1408 dec_pending(tio->io, r);
9faf400f 1409 free_tio(md, tio);
45cbcd79
KU
1410 } else if (r) {
1411 DMWARN("unimplemented target map return value: %d", r);
1412 BUG();
1da177e4
LT
1413 }
1414}
1415
1416struct clone_info {
1417 struct mapped_device *md;
1418 struct dm_table *map;
1419 struct bio *bio;
1420 struct dm_io *io;
1421 sector_t sector;
e0d6609a 1422 unsigned sector_count;
1da177e4
LT
1423};
1424
e0d6609a 1425static void bio_setup_sector(struct bio *bio, sector_t sector, unsigned len)
bd2a49b8 1426{
4f024f37
KO
1427 bio->bi_iter.bi_sector = sector;
1428 bio->bi_iter.bi_size = to_bytes(len);
1da177e4
LT
1429}
1430
1431/*
1432 * Creates a bio that consists of range of complete bvecs.
1433 */
dba14160 1434static void clone_bio(struct dm_target_io *tio, struct bio *bio,
1c3b13e6 1435 sector_t sector, unsigned len)
1da177e4 1436{
dba14160 1437 struct bio *clone = &tio->clone;
1da177e4 1438
1c3b13e6
KO
1439 __bio_clone_fast(clone, bio);
1440
1441 if (bio_integrity(bio))
1442 bio_integrity_clone(clone, bio, GFP_NOIO);
bd2a49b8 1443
1c3b13e6
KO
1444 bio_advance(clone, to_bytes(sector - clone->bi_iter.bi_sector));
1445 clone->bi_iter.bi_size = to_bytes(len);
1446
1447 if (bio_integrity(bio))
1448 bio_integrity_trim(clone, 0, len);
1da177e4
LT
1449}
1450
9015df24 1451static struct dm_target_io *alloc_tio(struct clone_info *ci,
99778273 1452 struct dm_target *ti,
55a62eef 1453 unsigned target_bio_nr)
f9ab94ce 1454{
dba14160
MP
1455 struct dm_target_io *tio;
1456 struct bio *clone;
1457
99778273 1458 clone = bio_alloc_bioset(GFP_NOIO, 0, ci->md->bs);
dba14160 1459 tio = container_of(clone, struct dm_target_io, clone);
f9ab94ce
MP
1460
1461 tio->io = ci->io;
1462 tio->ti = ti;
55a62eef 1463 tio->target_bio_nr = target_bio_nr;
9015df24
AK
1464
1465 return tio;
1466}
1467
14fe594d
AK
1468static void __clone_and_map_simple_bio(struct clone_info *ci,
1469 struct dm_target *ti,
1dd40c3e 1470 unsigned target_bio_nr, unsigned *len)
9015df24 1471{
99778273 1472 struct dm_target_io *tio = alloc_tio(ci, ti, target_bio_nr);
dba14160 1473 struct bio *clone = &tio->clone;
9015df24 1474
1dd40c3e
MP
1475 tio->len_ptr = len;
1476
99778273 1477 __bio_clone_fast(clone, ci->bio);
bd2a49b8 1478 if (len)
1dd40c3e 1479 bio_setup_sector(clone, ci->sector, *len);
f9ab94ce 1480
bd2a49b8 1481 __map_bio(tio);
f9ab94ce
MP
1482}
1483
14fe594d 1484static void __send_duplicate_bios(struct clone_info *ci, struct dm_target *ti,
1dd40c3e 1485 unsigned num_bios, unsigned *len)
06a426ce 1486{
55a62eef 1487 unsigned target_bio_nr;
06a426ce 1488
55a62eef 1489 for (target_bio_nr = 0; target_bio_nr < num_bios; target_bio_nr++)
14fe594d 1490 __clone_and_map_simple_bio(ci, ti, target_bio_nr, len);
06a426ce
MS
1491}
1492
14fe594d 1493static int __send_empty_flush(struct clone_info *ci)
f9ab94ce 1494{
06a426ce 1495 unsigned target_nr = 0;
f9ab94ce
MP
1496 struct dm_target *ti;
1497
b372d360 1498 BUG_ON(bio_has_data(ci->bio));
f9ab94ce 1499 while ((ti = dm_table_get_target(ci->map, target_nr++)))
1dd40c3e 1500 __send_duplicate_bios(ci, ti, ti->num_flush_bios, NULL);
f9ab94ce 1501
f9ab94ce
MP
1502 return 0;
1503}
1504
e4c93811 1505static void __clone_and_map_data_bio(struct clone_info *ci, struct dm_target *ti,
1dd40c3e 1506 sector_t sector, unsigned *len)
5ae89a87 1507{
dba14160 1508 struct bio *bio = ci->bio;
5ae89a87 1509 struct dm_target_io *tio;
b0d8ed4d
AK
1510 unsigned target_bio_nr;
1511 unsigned num_target_bios = 1;
5ae89a87 1512
b0d8ed4d
AK
1513 /*
1514 * Does the target want to receive duplicate copies of the bio?
1515 */
1516 if (bio_data_dir(bio) == WRITE && ti->num_write_bios)
1517 num_target_bios = ti->num_write_bios(ti, bio);
e4c93811 1518
b0d8ed4d 1519 for (target_bio_nr = 0; target_bio_nr < num_target_bios; target_bio_nr++) {
99778273 1520 tio = alloc_tio(ci, ti, target_bio_nr);
1dd40c3e
MP
1521 tio->len_ptr = len;
1522 clone_bio(tio, bio, sector, *len);
b0d8ed4d
AK
1523 __map_bio(tio);
1524 }
5ae89a87
MS
1525}
1526
55a62eef 1527typedef unsigned (*get_num_bios_fn)(struct dm_target *ti);
23508a96 1528
55a62eef 1529static unsigned get_num_discard_bios(struct dm_target *ti)
23508a96 1530{
55a62eef 1531 return ti->num_discard_bios;
23508a96
MS
1532}
1533
55a62eef 1534static unsigned get_num_write_same_bios(struct dm_target *ti)
23508a96 1535{
55a62eef 1536 return ti->num_write_same_bios;
23508a96
MS
1537}
1538
1539typedef bool (*is_split_required_fn)(struct dm_target *ti);
1540
1541static bool is_split_required_for_discard(struct dm_target *ti)
1542{
55a62eef 1543 return ti->split_discard_bios;
23508a96
MS
1544}
1545
14fe594d
AK
1546static int __send_changing_extent_only(struct clone_info *ci,
1547 get_num_bios_fn get_num_bios,
1548 is_split_required_fn is_split_required)
5ae89a87
MS
1549{
1550 struct dm_target *ti;
e0d6609a 1551 unsigned len;
55a62eef 1552 unsigned num_bios;
5ae89a87 1553
a79245b3
MS
1554 do {
1555 ti = dm_table_find_target(ci->map, ci->sector);
1556 if (!dm_target_is_valid(ti))
1557 return -EIO;
5ae89a87 1558
5ae89a87 1559 /*
23508a96
MS
1560 * Even though the device advertised support for this type of
1561 * request, that does not mean every target supports it, and
936688d7 1562 * reconfiguration might also have changed that since the
a79245b3 1563 * check was performed.
5ae89a87 1564 */
55a62eef
AK
1565 num_bios = get_num_bios ? get_num_bios(ti) : 0;
1566 if (!num_bios)
a79245b3 1567 return -EOPNOTSUPP;
5ae89a87 1568
23508a96 1569 if (is_split_required && !is_split_required(ti))
e0d6609a 1570 len = min((sector_t)ci->sector_count, max_io_len_target_boundary(ci->sector, ti));
7acf0277 1571 else
e0d6609a 1572 len = min((sector_t)ci->sector_count, max_io_len(ci->sector, ti));
06a426ce 1573
1dd40c3e 1574 __send_duplicate_bios(ci, ti, num_bios, &len);
a79245b3
MS
1575
1576 ci->sector += len;
1577 } while (ci->sector_count -= len);
5ae89a87
MS
1578
1579 return 0;
1580}
1581
14fe594d 1582static int __send_discard(struct clone_info *ci)
23508a96 1583{
14fe594d
AK
1584 return __send_changing_extent_only(ci, get_num_discard_bios,
1585 is_split_required_for_discard);
23508a96
MS
1586}
1587
14fe594d 1588static int __send_write_same(struct clone_info *ci)
23508a96 1589{
14fe594d 1590 return __send_changing_extent_only(ci, get_num_write_same_bios, NULL);
23508a96
MS
1591}
1592
e4c93811
AK
1593/*
1594 * Select the correct strategy for processing a non-flush bio.
1595 */
14fe594d 1596static int __split_and_process_non_flush(struct clone_info *ci)
1da177e4 1597{
dba14160 1598 struct bio *bio = ci->bio;
512875bd 1599 struct dm_target *ti;
1c3b13e6 1600 unsigned len;
1da177e4 1601
5ae89a87 1602 if (unlikely(bio->bi_rw & REQ_DISCARD))
14fe594d 1603 return __send_discard(ci);
23508a96 1604 else if (unlikely(bio->bi_rw & REQ_WRITE_SAME))
14fe594d 1605 return __send_write_same(ci);
5ae89a87 1606
512875bd
JN
1607 ti = dm_table_find_target(ci->map, ci->sector);
1608 if (!dm_target_is_valid(ti))
1609 return -EIO;
1610
1c3b13e6 1611 len = min_t(sector_t, max_io_len(ci->sector, ti), ci->sector_count);
1da177e4 1612
1dd40c3e 1613 __clone_and_map_data_bio(ci, ti, ci->sector, &len);
1da177e4 1614
1c3b13e6
KO
1615 ci->sector += len;
1616 ci->sector_count -= len;
1da177e4 1617
1c3b13e6 1618 return 0;
1da177e4
LT
1619}
1620
1621/*
14fe594d 1622 * Entry point to split a bio into clones and submit them to the targets.
1da177e4 1623 */
83d5e5b0
MP
1624static void __split_and_process_bio(struct mapped_device *md,
1625 struct dm_table *map, struct bio *bio)
1da177e4
LT
1626{
1627 struct clone_info ci;
512875bd 1628 int error = 0;
1da177e4 1629
83d5e5b0 1630 if (unlikely(!map)) {
6a8736d1 1631 bio_io_error(bio);
f0b9a450
MP
1632 return;
1633 }
692d0eb9 1634
83d5e5b0 1635 ci.map = map;
1da177e4 1636 ci.md = md;
1da177e4
LT
1637 ci.io = alloc_io(md);
1638 ci.io->error = 0;
1639 atomic_set(&ci.io->io_count, 1);
1640 ci.io->bio = bio;
1641 ci.io->md = md;
f88fb981 1642 spin_lock_init(&ci.io->endio_lock);
4f024f37 1643 ci.sector = bio->bi_iter.bi_sector;
1da177e4 1644
3eaf840e 1645 start_io_acct(ci.io);
bd2a49b8 1646
b372d360
MS
1647 if (bio->bi_rw & REQ_FLUSH) {
1648 ci.bio = &ci.md->flush_bio;
1649 ci.sector_count = 0;
14fe594d 1650 error = __send_empty_flush(&ci);
b372d360
MS
1651 /* dec_pending submits any data associated with flush */
1652 } else {
6a8736d1 1653 ci.bio = bio;
d87f4c14 1654 ci.sector_count = bio_sectors(bio);
b372d360 1655 while (ci.sector_count && !error)
14fe594d 1656 error = __split_and_process_non_flush(&ci);
d87f4c14 1657 }
1da177e4
LT
1658
1659 /* drop the extra reference count */
512875bd 1660 dec_pending(ci.io, error);
1da177e4
LT
1661}
1662/*-----------------------------------------------------------------
1663 * CRUD END
1664 *---------------------------------------------------------------*/
1665
f6fccb12
MB
1666static int dm_merge_bvec(struct request_queue *q,
1667 struct bvec_merge_data *bvm,
1668 struct bio_vec *biovec)
1669{
1670 struct mapped_device *md = q->queuedata;
83d5e5b0 1671 struct dm_table *map = dm_get_live_table_fast(md);
f6fccb12 1672 struct dm_target *ti;
1c220c69 1673 sector_t max_sectors, max_size = 0;
f6fccb12
MB
1674
1675 if (unlikely(!map))
5037108a 1676 goto out;
f6fccb12
MB
1677
1678 ti = dm_table_find_target(map, bvm->bi_sector);
b01cd5ac 1679 if (!dm_target_is_valid(ti))
83d5e5b0 1680 goto out;
f6fccb12
MB
1681
1682 /*
1683 * Find maximum amount of I/O that won't need splitting
1684 */
56a67df7 1685 max_sectors = min(max_io_len(bvm->bi_sector, ti),
148e51ba 1686 (sector_t) queue_max_sectors(q));
f6fccb12 1687 max_size = (max_sectors << SECTOR_SHIFT) - bvm->bi_size;
1c220c69
JT
1688
1689 /*
1690 * FIXME: this stop-gap fix _must_ be cleaned up (by passing a sector_t
1691 * to the targets' merge function since it holds sectors not bytes).
1692 * Just doing this as an interim fix for stable@ because the more
1693 * comprehensive cleanup of switching to sector_t will impact every
1694 * DM target that implements a ->merge hook.
1695 */
1696 if (max_size > INT_MAX)
1697 max_size = INT_MAX;
f6fccb12
MB
1698
1699 /*
1700 * merge_bvec_fn() returns number of bytes
1701 * it can accept at this offset
1702 * max is precomputed maximal io size
1703 */
1704 if (max_size && ti->type->merge)
1c220c69 1705 max_size = ti->type->merge(ti, bvm, biovec, (int) max_size);
8cbeb67a
MP
1706 /*
1707 * If the target doesn't support merge method and some of the devices
148e51ba
MS
1708 * provided their merge_bvec method (we know this by looking for the
1709 * max_hw_sectors that dm_set_device_limits may set), then we can't
1710 * allow bios with multiple vector entries. So always set max_size
1711 * to 0, and the code below allows just one page.
8cbeb67a
MP
1712 */
1713 else if (queue_max_hw_sectors(q) <= PAGE_SIZE >> 9)
8cbeb67a 1714 max_size = 0;
f6fccb12 1715
5037108a 1716out:
83d5e5b0 1717 dm_put_live_table_fast(md);
f6fccb12
MB
1718 /*
1719 * Always allow an entire first page
1720 */
1721 if (max_size <= biovec->bv_len && !(bvm->bi_size >> SECTOR_SHIFT))
1722 max_size = biovec->bv_len;
1723
f6fccb12
MB
1724 return max_size;
1725}
1726
1da177e4
LT
1727/*
1728 * The request function that just remaps the bio built up by
1729 * dm_merge_bvec.
1730 */
ff36ab34 1731static void dm_make_request(struct request_queue *q, struct bio *bio)
1da177e4 1732{
12f03a49 1733 int rw = bio_data_dir(bio);
1da177e4 1734 struct mapped_device *md = q->queuedata;
83d5e5b0
MP
1735 int srcu_idx;
1736 struct dm_table *map;
1da177e4 1737
83d5e5b0 1738 map = dm_get_live_table(md, &srcu_idx);
1da177e4 1739
18c0b223 1740 generic_start_io_acct(rw, bio_sectors(bio), &dm_disk(md)->part0);
12f03a49 1741
6a8736d1
TH
1742 /* if we're suspended, we have to queue this io for later */
1743 if (unlikely(test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags))) {
83d5e5b0 1744 dm_put_live_table(md, srcu_idx);
1da177e4 1745
6a8736d1
TH
1746 if (bio_rw(bio) != READA)
1747 queue_io(md, bio);
1748 else
54d9a1b4 1749 bio_io_error(bio);
5a7bbad2 1750 return;
1da177e4
LT
1751 }
1752
83d5e5b0
MP
1753 __split_and_process_bio(md, map, bio);
1754 dm_put_live_table(md, srcu_idx);
5a7bbad2 1755 return;
cec47e3d
KU
1756}
1757
fd2ed4d2 1758int dm_request_based(struct mapped_device *md)
cec47e3d
KU
1759{
1760 return blk_queue_stackable(md->queue);
1761}
1762
466d89a6 1763static void dm_dispatch_clone_request(struct request *clone, struct request *rq)
cec47e3d
KU
1764{
1765 int r;
1766
466d89a6
KB
1767 if (blk_queue_io_stat(clone->q))
1768 clone->cmd_flags |= REQ_IO_STAT;
cec47e3d 1769
466d89a6
KB
1770 clone->start_time = jiffies;
1771 r = blk_insert_cloned_request(clone->q, clone);
cec47e3d 1772 if (r)
466d89a6 1773 /* must complete clone in terms of original request */
cec47e3d
KU
1774 dm_complete_request(rq, r);
1775}
cec47e3d 1776
5f1b670d
CH
1777static void setup_clone(struct request *clone, struct request *rq,
1778 struct dm_rq_target_io *tio)
cec47e3d 1779{
5f1b670d 1780 blk_rq_prep_clone(clone, rq);
cec47e3d
KU
1781 clone->end_io = end_clone_request;
1782 clone->end_io_data = tio;
1ae49ea2 1783 tio->clone = clone;
cec47e3d
KU
1784}
1785
6facdaff 1786static struct request *clone_rq(struct request *rq, struct mapped_device *md,
466d89a6 1787 struct dm_rq_target_io *tio, gfp_t gfp_mask)
1ae49ea2 1788{
02233342
MS
1789 /*
1790 * Do not allocate a clone if tio->clone was already set
1791 * (see: dm_mq_queue_rq).
1792 */
1793 bool alloc_clone = !tio->clone;
1794 struct request *clone;
1ae49ea2 1795
02233342
MS
1796 if (alloc_clone) {
1797 clone = alloc_clone_request(md, gfp_mask);
1798 if (!clone)
1799 return NULL;
1800 } else
1801 clone = tio->clone;
1ae49ea2
MS
1802
1803 blk_rq_init(NULL, clone);
5f1b670d 1804 setup_clone(clone, rq, tio);
1ae49ea2
MS
1805
1806 return clone;
1807}
1808
2eb6e1e3
KB
1809static void map_tio_request(struct kthread_work *work);
1810
bfebd1cd
MS
1811static void init_tio(struct dm_rq_target_io *tio, struct request *rq,
1812 struct mapped_device *md)
1813{
1814 tio->md = md;
1815 tio->ti = NULL;
1816 tio->clone = NULL;
1817 tio->orig = rq;
1818 tio->error = 0;
1819 memset(&tio->info, 0, sizeof(tio->info));
02233342
MS
1820 if (md->kworker_task)
1821 init_kthread_work(&tio->work, map_tio_request);
bfebd1cd
MS
1822}
1823
466d89a6
KB
1824static struct dm_rq_target_io *prep_tio(struct request *rq,
1825 struct mapped_device *md, gfp_t gfp_mask)
6facdaff 1826{
6facdaff 1827 struct dm_rq_target_io *tio;
e5863d9a
MS
1828 int srcu_idx;
1829 struct dm_table *table;
6facdaff
KU
1830
1831 tio = alloc_rq_tio(md, gfp_mask);
1832 if (!tio)
1833 return NULL;
1834
bfebd1cd 1835 init_tio(tio, rq, md);
6facdaff 1836
e5863d9a
MS
1837 table = dm_get_live_table(md, &srcu_idx);
1838 if (!dm_table_mq_request_based(table)) {
1839 if (!clone_rq(rq, md, tio, gfp_mask)) {
1840 dm_put_live_table(md, srcu_idx);
1841 free_rq_tio(tio);
1842 return NULL;
1843 }
6facdaff 1844 }
e5863d9a 1845 dm_put_live_table(md, srcu_idx);
6facdaff 1846
466d89a6 1847 return tio;
6facdaff
KU
1848}
1849
cec47e3d
KU
1850/*
1851 * Called with the queue lock held.
1852 */
1853static int dm_prep_fn(struct request_queue *q, struct request *rq)
1854{
1855 struct mapped_device *md = q->queuedata;
466d89a6 1856 struct dm_rq_target_io *tio;
cec47e3d 1857
cec47e3d
KU
1858 if (unlikely(rq->special)) {
1859 DMWARN("Already has something in rq->special.");
1860 return BLKPREP_KILL;
1861 }
1862
466d89a6
KB
1863 tio = prep_tio(rq, md, GFP_ATOMIC);
1864 if (!tio)
cec47e3d 1865 return BLKPREP_DEFER;
cec47e3d 1866
466d89a6 1867 rq->special = tio;
cec47e3d
KU
1868 rq->cmd_flags |= REQ_DONTPREP;
1869
1870 return BLKPREP_OK;
1871}
1872
9eef87da
KU
1873/*
1874 * Returns:
e5863d9a
MS
1875 * 0 : the request has been processed
1876 * DM_MAPIO_REQUEUE : the original request needs to be requeued
1877 * < 0 : the request was completed due to failure
9eef87da 1878 */
bfebd1cd 1879static int map_request(struct dm_rq_target_io *tio, struct request *rq,
9eef87da 1880 struct mapped_device *md)
cec47e3d 1881{
e5863d9a 1882 int r;
bfebd1cd 1883 struct dm_target *ti = tio->ti;
e5863d9a
MS
1884 struct request *clone = NULL;
1885
1886 if (tio->clone) {
1887 clone = tio->clone;
1888 r = ti->type->map_rq(ti, clone, &tio->info);
1889 } else {
1890 r = ti->type->clone_and_map_rq(ti, rq, &tio->info, &clone);
1891 if (r < 0) {
1892 /* The target wants to complete the I/O */
1893 dm_kill_unmapped_request(rq, r);
1894 return r;
1895 }
3a140755
JN
1896 if (r != DM_MAPIO_REMAPPED)
1897 return r;
5f1b670d 1898 setup_clone(clone, rq, tio);
e5863d9a 1899 }
cec47e3d 1900
cec47e3d
KU
1901 switch (r) {
1902 case DM_MAPIO_SUBMITTED:
1903 /* The target has taken the I/O to submit by itself later */
1904 break;
1905 case DM_MAPIO_REMAPPED:
1906 /* The target has remapped the I/O so dispatch it */
6db4ccd6 1907 trace_block_rq_remap(clone->q, clone, disk_devt(dm_disk(md)),
466d89a6
KB
1908 blk_rq_pos(rq));
1909 dm_dispatch_clone_request(clone, rq);
cec47e3d
KU
1910 break;
1911 case DM_MAPIO_REQUEUE:
1912 /* The target wants to requeue the I/O */
1913 dm_requeue_unmapped_request(clone);
1914 break;
1915 default:
1916 if (r > 0) {
1917 DMWARN("unimplemented target map return value: %d", r);
1918 BUG();
1919 }
1920
1921 /* The target wants to complete the I/O */
466d89a6 1922 dm_kill_unmapped_request(rq, r);
e5863d9a 1923 return r;
cec47e3d 1924 }
9eef87da 1925
e5863d9a 1926 return 0;
cec47e3d
KU
1927}
1928
2eb6e1e3 1929static void map_tio_request(struct kthread_work *work)
ba1cbad9 1930{
2eb6e1e3 1931 struct dm_rq_target_io *tio = container_of(work, struct dm_rq_target_io, work);
e5863d9a
MS
1932 struct request *rq = tio->orig;
1933 struct mapped_device *md = tio->md;
ba1cbad9 1934
bfebd1cd 1935 if (map_request(tio, rq, md) == DM_MAPIO_REQUEUE)
e5863d9a 1936 dm_requeue_unmapped_original_request(md, rq);
2eb6e1e3
KB
1937}
1938
466d89a6 1939static void dm_start_request(struct mapped_device *md, struct request *orig)
ba1cbad9 1940{
bfebd1cd
MS
1941 if (!orig->q->mq_ops)
1942 blk_start_request(orig);
1943 else
1944 blk_mq_start_request(orig);
466d89a6 1945 atomic_inc(&md->pending[rq_data_dir(orig)]);
ba1cbad9 1946
0ce65797
MS
1947 if (md->seq_rq_merge_deadline_usecs) {
1948 md->last_rq_pos = rq_end_sector(orig);
1949 md->last_rq_rw = rq_data_dir(orig);
1950 md->last_rq_start_time = ktime_get();
1951 }
de3ec86d 1952
ba1cbad9
MS
1953 /*
1954 * Hold the md reference here for the in-flight I/O.
1955 * We can't rely on the reference count by device opener,
1956 * because the device may be closed during the request completion
1957 * when all bios are completed.
1958 * See the comment in rq_completed() too.
1959 */
1960 dm_get(md);
ba1cbad9
MS
1961}
1962
0ce65797
MS
1963#define MAX_SEQ_RQ_MERGE_DEADLINE_USECS 100000
1964
1965ssize_t dm_attr_rq_based_seq_io_merge_deadline_show(struct mapped_device *md, char *buf)
1966{
1967 return sprintf(buf, "%u\n", md->seq_rq_merge_deadline_usecs);
1968}
1969
1970ssize_t dm_attr_rq_based_seq_io_merge_deadline_store(struct mapped_device *md,
1971 const char *buf, size_t count)
1972{
1973 unsigned deadline;
1974
17e149b8 1975 if (!dm_request_based(md) || md->use_blk_mq)
0ce65797
MS
1976 return count;
1977
1978 if (kstrtouint(buf, 10, &deadline))
1979 return -EINVAL;
1980
1981 if (deadline > MAX_SEQ_RQ_MERGE_DEADLINE_USECS)
1982 deadline = MAX_SEQ_RQ_MERGE_DEADLINE_USECS;
1983
1984 md->seq_rq_merge_deadline_usecs = deadline;
1985
1986 return count;
1987}
1988
1989static bool dm_request_peeked_before_merge_deadline(struct mapped_device *md)
1990{
1991 ktime_t kt_deadline;
1992
1993 if (!md->seq_rq_merge_deadline_usecs)
1994 return false;
1995
1996 kt_deadline = ns_to_ktime((u64)md->seq_rq_merge_deadline_usecs * NSEC_PER_USEC);
1997 kt_deadline = ktime_add_safe(md->last_rq_start_time, kt_deadline);
1998
1999 return !ktime_after(ktime_get(), kt_deadline);
2000}
2001
cec47e3d
KU
2002/*
2003 * q->request_fn for request-based dm.
2004 * Called with the queue lock held.
2005 */
2006static void dm_request_fn(struct request_queue *q)
2007{
2008 struct mapped_device *md = q->queuedata;
83d5e5b0
MP
2009 int srcu_idx;
2010 struct dm_table *map = dm_get_live_table(md, &srcu_idx);
cec47e3d 2011 struct dm_target *ti;
466d89a6 2012 struct request *rq;
2eb6e1e3 2013 struct dm_rq_target_io *tio;
29e4013d 2014 sector_t pos;
cec47e3d
KU
2015
2016 /*
b4324fee
KU
2017 * For suspend, check blk_queue_stopped() and increment
2018 * ->pending within a single queue_lock not to increment the
2019 * number of in-flight I/Os after the queue is stopped in
2020 * dm_suspend().
cec47e3d 2021 */
7eaceacc 2022 while (!blk_queue_stopped(q)) {
cec47e3d
KU
2023 rq = blk_peek_request(q);
2024 if (!rq)
9d1deb83 2025 goto out;
cec47e3d 2026
29e4013d
TH
2027 /* always use block 0 to find the target for flushes for now */
2028 pos = 0;
2029 if (!(rq->cmd_flags & REQ_FLUSH))
2030 pos = blk_rq_pos(rq);
2031
2032 ti = dm_table_find_target(map, pos);
ba1cbad9
MS
2033 if (!dm_target_is_valid(ti)) {
2034 /*
466d89a6 2035 * Must perform setup, that rq_completed() requires,
ba1cbad9
MS
2036 * before calling dm_kill_unmapped_request
2037 */
2038 DMERR_LIMIT("request attempted access beyond the end of device");
466d89a6
KB
2039 dm_start_request(md, rq);
2040 dm_kill_unmapped_request(rq, -EIO);
ba1cbad9
MS
2041 continue;
2042 }
d0bcb878 2043
0ce65797
MS
2044 if (dm_request_peeked_before_merge_deadline(md) &&
2045 md_in_flight(md) && rq->bio && rq->bio->bi_vcnt == 1 &&
de3ec86d
MS
2046 md->last_rq_pos == pos && md->last_rq_rw == rq_data_dir(rq))
2047 goto delay_and_out;
2048
cec47e3d 2049 if (ti->type->busy && ti->type->busy(ti))
7eaceacc 2050 goto delay_and_out;
cec47e3d 2051
466d89a6 2052 dm_start_request(md, rq);
9eef87da 2053
bfebd1cd 2054 tio = tio_from_request(rq);
2eb6e1e3
KB
2055 /* Establish tio->ti before queuing work (map_tio_request) */
2056 tio->ti = ti;
2057 queue_kthread_work(&md->kworker, &tio->work);
052189a2 2058 BUG_ON(!irqs_disabled());
cec47e3d
KU
2059 }
2060
2061 goto out;
2062
7eaceacc 2063delay_and_out:
d548b34b 2064 blk_delay_queue(q, HZ / 100);
cec47e3d 2065out:
83d5e5b0 2066 dm_put_live_table(md, srcu_idx);
cec47e3d
KU
2067}
2068
1da177e4
LT
2069static int dm_any_congested(void *congested_data, int bdi_bits)
2070{
8a57dfc6
CS
2071 int r = bdi_bits;
2072 struct mapped_device *md = congested_data;
2073 struct dm_table *map;
1da177e4 2074
1eb787ec 2075 if (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
83d5e5b0 2076 map = dm_get_live_table_fast(md);
8a57dfc6 2077 if (map) {
cec47e3d
KU
2078 /*
2079 * Request-based dm cares about only own queue for
2080 * the query about congestion status of request_queue
2081 */
2082 if (dm_request_based(md))
2083 r = md->queue->backing_dev_info.state &
2084 bdi_bits;
2085 else
2086 r = dm_table_any_congested(map, bdi_bits);
8a57dfc6 2087 }
83d5e5b0 2088 dm_put_live_table_fast(md);
8a57dfc6
CS
2089 }
2090
1da177e4
LT
2091 return r;
2092}
2093
2094/*-----------------------------------------------------------------
2095 * An IDR is used to keep track of allocated minor numbers.
2096 *---------------------------------------------------------------*/
2b06cfff 2097static void free_minor(int minor)
1da177e4 2098{
f32c10b0 2099 spin_lock(&_minor_lock);
1da177e4 2100 idr_remove(&_minor_idr, minor);
f32c10b0 2101 spin_unlock(&_minor_lock);
1da177e4
LT
2102}
2103
2104/*
2105 * See if the device with a specific minor # is free.
2106 */
cf13ab8e 2107static int specific_minor(int minor)
1da177e4 2108{
c9d76be6 2109 int r;
1da177e4
LT
2110
2111 if (minor >= (1 << MINORBITS))
2112 return -EINVAL;
2113
c9d76be6 2114 idr_preload(GFP_KERNEL);
f32c10b0 2115 spin_lock(&_minor_lock);
1da177e4 2116
c9d76be6 2117 r = idr_alloc(&_minor_idr, MINOR_ALLOCED, minor, minor + 1, GFP_NOWAIT);
1da177e4 2118
f32c10b0 2119 spin_unlock(&_minor_lock);
c9d76be6
TH
2120 idr_preload_end();
2121 if (r < 0)
2122 return r == -ENOSPC ? -EBUSY : r;
2123 return 0;
1da177e4
LT
2124}
2125
cf13ab8e 2126static int next_free_minor(int *minor)
1da177e4 2127{
c9d76be6 2128 int r;
62f75c2f 2129
c9d76be6 2130 idr_preload(GFP_KERNEL);
f32c10b0 2131 spin_lock(&_minor_lock);
1da177e4 2132
c9d76be6 2133 r = idr_alloc(&_minor_idr, MINOR_ALLOCED, 0, 1 << MINORBITS, GFP_NOWAIT);
1da177e4 2134
f32c10b0 2135 spin_unlock(&_minor_lock);
c9d76be6
TH
2136 idr_preload_end();
2137 if (r < 0)
2138 return r;
2139 *minor = r;
2140 return 0;
1da177e4
LT
2141}
2142
83d5cde4 2143static const struct block_device_operations dm_blk_dops;
1da177e4 2144
53d5914f
MP
2145static void dm_wq_work(struct work_struct *work);
2146
4a0b4ddf
MS
2147static void dm_init_md_queue(struct mapped_device *md)
2148{
2149 /*
2150 * Request-based dm devices cannot be stacked on top of bio-based dm
bfebd1cd 2151 * devices. The type of this dm device may not have been decided yet.
4a0b4ddf
MS
2152 * The type is decided at the first table loading time.
2153 * To prevent problematic device stacking, clear the queue flag
2154 * for request stacking support until then.
2155 *
2156 * This queue is new, so no concurrency on the queue_flags.
2157 */
2158 queue_flag_clear_unlocked(QUEUE_FLAG_STACKABLE, md->queue);
bfebd1cd 2159}
4a0b4ddf 2160
bfebd1cd
MS
2161static void dm_init_old_md_queue(struct mapped_device *md)
2162{
17e149b8 2163 md->use_blk_mq = false;
bfebd1cd
MS
2164 dm_init_md_queue(md);
2165
2166 /*
2167 * Initialize aspects of queue that aren't relevant for blk-mq
2168 */
4a0b4ddf
MS
2169 md->queue->queuedata = md;
2170 md->queue->backing_dev_info.congested_fn = dm_any_congested;
2171 md->queue->backing_dev_info.congested_data = md;
ff36ab34 2172
4a0b4ddf 2173 blk_queue_bounce_limit(md->queue, BLK_BOUNCE_ANY);
4a0b4ddf
MS
2174}
2175
1da177e4
LT
2176/*
2177 * Allocate and initialise a blank device with a given minor.
2178 */
2b06cfff 2179static struct mapped_device *alloc_dev(int minor)
1da177e4
LT
2180{
2181 int r;
cf13ab8e 2182 struct mapped_device *md = kzalloc(sizeof(*md), GFP_KERNEL);
ba61fdd1 2183 void *old_md;
1da177e4
LT
2184
2185 if (!md) {
2186 DMWARN("unable to allocate device, out of memory.");
2187 return NULL;
2188 }
2189
10da4f79 2190 if (!try_module_get(THIS_MODULE))
6ed7ade8 2191 goto bad_module_get;
10da4f79 2192
1da177e4 2193 /* get a minor number for the dev */
2b06cfff 2194 if (minor == DM_ANY_MINOR)
cf13ab8e 2195 r = next_free_minor(&minor);
2b06cfff 2196 else
cf13ab8e 2197 r = specific_minor(minor);
1da177e4 2198 if (r < 0)
6ed7ade8 2199 goto bad_minor;
1da177e4 2200
83d5e5b0
MP
2201 r = init_srcu_struct(&md->io_barrier);
2202 if (r < 0)
2203 goto bad_io_barrier;
2204
17e149b8 2205 md->use_blk_mq = use_blk_mq;
a5664dad 2206 md->type = DM_TYPE_NONE;
e61290a4 2207 mutex_init(&md->suspend_lock);
a5664dad 2208 mutex_init(&md->type_lock);
86f1152b 2209 mutex_init(&md->table_devices_lock);
022c2611 2210 spin_lock_init(&md->deferred_lock);
1da177e4 2211 atomic_set(&md->holders, 1);
5c6bd75d 2212 atomic_set(&md->open_count, 0);
1da177e4 2213 atomic_set(&md->event_nr, 0);
7a8c3d3b
MA
2214 atomic_set(&md->uevent_seq, 0);
2215 INIT_LIST_HEAD(&md->uevent_list);
86f1152b 2216 INIT_LIST_HEAD(&md->table_devices);
7a8c3d3b 2217 spin_lock_init(&md->uevent_lock);
1da177e4 2218
4a0b4ddf 2219 md->queue = blk_alloc_queue(GFP_KERNEL);
1da177e4 2220 if (!md->queue)
6ed7ade8 2221 goto bad_queue;
1da177e4 2222
4a0b4ddf 2223 dm_init_md_queue(md);
9faf400f 2224
1da177e4
LT
2225 md->disk = alloc_disk(1);
2226 if (!md->disk)
6ed7ade8 2227 goto bad_disk;
1da177e4 2228
316d315b
NK
2229 atomic_set(&md->pending[0], 0);
2230 atomic_set(&md->pending[1], 0);
f0b04115 2231 init_waitqueue_head(&md->wait);
53d5914f 2232 INIT_WORK(&md->work, dm_wq_work);
f0b04115 2233 init_waitqueue_head(&md->eventq);
2995fa78 2234 init_completion(&md->kobj_holder.completion);
2eb6e1e3 2235 md->kworker_task = NULL;
f0b04115 2236
1da177e4
LT
2237 md->disk->major = _major;
2238 md->disk->first_minor = minor;
2239 md->disk->fops = &dm_blk_dops;
2240 md->disk->queue = md->queue;
2241 md->disk->private_data = md;
2242 sprintf(md->disk->disk_name, "dm-%d", minor);
2243 add_disk(md->disk);
7e51f257 2244 format_dev_t(md->name, MKDEV(_major, minor));
1da177e4 2245
670368a8 2246 md->wq = alloc_workqueue("kdmflush", WQ_MEM_RECLAIM, 0);
304f3f6a
MB
2247 if (!md->wq)
2248 goto bad_thread;
2249
32a926da
MP
2250 md->bdev = bdget_disk(md->disk, 0);
2251 if (!md->bdev)
2252 goto bad_bdev;
2253
6a8736d1
TH
2254 bio_init(&md->flush_bio);
2255 md->flush_bio.bi_bdev = md->bdev;
2256 md->flush_bio.bi_rw = WRITE_FLUSH;
2257
fd2ed4d2
MP
2258 dm_stats_init(&md->stats);
2259
ba61fdd1 2260 /* Populate the mapping, nobody knows we exist yet */
f32c10b0 2261 spin_lock(&_minor_lock);
ba61fdd1 2262 old_md = idr_replace(&_minor_idr, md, minor);
f32c10b0 2263 spin_unlock(&_minor_lock);
ba61fdd1
JM
2264
2265 BUG_ON(old_md != MINOR_ALLOCED);
2266
1da177e4
LT
2267 return md;
2268
32a926da
MP
2269bad_bdev:
2270 destroy_workqueue(md->wq);
304f3f6a 2271bad_thread:
03022c54 2272 del_gendisk(md->disk);
304f3f6a 2273 put_disk(md->disk);
6ed7ade8 2274bad_disk:
1312f40e 2275 blk_cleanup_queue(md->queue);
6ed7ade8 2276bad_queue:
83d5e5b0
MP
2277 cleanup_srcu_struct(&md->io_barrier);
2278bad_io_barrier:
1da177e4 2279 free_minor(minor);
6ed7ade8 2280bad_minor:
10da4f79 2281 module_put(THIS_MODULE);
6ed7ade8 2282bad_module_get:
1da177e4
LT
2283 kfree(md);
2284 return NULL;
2285}
2286
ae9da83f
JN
2287static void unlock_fs(struct mapped_device *md);
2288
1da177e4
LT
2289static void free_dev(struct mapped_device *md)
2290{
f331c029 2291 int minor = MINOR(disk_devt(md->disk));
63d94e48 2292
32a926da 2293 unlock_fs(md);
304f3f6a 2294 destroy_workqueue(md->wq);
2eb6e1e3
KB
2295
2296 if (md->kworker_task)
2297 kthread_stop(md->kworker_task);
e6ee8c0b
KU
2298 if (md->io_pool)
2299 mempool_destroy(md->io_pool);
1ae49ea2
MS
2300 if (md->rq_pool)
2301 mempool_destroy(md->rq_pool);
e6ee8c0b
KU
2302 if (md->bs)
2303 bioset_free(md->bs);
63a4f065 2304
83d5e5b0 2305 cleanup_srcu_struct(&md->io_barrier);
86f1152b 2306 free_table_devices(&md->table_devices);
63a4f065 2307 dm_stats_cleanup(&md->stats);
fba9f90e
JM
2308
2309 spin_lock(&_minor_lock);
2310 md->disk->private_data = NULL;
2311 spin_unlock(&_minor_lock);
63a4f065
MS
2312 if (blk_get_integrity(md->disk))
2313 blk_integrity_unregister(md->disk);
2314 del_gendisk(md->disk);
1da177e4 2315 put_disk(md->disk);
1312f40e 2316 blk_cleanup_queue(md->queue);
17e149b8 2317 if (md->use_blk_mq)
bfebd1cd 2318 blk_mq_free_tag_set(&md->tag_set);
63a4f065
MS
2319 bdput(md->bdev);
2320 free_minor(minor);
2321
10da4f79 2322 module_put(THIS_MODULE);
1da177e4
LT
2323 kfree(md);
2324}
2325
e6ee8c0b
KU
2326static void __bind_mempools(struct mapped_device *md, struct dm_table *t)
2327{
c0820cf5 2328 struct dm_md_mempools *p = dm_table_get_md_mempools(t);
e6ee8c0b 2329
17e149b8 2330 if (md->bs) {
16245bdc
JN
2331 /* The md already has necessary mempools. */
2332 if (dm_table_get_type(t) == DM_TYPE_BIO_BASED) {
2333 /*
2334 * Reload bioset because front_pad may have changed
2335 * because a different table was loaded.
2336 */
2337 bioset_free(md->bs);
2338 md->bs = p->bs;
2339 p->bs = NULL;
16245bdc 2340 }
466d89a6
KB
2341 /*
2342 * There's no need to reload with request-based dm
2343 * because the size of front_pad doesn't change.
2344 * Note for future: If you are to reload bioset,
2345 * prep-ed requests in the queue may refer
2346 * to bio from the old bioset, so you must walk
2347 * through the queue to unprep.
2348 */
e6ee8c0b 2349 goto out;
c0820cf5 2350 }
e6ee8c0b 2351
e6ee8c0b
KU
2352 md->io_pool = p->io_pool;
2353 p->io_pool = NULL;
1ae49ea2
MS
2354 md->rq_pool = p->rq_pool;
2355 p->rq_pool = NULL;
e6ee8c0b
KU
2356 md->bs = p->bs;
2357 p->bs = NULL;
2358
2359out:
02233342 2360 /* mempool bind completed, no longer need any mempools in the table */
e6ee8c0b
KU
2361 dm_table_free_md_mempools(t);
2362}
2363
1da177e4
LT
2364/*
2365 * Bind a table to the device.
2366 */
2367static void event_callback(void *context)
2368{
7a8c3d3b
MA
2369 unsigned long flags;
2370 LIST_HEAD(uevents);
1da177e4
LT
2371 struct mapped_device *md = (struct mapped_device *) context;
2372
7a8c3d3b
MA
2373 spin_lock_irqsave(&md->uevent_lock, flags);
2374 list_splice_init(&md->uevent_list, &uevents);
2375 spin_unlock_irqrestore(&md->uevent_lock, flags);
2376
ed9e1982 2377 dm_send_uevents(&uevents, &disk_to_dev(md->disk)->kobj);
7a8c3d3b 2378
1da177e4
LT
2379 atomic_inc(&md->event_nr);
2380 wake_up(&md->eventq);
2381}
2382
c217649b
MS
2383/*
2384 * Protected by md->suspend_lock obtained by dm_swap_table().
2385 */
4e90188b 2386static void __set_size(struct mapped_device *md, sector_t size)
1da177e4 2387{
4e90188b 2388 set_capacity(md->disk, size);
1da177e4 2389
db8fef4f 2390 i_size_write(md->bdev->bd_inode, (loff_t)size << SECTOR_SHIFT);
1da177e4
LT
2391}
2392
d5b9dd04
MP
2393/*
2394 * Return 1 if the queue has a compulsory merge_bvec_fn function.
2395 *
2396 * If this function returns 0, then the device is either a non-dm
2397 * device without a merge_bvec_fn, or it is a dm device that is
2398 * able to split any bios it receives that are too big.
2399 */
2400int dm_queue_merge_is_compulsory(struct request_queue *q)
2401{
2402 struct mapped_device *dev_md;
2403
2404 if (!q->merge_bvec_fn)
2405 return 0;
2406
ff36ab34 2407 if (q->make_request_fn == dm_make_request) {
d5b9dd04
MP
2408 dev_md = q->queuedata;
2409 if (test_bit(DMF_MERGE_IS_OPTIONAL, &dev_md->flags))
2410 return 0;
2411 }
2412
2413 return 1;
2414}
2415
2416static int dm_device_merge_is_compulsory(struct dm_target *ti,
2417 struct dm_dev *dev, sector_t start,
2418 sector_t len, void *data)
2419{
2420 struct block_device *bdev = dev->bdev;
2421 struct request_queue *q = bdev_get_queue(bdev);
2422
2423 return dm_queue_merge_is_compulsory(q);
2424}
2425
2426/*
2427 * Return 1 if it is acceptable to ignore merge_bvec_fn based
2428 * on the properties of the underlying devices.
2429 */
2430static int dm_table_merge_is_optional(struct dm_table *table)
2431{
2432 unsigned i = 0;
2433 struct dm_target *ti;
2434
2435 while (i < dm_table_get_num_targets(table)) {
2436 ti = dm_table_get_target(table, i++);
2437
2438 if (ti->type->iterate_devices &&
2439 ti->type->iterate_devices(ti, dm_device_merge_is_compulsory, NULL))
2440 return 0;
2441 }
2442
2443 return 1;
2444}
2445
042d2a9b
AK
2446/*
2447 * Returns old map, which caller must destroy.
2448 */
2449static struct dm_table *__bind(struct mapped_device *md, struct dm_table *t,
2450 struct queue_limits *limits)
1da177e4 2451{
042d2a9b 2452 struct dm_table *old_map;
165125e1 2453 struct request_queue *q = md->queue;
1da177e4 2454 sector_t size;
d5b9dd04 2455 int merge_is_optional;
1da177e4
LT
2456
2457 size = dm_table_get_size(t);
3ac51e74
DW
2458
2459 /*
2460 * Wipe any geometry if the size of the table changed.
2461 */
fd2ed4d2 2462 if (size != dm_get_size(md))
3ac51e74
DW
2463 memset(&md->geometry, 0, sizeof(md->geometry));
2464
32a926da 2465 __set_size(md, size);
d5816876 2466
2ca3310e
AK
2467 dm_table_event_callback(t, event_callback, md);
2468
e6ee8c0b
KU
2469 /*
2470 * The queue hasn't been stopped yet, if the old table type wasn't
2471 * for request-based during suspension. So stop it to prevent
2472 * I/O mapping before resume.
2473 * This must be done before setting the queue restrictions,
2474 * because request-based dm may be run just after the setting.
2475 */
bfebd1cd 2476 if (dm_table_request_based(t))
e6ee8c0b
KU
2477 stop_queue(q);
2478
2479 __bind_mempools(md, t);
2480
d5b9dd04
MP
2481 merge_is_optional = dm_table_merge_is_optional(t);
2482
a12f5d48 2483 old_map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
83d5e5b0 2484 rcu_assign_pointer(md->map, t);
36a0456f
AK
2485 md->immutable_target_type = dm_table_get_immutable_target_type(t);
2486
754c5fc7 2487 dm_table_set_restrictions(t, q, limits);
d5b9dd04
MP
2488 if (merge_is_optional)
2489 set_bit(DMF_MERGE_IS_OPTIONAL, &md->flags);
2490 else
2491 clear_bit(DMF_MERGE_IS_OPTIONAL, &md->flags);
41abc4e1
HR
2492 if (old_map)
2493 dm_sync_table(md);
1da177e4 2494
042d2a9b 2495 return old_map;
1da177e4
LT
2496}
2497
a7940155
AK
2498/*
2499 * Returns unbound table for the caller to free.
2500 */
2501static struct dm_table *__unbind(struct mapped_device *md)
1da177e4 2502{
a12f5d48 2503 struct dm_table *map = rcu_dereference_protected(md->map, 1);
1da177e4
LT
2504
2505 if (!map)
a7940155 2506 return NULL;
1da177e4
LT
2507
2508 dm_table_event_callback(map, NULL, NULL);
9cdb8520 2509 RCU_INIT_POINTER(md->map, NULL);
83d5e5b0 2510 dm_sync_table(md);
a7940155
AK
2511
2512 return map;
1da177e4
LT
2513}
2514
2515/*
2516 * Constructor for a new device.
2517 */
2b06cfff 2518int dm_create(int minor, struct mapped_device **result)
1da177e4
LT
2519{
2520 struct mapped_device *md;
2521
2b06cfff 2522 md = alloc_dev(minor);
1da177e4
LT
2523 if (!md)
2524 return -ENXIO;
2525
784aae73
MB
2526 dm_sysfs_init(md);
2527
1da177e4
LT
2528 *result = md;
2529 return 0;
2530}
2531
a5664dad
MS
2532/*
2533 * Functions to manage md->type.
2534 * All are required to hold md->type_lock.
2535 */
2536void dm_lock_md_type(struct mapped_device *md)
2537{
2538 mutex_lock(&md->type_lock);
2539}
2540
2541void dm_unlock_md_type(struct mapped_device *md)
2542{
2543 mutex_unlock(&md->type_lock);
2544}
2545
2546void dm_set_md_type(struct mapped_device *md, unsigned type)
2547{
00c4fc3b 2548 BUG_ON(!mutex_is_locked(&md->type_lock));
a5664dad
MS
2549 md->type = type;
2550}
2551
2552unsigned dm_get_md_type(struct mapped_device *md)
2553{
00c4fc3b 2554 BUG_ON(!mutex_is_locked(&md->type_lock));
a5664dad
MS
2555 return md->type;
2556}
2557
36a0456f
AK
2558struct target_type *dm_get_immutable_target_type(struct mapped_device *md)
2559{
2560 return md->immutable_target_type;
2561}
2562
f84cb8a4
MS
2563/*
2564 * The queue_limits are only valid as long as you have a reference
2565 * count on 'md'.
2566 */
2567struct queue_limits *dm_get_queue_limits(struct mapped_device *md)
2568{
2569 BUG_ON(!atomic_read(&md->holders));
2570 return &md->queue->limits;
2571}
2572EXPORT_SYMBOL_GPL(dm_get_queue_limits);
2573
bfebd1cd
MS
2574static void init_rq_based_worker_thread(struct mapped_device *md)
2575{
2576 /* Initialize the request-based DM worker thread */
2577 init_kthread_worker(&md->kworker);
2578 md->kworker_task = kthread_run(kthread_worker_fn, &md->kworker,
2579 "kdmwork-%s", dm_device_name(md));
2580}
2581
4a0b4ddf
MS
2582/*
2583 * Fully initialize a request-based queue (->elevator, ->request_fn, etc).
2584 */
2585static int dm_init_request_based_queue(struct mapped_device *md)
2586{
2587 struct request_queue *q = NULL;
2588
4a0b4ddf
MS
2589 /* Fully initialize the queue */
2590 q = blk_init_allocated_queue(md->queue, dm_request_fn, NULL);
2591 if (!q)
bfebd1cd 2592 return -EINVAL;
4a0b4ddf 2593
0ce65797
MS
2594 /* disable dm_request_fn's merge heuristic by default */
2595 md->seq_rq_merge_deadline_usecs = 0;
2596
4a0b4ddf 2597 md->queue = q;
bfebd1cd 2598 dm_init_old_md_queue(md);
4a0b4ddf
MS
2599 blk_queue_softirq_done(md->queue, dm_softirq_done);
2600 blk_queue_prep_rq(md->queue, dm_prep_fn);
4a0b4ddf 2601
bfebd1cd 2602 init_rq_based_worker_thread(md);
2eb6e1e3 2603
4a0b4ddf
MS
2604 elv_register_queue(md->queue);
2605
bfebd1cd
MS
2606 return 0;
2607}
2608
2609static int dm_mq_init_request(void *data, struct request *rq,
2610 unsigned int hctx_idx, unsigned int request_idx,
2611 unsigned int numa_node)
2612{
2613 struct mapped_device *md = data;
2614 struct dm_rq_target_io *tio = blk_mq_rq_to_pdu(rq);
2615
2616 /*
2617 * Must initialize md member of tio, otherwise it won't
2618 * be available in dm_mq_queue_rq.
2619 */
2620 tio->md = md;
2621
2622 return 0;
2623}
2624
2625static int dm_mq_queue_rq(struct blk_mq_hw_ctx *hctx,
2626 const struct blk_mq_queue_data *bd)
2627{
2628 struct request *rq = bd->rq;
2629 struct dm_rq_target_io *tio = blk_mq_rq_to_pdu(rq);
2630 struct mapped_device *md = tio->md;
2631 int srcu_idx;
2632 struct dm_table *map = dm_get_live_table(md, &srcu_idx);
2633 struct dm_target *ti;
2634 sector_t pos;
2635
2636 /* always use block 0 to find the target for flushes for now */
2637 pos = 0;
2638 if (!(rq->cmd_flags & REQ_FLUSH))
2639 pos = blk_rq_pos(rq);
2640
2641 ti = dm_table_find_target(map, pos);
2642 if (!dm_target_is_valid(ti)) {
2643 dm_put_live_table(md, srcu_idx);
2644 DMERR_LIMIT("request attempted access beyond the end of device");
2645 /*
2646 * Must perform setup, that rq_completed() requires,
2647 * before returning BLK_MQ_RQ_QUEUE_ERROR
2648 */
2649 dm_start_request(md, rq);
2650 return BLK_MQ_RQ_QUEUE_ERROR;
2651 }
2652 dm_put_live_table(md, srcu_idx);
2653
2654 if (ti->type->busy && ti->type->busy(ti))
2655 return BLK_MQ_RQ_QUEUE_BUSY;
2656
2657 dm_start_request(md, rq);
2658
2659 /* Init tio using md established in .init_request */
2660 init_tio(tio, rq, md);
2661
02233342
MS
2662 /*
2663 * Establish tio->ti before queuing work (map_tio_request)
2664 * or making direct call to map_request().
2665 */
bfebd1cd 2666 tio->ti = ti;
02233342
MS
2667
2668 /* Clone the request if underlying devices aren't blk-mq */
2669 if (dm_table_get_type(map) == DM_TYPE_REQUEST_BASED) {
2670 /* clone request is allocated at the end of the pdu */
2671 tio->clone = (void *)blk_mq_rq_to_pdu(rq) + sizeof(struct dm_rq_target_io);
45714fbe 2672 (void) clone_rq(rq, md, tio, GFP_ATOMIC);
02233342
MS
2673 queue_kthread_work(&md->kworker, &tio->work);
2674 } else {
2675 /* Direct call is fine since .queue_rq allows allocations */
45714fbe
MS
2676 if (map_request(tio, rq, md) == DM_MAPIO_REQUEUE) {
2677 /* Undo dm_start_request() before requeuing */
2678 rq_completed(md, rq_data_dir(rq), false);
2679 return BLK_MQ_RQ_QUEUE_BUSY;
2680 }
02233342 2681 }
bfebd1cd
MS
2682
2683 return BLK_MQ_RQ_QUEUE_OK;
2684}
2685
2686static struct blk_mq_ops dm_mq_ops = {
2687 .queue_rq = dm_mq_queue_rq,
2688 .map_queue = blk_mq_map_queue,
2689 .complete = dm_softirq_done,
2690 .init_request = dm_mq_init_request,
2691};
2692
2693static int dm_init_request_based_blk_mq_queue(struct mapped_device *md)
2694{
02233342 2695 unsigned md_type = dm_get_md_type(md);
bfebd1cd
MS
2696 struct request_queue *q;
2697 int err;
2698
2699 memset(&md->tag_set, 0, sizeof(md->tag_set));
2700 md->tag_set.ops = &dm_mq_ops;
2701 md->tag_set.queue_depth = BLKDEV_MAX_RQ;
2702 md->tag_set.numa_node = NUMA_NO_NODE;
2703 md->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
2704 md->tag_set.nr_hw_queues = 1;
02233342
MS
2705 if (md_type == DM_TYPE_REQUEST_BASED) {
2706 /* make the memory for non-blk-mq clone part of the pdu */
2707 md->tag_set.cmd_size = sizeof(struct dm_rq_target_io) + sizeof(struct request);
2708 } else
2709 md->tag_set.cmd_size = sizeof(struct dm_rq_target_io);
bfebd1cd
MS
2710 md->tag_set.driver_data = md;
2711
2712 err = blk_mq_alloc_tag_set(&md->tag_set);
2713 if (err)
2714 return err;
2715
2716 q = blk_mq_init_allocated_queue(&md->tag_set, md->queue);
2717 if (IS_ERR(q)) {
2718 err = PTR_ERR(q);
2719 goto out_tag_set;
2720 }
2721 md->queue = q;
2722 dm_init_md_queue(md);
2723
2724 /* backfill 'mq' sysfs registration normally done in blk_register_queue */
2725 blk_mq_register_disk(md->disk);
2726
02233342
MS
2727 if (md_type == DM_TYPE_REQUEST_BASED)
2728 init_rq_based_worker_thread(md);
bfebd1cd
MS
2729
2730 return 0;
2731
2732out_tag_set:
2733 blk_mq_free_tag_set(&md->tag_set);
2734 return err;
4a0b4ddf
MS
2735}
2736
17e149b8
MS
2737static unsigned filter_md_type(unsigned type, struct mapped_device *md)
2738{
2739 if (type == DM_TYPE_BIO_BASED)
2740 return type;
2741
2742 return !md->use_blk_mq ? DM_TYPE_REQUEST_BASED : DM_TYPE_MQ_REQUEST_BASED;
2743}
2744
4a0b4ddf
MS
2745/*
2746 * Setup the DM device's queue based on md's type
2747 */
2748int dm_setup_md_queue(struct mapped_device *md)
2749{
bfebd1cd 2750 int r;
17e149b8 2751 unsigned md_type = filter_md_type(dm_get_md_type(md), md);
bfebd1cd
MS
2752
2753 switch (md_type) {
2754 case DM_TYPE_REQUEST_BASED:
2755 r = dm_init_request_based_queue(md);
2756 if (r) {
ff36ab34 2757 DMWARN("Cannot initialize queue for request-based mapped device");
bfebd1cd 2758 return r;
ff36ab34 2759 }
bfebd1cd
MS
2760 break;
2761 case DM_TYPE_MQ_REQUEST_BASED:
2762 r = dm_init_request_based_blk_mq_queue(md);
2763 if (r) {
2764 DMWARN("Cannot initialize queue for request-based blk-mq mapped device");
2765 return r;
2766 }
2767 break;
2768 case DM_TYPE_BIO_BASED:
2769 dm_init_old_md_queue(md);
ff36ab34
MS
2770 blk_queue_make_request(md->queue, dm_make_request);
2771 blk_queue_merge_bvec(md->queue, dm_merge_bvec);
bfebd1cd 2772 break;
4a0b4ddf
MS
2773 }
2774
2775 return 0;
2776}
2777
2bec1f4a 2778struct mapped_device *dm_get_md(dev_t dev)
1da177e4
LT
2779{
2780 struct mapped_device *md;
1da177e4
LT
2781 unsigned minor = MINOR(dev);
2782
2783 if (MAJOR(dev) != _major || minor >= (1 << MINORBITS))
2784 return NULL;
2785
f32c10b0 2786 spin_lock(&_minor_lock);
1da177e4
LT
2787
2788 md = idr_find(&_minor_idr, minor);
2bec1f4a
MP
2789 if (md) {
2790 if ((md == MINOR_ALLOCED ||
2791 (MINOR(disk_devt(dm_disk(md))) != minor) ||
2792 dm_deleting_md(md) ||
2793 test_bit(DMF_FREEING, &md->flags))) {
2794 md = NULL;
2795 goto out;
2796 }
2797 dm_get(md);
fba9f90e 2798 }
1da177e4 2799
fba9f90e 2800out:
f32c10b0 2801 spin_unlock(&_minor_lock);
1da177e4 2802
637842cf
DT
2803 return md;
2804}
3cf2e4ba 2805EXPORT_SYMBOL_GPL(dm_get_md);
d229a958 2806
9ade92a9 2807void *dm_get_mdptr(struct mapped_device *md)
637842cf 2808{
9ade92a9 2809 return md->interface_ptr;
1da177e4
LT
2810}
2811
2812void dm_set_mdptr(struct mapped_device *md, void *ptr)
2813{
2814 md->interface_ptr = ptr;
2815}
2816
2817void dm_get(struct mapped_device *md)
2818{
2819 atomic_inc(&md->holders);
3f77316d 2820 BUG_ON(test_bit(DMF_FREEING, &md->flags));
1da177e4
LT
2821}
2822
09ee96b2
MP
2823int dm_hold(struct mapped_device *md)
2824{
2825 spin_lock(&_minor_lock);
2826 if (test_bit(DMF_FREEING, &md->flags)) {
2827 spin_unlock(&_minor_lock);
2828 return -EBUSY;
2829 }
2830 dm_get(md);
2831 spin_unlock(&_minor_lock);
2832 return 0;
2833}
2834EXPORT_SYMBOL_GPL(dm_hold);
2835
72d94861
AK
2836const char *dm_device_name(struct mapped_device *md)
2837{
2838 return md->name;
2839}
2840EXPORT_SYMBOL_GPL(dm_device_name);
2841
3f77316d 2842static void __dm_destroy(struct mapped_device *md, bool wait)
1da177e4 2843{
1134e5ae 2844 struct dm_table *map;
83d5e5b0 2845 int srcu_idx;
1da177e4 2846
3f77316d 2847 might_sleep();
fba9f90e 2848
83d5e5b0 2849 map = dm_get_live_table(md, &srcu_idx);
63a4f065
MS
2850
2851 spin_lock(&_minor_lock);
3f77316d
KU
2852 idr_replace(&_minor_idr, MINOR_ALLOCED, MINOR(disk_devt(dm_disk(md))));
2853 set_bit(DMF_FREEING, &md->flags);
2854 spin_unlock(&_minor_lock);
2855
02233342 2856 if (dm_request_based(md) && md->kworker_task)
2eb6e1e3
KB
2857 flush_kthread_worker(&md->kworker);
2858
ab7c7bb6
MP
2859 /*
2860 * Take suspend_lock so that presuspend and postsuspend methods
2861 * do not race with internal suspend.
2862 */
2863 mutex_lock(&md->suspend_lock);
3f77316d
KU
2864 if (!dm_suspended_md(md)) {
2865 dm_table_presuspend_targets(map);
2866 dm_table_postsuspend_targets(map);
1da177e4 2867 }
ab7c7bb6 2868 mutex_unlock(&md->suspend_lock);
3f77316d 2869
83d5e5b0
MP
2870 /* dm_put_live_table must be before msleep, otherwise deadlock is possible */
2871 dm_put_live_table(md, srcu_idx);
2872
3f77316d
KU
2873 /*
2874 * Rare, but there may be I/O requests still going to complete,
2875 * for example. Wait for all references to disappear.
2876 * No one should increment the reference count of the mapped_device,
2877 * after the mapped_device state becomes DMF_FREEING.
2878 */
2879 if (wait)
2880 while (atomic_read(&md->holders))
2881 msleep(1);
2882 else if (atomic_read(&md->holders))
2883 DMWARN("%s: Forcibly removing mapped_device still in use! (%d users)",
2884 dm_device_name(md), atomic_read(&md->holders));
2885
2886 dm_sysfs_exit(md);
3f77316d
KU
2887 dm_table_destroy(__unbind(md));
2888 free_dev(md);
2889}
2890
2891void dm_destroy(struct mapped_device *md)
2892{
2893 __dm_destroy(md, true);
2894}
2895
2896void dm_destroy_immediate(struct mapped_device *md)
2897{
2898 __dm_destroy(md, false);
2899}
2900
2901void dm_put(struct mapped_device *md)
2902{
2903 atomic_dec(&md->holders);
1da177e4 2904}
79eb885c 2905EXPORT_SYMBOL_GPL(dm_put);
1da177e4 2906
401600df 2907static int dm_wait_for_completion(struct mapped_device *md, int interruptible)
46125c1c
MB
2908{
2909 int r = 0;
b44ebeb0
MP
2910 DECLARE_WAITQUEUE(wait, current);
2911
b44ebeb0 2912 add_wait_queue(&md->wait, &wait);
46125c1c
MB
2913
2914 while (1) {
401600df 2915 set_current_state(interruptible);
46125c1c 2916
b4324fee 2917 if (!md_in_flight(md))
46125c1c
MB
2918 break;
2919
401600df
MP
2920 if (interruptible == TASK_INTERRUPTIBLE &&
2921 signal_pending(current)) {
46125c1c
MB
2922 r = -EINTR;
2923 break;
2924 }
2925
2926 io_schedule();
2927 }
2928 set_current_state(TASK_RUNNING);
2929
b44ebeb0
MP
2930 remove_wait_queue(&md->wait, &wait);
2931
46125c1c
MB
2932 return r;
2933}
2934
1da177e4
LT
2935/*
2936 * Process the deferred bios
2937 */
ef208587 2938static void dm_wq_work(struct work_struct *work)
1da177e4 2939{
ef208587
MP
2940 struct mapped_device *md = container_of(work, struct mapped_device,
2941 work);
6d6f10df 2942 struct bio *c;
83d5e5b0
MP
2943 int srcu_idx;
2944 struct dm_table *map;
1da177e4 2945
83d5e5b0 2946 map = dm_get_live_table(md, &srcu_idx);
ef208587 2947
3b00b203 2948 while (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
df12ee99
AK
2949 spin_lock_irq(&md->deferred_lock);
2950 c = bio_list_pop(&md->deferred);
2951 spin_unlock_irq(&md->deferred_lock);
2952
6a8736d1 2953 if (!c)
df12ee99 2954 break;
022c2611 2955
e6ee8c0b
KU
2956 if (dm_request_based(md))
2957 generic_make_request(c);
6a8736d1 2958 else
83d5e5b0 2959 __split_and_process_bio(md, map, c);
022c2611 2960 }
73d410c0 2961
83d5e5b0 2962 dm_put_live_table(md, srcu_idx);
1da177e4
LT
2963}
2964
9a1fb464 2965static void dm_queue_flush(struct mapped_device *md)
304f3f6a 2966{
3b00b203 2967 clear_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
4e857c58 2968 smp_mb__after_atomic();
53d5914f 2969 queue_work(md->wq, &md->work);
304f3f6a
MB
2970}
2971
1da177e4 2972/*
042d2a9b 2973 * Swap in a new table, returning the old one for the caller to destroy.
1da177e4 2974 */
042d2a9b 2975struct dm_table *dm_swap_table(struct mapped_device *md, struct dm_table *table)
1da177e4 2976{
87eb5b21 2977 struct dm_table *live_map = NULL, *map = ERR_PTR(-EINVAL);
754c5fc7 2978 struct queue_limits limits;
042d2a9b 2979 int r;
1da177e4 2980
e61290a4 2981 mutex_lock(&md->suspend_lock);
1da177e4
LT
2982
2983 /* device must be suspended */
4f186f8b 2984 if (!dm_suspended_md(md))
93c534ae 2985 goto out;
1da177e4 2986
3ae70656
MS
2987 /*
2988 * If the new table has no data devices, retain the existing limits.
2989 * This helps multipath with queue_if_no_path if all paths disappear,
2990 * then new I/O is queued based on these limits, and then some paths
2991 * reappear.
2992 */
2993 if (dm_table_has_no_data_devices(table)) {
83d5e5b0 2994 live_map = dm_get_live_table_fast(md);
3ae70656
MS
2995 if (live_map)
2996 limits = md->queue->limits;
83d5e5b0 2997 dm_put_live_table_fast(md);
3ae70656
MS
2998 }
2999
87eb5b21
MC
3000 if (!live_map) {
3001 r = dm_calculate_queue_limits(table, &limits);
3002 if (r) {
3003 map = ERR_PTR(r);
3004 goto out;
3005 }
042d2a9b 3006 }
754c5fc7 3007
042d2a9b 3008 map = __bind(md, table, &limits);
1da177e4 3009
93c534ae 3010out:
e61290a4 3011 mutex_unlock(&md->suspend_lock);
042d2a9b 3012 return map;
1da177e4
LT
3013}
3014
3015/*
3016 * Functions to lock and unlock any filesystem running on the
3017 * device.
3018 */
2ca3310e 3019static int lock_fs(struct mapped_device *md)
1da177e4 3020{
e39e2e95 3021 int r;
1da177e4
LT
3022
3023 WARN_ON(md->frozen_sb);
dfbe03f6 3024
db8fef4f 3025 md->frozen_sb = freeze_bdev(md->bdev);
dfbe03f6 3026 if (IS_ERR(md->frozen_sb)) {
cf222b37 3027 r = PTR_ERR(md->frozen_sb);
e39e2e95
AK
3028 md->frozen_sb = NULL;
3029 return r;
dfbe03f6
AK
3030 }
3031
aa8d7c2f
AK
3032 set_bit(DMF_FROZEN, &md->flags);
3033
1da177e4
LT
3034 return 0;
3035}
3036
2ca3310e 3037static void unlock_fs(struct mapped_device *md)
1da177e4 3038{
aa8d7c2f
AK
3039 if (!test_bit(DMF_FROZEN, &md->flags))
3040 return;
3041
db8fef4f 3042 thaw_bdev(md->bdev, md->frozen_sb);
1da177e4 3043 md->frozen_sb = NULL;
aa8d7c2f 3044 clear_bit(DMF_FROZEN, &md->flags);
1da177e4
LT
3045}
3046
3047/*
ffcc3936
MS
3048 * If __dm_suspend returns 0, the device is completely quiescent
3049 * now. There is no request-processing activity. All new requests
3050 * are being added to md->deferred list.
cec47e3d 3051 *
ffcc3936 3052 * Caller must hold md->suspend_lock
cec47e3d 3053 */
ffcc3936
MS
3054static int __dm_suspend(struct mapped_device *md, struct dm_table *map,
3055 unsigned suspend_flags, int interruptible)
1da177e4 3056{
ffcc3936
MS
3057 bool do_lockfs = suspend_flags & DM_SUSPEND_LOCKFS_FLAG;
3058 bool noflush = suspend_flags & DM_SUSPEND_NOFLUSH_FLAG;
3059 int r;
1da177e4 3060
2e93ccc1
KU
3061 /*
3062 * DMF_NOFLUSH_SUSPENDING must be set before presuspend.
3063 * This flag is cleared before dm_suspend returns.
3064 */
3065 if (noflush)
3066 set_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
3067
d67ee213
MS
3068 /*
3069 * This gets reverted if there's an error later and the targets
3070 * provide the .presuspend_undo hook.
3071 */
cf222b37
AK
3072 dm_table_presuspend_targets(map);
3073
32a926da 3074 /*
9f518b27
KU
3075 * Flush I/O to the device.
3076 * Any I/O submitted after lock_fs() may not be flushed.
3077 * noflush takes precedence over do_lockfs.
3078 * (lock_fs() flushes I/Os and waits for them to complete.)
32a926da
MP
3079 */
3080 if (!noflush && do_lockfs) {
3081 r = lock_fs(md);
d67ee213
MS
3082 if (r) {
3083 dm_table_presuspend_undo_targets(map);
ffcc3936 3084 return r;
d67ee213 3085 }
aa8d7c2f 3086 }
1da177e4
LT
3087
3088 /*
3b00b203
MP
3089 * Here we must make sure that no processes are submitting requests
3090 * to target drivers i.e. no one may be executing
3091 * __split_and_process_bio. This is called from dm_request and
3092 * dm_wq_work.
3093 *
3094 * To get all processes out of __split_and_process_bio in dm_request,
3095 * we take the write lock. To prevent any process from reentering
6a8736d1
TH
3096 * __split_and_process_bio from dm_request and quiesce the thread
3097 * (dm_wq_work), we set BMF_BLOCK_IO_FOR_SUSPEND and call
3098 * flush_workqueue(md->wq).
1da177e4 3099 */
1eb787ec 3100 set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
41abc4e1
HR
3101 if (map)
3102 synchronize_srcu(&md->io_barrier);
1da177e4 3103
d0bcb878 3104 /*
29e4013d
TH
3105 * Stop md->queue before flushing md->wq in case request-based
3106 * dm defers requests to md->wq from md->queue.
d0bcb878 3107 */
2eb6e1e3 3108 if (dm_request_based(md)) {
9f518b27 3109 stop_queue(md->queue);
02233342
MS
3110 if (md->kworker_task)
3111 flush_kthread_worker(&md->kworker);
2eb6e1e3 3112 }
cec47e3d 3113
d0bcb878
KU
3114 flush_workqueue(md->wq);
3115
1da177e4 3116 /*
3b00b203
MP
3117 * At this point no more requests are entering target request routines.
3118 * We call dm_wait_for_completion to wait for all existing requests
3119 * to finish.
1da177e4 3120 */
ffcc3936 3121 r = dm_wait_for_completion(md, interruptible);
1da177e4 3122
6d6f10df 3123 if (noflush)
022c2611 3124 clear_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
41abc4e1
HR
3125 if (map)
3126 synchronize_srcu(&md->io_barrier);
2e93ccc1 3127
1da177e4 3128 /* were we interrupted ? */
46125c1c 3129 if (r < 0) {
9a1fb464 3130 dm_queue_flush(md);
73d410c0 3131
cec47e3d 3132 if (dm_request_based(md))
9f518b27 3133 start_queue(md->queue);
cec47e3d 3134
2ca3310e 3135 unlock_fs(md);
d67ee213 3136 dm_table_presuspend_undo_targets(map);
ffcc3936 3137 /* pushback list is already flushed, so skip flush */
2ca3310e 3138 }
1da177e4 3139
ffcc3936
MS
3140 return r;
3141}
3142
3143/*
3144 * We need to be able to change a mapping table under a mounted
3145 * filesystem. For example we might want to move some data in
3146 * the background. Before the table can be swapped with
3147 * dm_bind_table, dm_suspend must be called to flush any in
3148 * flight bios and ensure that any further io gets deferred.
3149 */
3150/*
3151 * Suspend mechanism in request-based dm.
3152 *
3153 * 1. Flush all I/Os by lock_fs() if needed.
3154 * 2. Stop dispatching any I/O by stopping the request_queue.
3155 * 3. Wait for all in-flight I/Os to be completed or requeued.
3156 *
3157 * To abort suspend, start the request_queue.
3158 */
3159int dm_suspend(struct mapped_device *md, unsigned suspend_flags)
3160{
3161 struct dm_table *map = NULL;
3162 int r = 0;
3163
3164retry:
3165 mutex_lock_nested(&md->suspend_lock, SINGLE_DEPTH_NESTING);
3166
3167 if (dm_suspended_md(md)) {
3168 r = -EINVAL;
3169 goto out_unlock;
3170 }
3171
3172 if (dm_suspended_internally_md(md)) {
3173 /* already internally suspended, wait for internal resume */
3174 mutex_unlock(&md->suspend_lock);
3175 r = wait_on_bit(&md->flags, DMF_SUSPENDED_INTERNALLY, TASK_INTERRUPTIBLE);
3176 if (r)
3177 return r;
3178 goto retry;
3179 }
3180
a12f5d48 3181 map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
ffcc3936
MS
3182
3183 r = __dm_suspend(md, map, suspend_flags, TASK_INTERRUPTIBLE);
3184 if (r)
3185 goto out_unlock;
3b00b203 3186
2ca3310e 3187 set_bit(DMF_SUSPENDED, &md->flags);
b84b0287 3188
4d4471cb
KU
3189 dm_table_postsuspend_targets(map);
3190
d287483d 3191out_unlock:
e61290a4 3192 mutex_unlock(&md->suspend_lock);
cf222b37 3193 return r;
1da177e4
LT
3194}
3195
ffcc3936
MS
3196static int __dm_resume(struct mapped_device *md, struct dm_table *map)
3197{
3198 if (map) {
3199 int r = dm_table_resume_targets(map);
3200 if (r)
3201 return r;
3202 }
3203
3204 dm_queue_flush(md);
3205
3206 /*
3207 * Flushing deferred I/Os must be done after targets are resumed
3208 * so that mapping of targets can work correctly.
3209 * Request-based dm is queueing the deferred I/Os in its request_queue.
3210 */
3211 if (dm_request_based(md))
3212 start_queue(md->queue);
3213
3214 unlock_fs(md);
3215
3216 return 0;
3217}
3218
1da177e4
LT
3219int dm_resume(struct mapped_device *md)
3220{
cf222b37 3221 int r = -EINVAL;
cf222b37 3222 struct dm_table *map = NULL;
1da177e4 3223
ffcc3936
MS
3224retry:
3225 mutex_lock_nested(&md->suspend_lock, SINGLE_DEPTH_NESTING);
3226
4f186f8b 3227 if (!dm_suspended_md(md))
cf222b37 3228 goto out;
cf222b37 3229
ffcc3936
MS
3230 if (dm_suspended_internally_md(md)) {
3231 /* already internally suspended, wait for internal resume */
3232 mutex_unlock(&md->suspend_lock);
3233 r = wait_on_bit(&md->flags, DMF_SUSPENDED_INTERNALLY, TASK_INTERRUPTIBLE);
3234 if (r)
3235 return r;
3236 goto retry;
3237 }
3238
a12f5d48 3239 map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
2ca3310e 3240 if (!map || !dm_table_get_size(map))
cf222b37 3241 goto out;
1da177e4 3242
ffcc3936 3243 r = __dm_resume(md, map);
8757b776
MB
3244 if (r)
3245 goto out;
2ca3310e 3246
2ca3310e
AK
3247 clear_bit(DMF_SUSPENDED, &md->flags);
3248
cf222b37
AK
3249 r = 0;
3250out:
e61290a4 3251 mutex_unlock(&md->suspend_lock);
2ca3310e 3252
cf222b37 3253 return r;
1da177e4
LT
3254}
3255
fd2ed4d2
MP
3256/*
3257 * Internal suspend/resume works like userspace-driven suspend. It waits
3258 * until all bios finish and prevents issuing new bios to the target drivers.
3259 * It may be used only from the kernel.
fd2ed4d2
MP
3260 */
3261
ffcc3936 3262static void __dm_internal_suspend(struct mapped_device *md, unsigned suspend_flags)
fd2ed4d2 3263{
ffcc3936
MS
3264 struct dm_table *map = NULL;
3265
96b26c8c 3266 if (md->internal_suspend_count++)
ffcc3936
MS
3267 return; /* nested internal suspend */
3268
3269 if (dm_suspended_md(md)) {
3270 set_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
3271 return; /* nest suspend */
3272 }
3273
a12f5d48 3274 map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
ffcc3936
MS
3275
3276 /*
3277 * Using TASK_UNINTERRUPTIBLE because only NOFLUSH internal suspend is
3278 * supported. Properly supporting a TASK_INTERRUPTIBLE internal suspend
3279 * would require changing .presuspend to return an error -- avoid this
3280 * until there is a need for more elaborate variants of internal suspend.
3281 */
3282 (void) __dm_suspend(md, map, suspend_flags, TASK_UNINTERRUPTIBLE);
3283
3284 set_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
3285
3286 dm_table_postsuspend_targets(map);
3287}
3288
3289static void __dm_internal_resume(struct mapped_device *md)
3290{
96b26c8c
MP
3291 BUG_ON(!md->internal_suspend_count);
3292
3293 if (--md->internal_suspend_count)
ffcc3936
MS
3294 return; /* resume from nested internal suspend */
3295
fd2ed4d2 3296 if (dm_suspended_md(md))
ffcc3936
MS
3297 goto done; /* resume from nested suspend */
3298
3299 /*
3300 * NOTE: existing callers don't need to call dm_table_resume_targets
3301 * (which may fail -- so best to avoid it for now by passing NULL map)
3302 */
3303 (void) __dm_resume(md, NULL);
3304
3305done:
3306 clear_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
3307 smp_mb__after_atomic();
3308 wake_up_bit(&md->flags, DMF_SUSPENDED_INTERNALLY);
3309}
3310
3311void dm_internal_suspend_noflush(struct mapped_device *md)
3312{
3313 mutex_lock(&md->suspend_lock);
3314 __dm_internal_suspend(md, DM_SUSPEND_NOFLUSH_FLAG);
3315 mutex_unlock(&md->suspend_lock);
3316}
3317EXPORT_SYMBOL_GPL(dm_internal_suspend_noflush);
3318
3319void dm_internal_resume(struct mapped_device *md)
3320{
3321 mutex_lock(&md->suspend_lock);
3322 __dm_internal_resume(md);
3323 mutex_unlock(&md->suspend_lock);
3324}
3325EXPORT_SYMBOL_GPL(dm_internal_resume);
3326
3327/*
3328 * Fast variants of internal suspend/resume hold md->suspend_lock,
3329 * which prevents interaction with userspace-driven suspend.
3330 */
3331
3332void dm_internal_suspend_fast(struct mapped_device *md)
3333{
3334 mutex_lock(&md->suspend_lock);
3335 if (dm_suspended_md(md) || dm_suspended_internally_md(md))
fd2ed4d2
MP
3336 return;
3337
3338 set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
3339 synchronize_srcu(&md->io_barrier);
3340 flush_workqueue(md->wq);
3341 dm_wait_for_completion(md, TASK_UNINTERRUPTIBLE);
3342}
b735fede 3343EXPORT_SYMBOL_GPL(dm_internal_suspend_fast);
fd2ed4d2 3344
ffcc3936 3345void dm_internal_resume_fast(struct mapped_device *md)
fd2ed4d2 3346{
ffcc3936 3347 if (dm_suspended_md(md) || dm_suspended_internally_md(md))
fd2ed4d2
MP
3348 goto done;
3349
3350 dm_queue_flush(md);
3351
3352done:
3353 mutex_unlock(&md->suspend_lock);
3354}
b735fede 3355EXPORT_SYMBOL_GPL(dm_internal_resume_fast);
fd2ed4d2 3356
1da177e4
LT
3357/*-----------------------------------------------------------------
3358 * Event notification.
3359 *---------------------------------------------------------------*/
3abf85b5 3360int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
60935eb2 3361 unsigned cookie)
69267a30 3362{
60935eb2
MB
3363 char udev_cookie[DM_COOKIE_LENGTH];
3364 char *envp[] = { udev_cookie, NULL };
3365
3366 if (!cookie)
3abf85b5 3367 return kobject_uevent(&disk_to_dev(md->disk)->kobj, action);
60935eb2
MB
3368 else {
3369 snprintf(udev_cookie, DM_COOKIE_LENGTH, "%s=%u",
3370 DM_COOKIE_ENV_VAR_NAME, cookie);
3abf85b5
PR
3371 return kobject_uevent_env(&disk_to_dev(md->disk)->kobj,
3372 action, envp);
60935eb2 3373 }
69267a30
AK
3374}
3375
7a8c3d3b
MA
3376uint32_t dm_next_uevent_seq(struct mapped_device *md)
3377{
3378 return atomic_add_return(1, &md->uevent_seq);
3379}
3380
1da177e4
LT
3381uint32_t dm_get_event_nr(struct mapped_device *md)
3382{
3383 return atomic_read(&md->event_nr);
3384}
3385
3386int dm_wait_event(struct mapped_device *md, int event_nr)
3387{
3388 return wait_event_interruptible(md->eventq,
3389 (event_nr != atomic_read(&md->event_nr)));
3390}
3391
7a8c3d3b
MA
3392void dm_uevent_add(struct mapped_device *md, struct list_head *elist)
3393{
3394 unsigned long flags;
3395
3396 spin_lock_irqsave(&md->uevent_lock, flags);
3397 list_add(elist, &md->uevent_list);
3398 spin_unlock_irqrestore(&md->uevent_lock, flags);
3399}
3400
1da177e4
LT
3401/*
3402 * The gendisk is only valid as long as you have a reference
3403 * count on 'md'.
3404 */
3405struct gendisk *dm_disk(struct mapped_device *md)
3406{
3407 return md->disk;
3408}
65ff5b7d 3409EXPORT_SYMBOL_GPL(dm_disk);
1da177e4 3410
784aae73
MB
3411struct kobject *dm_kobject(struct mapped_device *md)
3412{
2995fa78 3413 return &md->kobj_holder.kobj;
784aae73
MB
3414}
3415
784aae73
MB
3416struct mapped_device *dm_get_from_kobject(struct kobject *kobj)
3417{
3418 struct mapped_device *md;
3419
2995fa78 3420 md = container_of(kobj, struct mapped_device, kobj_holder.kobj);
784aae73 3421
4d89b7b4 3422 if (test_bit(DMF_FREEING, &md->flags) ||
432a212c 3423 dm_deleting_md(md))
4d89b7b4
MB
3424 return NULL;
3425
784aae73
MB
3426 dm_get(md);
3427 return md;
3428}
3429
4f186f8b 3430int dm_suspended_md(struct mapped_device *md)
1da177e4
LT
3431{
3432 return test_bit(DMF_SUSPENDED, &md->flags);
3433}
3434
ffcc3936
MS
3435int dm_suspended_internally_md(struct mapped_device *md)
3436{
3437 return test_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
3438}
3439
2c140a24
MP
3440int dm_test_deferred_remove_flag(struct mapped_device *md)
3441{
3442 return test_bit(DMF_DEFERRED_REMOVE, &md->flags);
3443}
3444
64dbce58
KU
3445int dm_suspended(struct dm_target *ti)
3446{
ecdb2e25 3447 return dm_suspended_md(dm_table_get_md(ti->table));
64dbce58
KU
3448}
3449EXPORT_SYMBOL_GPL(dm_suspended);
3450
2e93ccc1
KU
3451int dm_noflush_suspending(struct dm_target *ti)
3452{
ecdb2e25 3453 return __noflush_suspending(dm_table_get_md(ti->table));
2e93ccc1
KU
3454}
3455EXPORT_SYMBOL_GPL(dm_noflush_suspending);
3456
5f1b670d
CH
3457struct dm_md_mempools *dm_alloc_bio_mempools(unsigned integrity,
3458 unsigned per_bio_data_size)
e6ee8c0b 3459{
5f1b670d
CH
3460 struct dm_md_mempools *pools;
3461 unsigned int pool_size = dm_get_reserved_bio_based_ios();
5f015204 3462 unsigned int front_pad;
e6ee8c0b 3463
5f1b670d 3464 pools = kzalloc(sizeof(*pools), GFP_KERNEL);
e6ee8c0b
KU
3465 if (!pools)
3466 return NULL;
3467
5f1b670d
CH
3468 front_pad = roundup(per_bio_data_size, __alignof__(struct dm_target_io)) +
3469 offsetof(struct dm_target_io, clone);
17e149b8 3470
5f1b670d
CH
3471 pools->io_pool = mempool_create_slab_pool(pool_size, _io_cache);
3472 if (!pools->io_pool)
3473 goto out;
e6ee8c0b 3474
3d8aab2d 3475 pools->bs = bioset_create_nobvec(pool_size, front_pad);
e6ee8c0b 3476 if (!pools->bs)
5f015204 3477 goto out;
e6ee8c0b 3478
a91a2785 3479 if (integrity && bioset_integrity_create(pools->bs, pool_size))
5f015204 3480 goto out;
a91a2785 3481
e6ee8c0b 3482 return pools;
5f015204
JN
3483out:
3484 dm_free_md_mempools(pools);
5f1b670d
CH
3485 return NULL;
3486}
3487
3488struct dm_md_mempools *dm_alloc_rq_mempools(struct mapped_device *md,
3489 unsigned type)
3490{
3491 unsigned int pool_size = dm_get_reserved_rq_based_ios();
3492 struct dm_md_mempools *pools;
e6ee8c0b 3493
5f1b670d
CH
3494 pools = kzalloc(sizeof(*pools), GFP_KERNEL);
3495 if (!pools)
3496 return NULL;
3497
3498 if (filter_md_type(type, md) == DM_TYPE_REQUEST_BASED) {
3499 pools->rq_pool = mempool_create_slab_pool(pool_size, _rq_cache);
3500 if (!pools->rq_pool)
3501 goto out;
3502 }
e6ee8c0b 3503
5f1b670d
CH
3504 pools->io_pool = mempool_create_slab_pool(pool_size, _rq_tio_cache);
3505 if (!pools->io_pool)
3506 goto out;
3507
3508 return pools;
3509out:
3510 dm_free_md_mempools(pools);
e6ee8c0b
KU
3511 return NULL;
3512}
3513
3514void dm_free_md_mempools(struct dm_md_mempools *pools)
3515{
3516 if (!pools)
3517 return;
3518
3519 if (pools->io_pool)
3520 mempool_destroy(pools->io_pool);
3521
1ae49ea2
MS
3522 if (pools->rq_pool)
3523 mempool_destroy(pools->rq_pool);
3524
e6ee8c0b
KU
3525 if (pools->bs)
3526 bioset_free(pools->bs);
3527
3528 kfree(pools);
3529}
3530
83d5cde4 3531static const struct block_device_operations dm_blk_dops = {
1da177e4
LT
3532 .open = dm_blk_open,
3533 .release = dm_blk_close,
aa129a22 3534 .ioctl = dm_blk_ioctl,
3ac51e74 3535 .getgeo = dm_blk_getgeo,
1da177e4
LT
3536 .owner = THIS_MODULE
3537};
3538
1da177e4
LT
3539/*
3540 * module hooks
3541 */
3542module_init(dm_init);
3543module_exit(dm_exit);
3544
3545module_param(major, uint, 0);
3546MODULE_PARM_DESC(major, "The major number of the device mapper");
f4790826 3547
e8603136
MS
3548module_param(reserved_bio_based_ios, uint, S_IRUGO | S_IWUSR);
3549MODULE_PARM_DESC(reserved_bio_based_ios, "Reserved IOs in bio-based mempools");
3550
f4790826
MS
3551module_param(reserved_rq_based_ios, uint, S_IRUGO | S_IWUSR);
3552MODULE_PARM_DESC(reserved_rq_based_ios, "Reserved IOs in request-based mempools");
3553
17e149b8
MS
3554module_param(use_blk_mq, bool, S_IRUGO | S_IWUSR);
3555MODULE_PARM_DESC(use_blk_mq, "Use block multiqueue for request-based DM devices");
3556
1da177e4
LT
3557MODULE_DESCRIPTION(DM_NAME " driver");
3558MODULE_AUTHOR("Joe Thornber <dm-devel@redhat.com>");
3559MODULE_LICENSE("GPL");
This page took 1.021991 seconds and 5 git commands to generate.