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