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