Merge tag 'ubifs-for-linus-6.9-rc1' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-block.git] / drivers / md / dm.c
CommitLineData
3bd94003 1// SPDX-License-Identifier: GPL-2.0-only
1da177e4
LT
2/*
3 * Copyright (C) 2001, 2002 Sistina Software (UK) Limited.
784aae73 4 * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved.
1da177e4
LT
5 *
6 * This file is released under the GPL.
7 */
8
4cc96131
MS
9#include "dm-core.h"
10#include "dm-rq.h"
51e5b2bd 11#include "dm-uevent.h"
91ccbbac 12#include "dm-ima.h"
1da177e4
LT
13
14#include <linux/init.h>
15#include <linux/module.h>
48c9c27b 16#include <linux/mutex.h>
6958c1c6 17#include <linux/sched/mm.h>
174cd4b1 18#include <linux/sched/signal.h>
1da177e4
LT
19#include <linux/blkpg.h>
20#include <linux/bio.h>
1da177e4 21#include <linux/mempool.h>
f26c5719 22#include <linux/dax.h>
1da177e4
LT
23#include <linux/slab.h>
24#include <linux/idr.h>
7e026c8c 25#include <linux/uio.h>
3ac51e74 26#include <linux/hdreg.h>
3f77316d 27#include <linux/delay.h>
ffcc3936 28#include <linux/wait.h>
71cdb697 29#include <linux/pr.h>
b0b4d7c6 30#include <linux/refcount.h>
c6a564ff 31#include <linux/part_stat.h>
a892c8d5 32#include <linux/blk-crypto.h>
1e8d44bd 33#include <linux/blk-crypto-profile.h>
55782138 34
72d94861
AK
35#define DM_MSG_PREFIX "core"
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
b99fdcdc
ML
44/*
45 * For REQ_POLLED fs bio, this flag is set if we link mapped underlying
46 * dm_io into one list, and reuse bio->bi_private as the list head. Before
47 * ending this fs bio, we will recover its ->bi_private.
48 */
49#define REQ_DM_POLL_LIST REQ_DRV
50
1da177e4
LT
51static const char *_name = DM_NAME;
52
2f06cd12
HM
53static unsigned int major;
54static unsigned int _major;
1da177e4 55
d15b774c
AK
56static DEFINE_IDR(_minor_idr);
57
f32c10b0 58static DEFINE_SPINLOCK(_minor_lock);
2c140a24
MP
59
60static void do_deferred_remove(struct work_struct *w);
61
62static DECLARE_WORK(deferred_remove_work, do_deferred_remove);
63
acfe0ad7
MP
64static struct workqueue_struct *deferred_remove_workqueue;
65
93e6442c
MP
66atomic_t dm_global_event_nr = ATOMIC_INIT(0);
67DECLARE_WAIT_QUEUE_HEAD(dm_global_eventq);
68
62e08243
MP
69void dm_issue_global_event(void)
70{
71 atomic_inc(&dm_global_event_nr);
72 wake_up(&dm_global_eventq);
73}
74
442761fd
MS
75DEFINE_STATIC_KEY_FALSE(stats_enabled);
76DEFINE_STATIC_KEY_FALSE(swap_bios_enabled);
77DEFINE_STATIC_KEY_FALSE(zoned_enabled);
78
1da177e4 79/*
64f52b0e 80 * One of these is allocated (on-stack) per original bio.
1da177e4 81 */
64f52b0e 82struct clone_info {
64f52b0e
MS
83 struct dm_table *map;
84 struct bio *bio;
85 struct dm_io *io;
86 sector_t sector;
86a3238c 87 unsigned int sector_count;
4edadf6d
MS
88 bool is_abnormal_io:1;
89 bool submit_as_polled:1;
64f52b0e
MS
90};
91
6c23f0bd
CH
92static inline struct dm_target_io *clone_to_tio(struct bio *clone)
93{
94 return container_of(clone, struct dm_target_io, clone);
95}
96
64f52b0e
MS
97void *dm_per_bio_data(struct bio *bio, size_t data_size)
98{
655f3aad 99 if (!dm_tio_flagged(clone_to_tio(bio), DM_TIO_INSIDE_DM_IO))
62f26317
JX
100 return (char *)bio - DM_TARGET_IO_BIO_OFFSET - data_size;
101 return (char *)bio - DM_IO_BIO_OFFSET - data_size;
64f52b0e
MS
102}
103EXPORT_SYMBOL_GPL(dm_per_bio_data);
104
105struct bio *dm_bio_from_per_bio_data(void *data, size_t data_size)
106{
107 struct dm_io *io = (struct dm_io *)((char *)data + data_size);
b30f1607 108
64f52b0e 109 if (io->magic == DM_IO_MAGIC)
62f26317 110 return (struct bio *)((char *)io + DM_IO_BIO_OFFSET);
64f52b0e 111 BUG_ON(io->magic != DM_TIO_MAGIC);
62f26317 112 return (struct bio *)((char *)io + DM_TARGET_IO_BIO_OFFSET);
64f52b0e
MS
113}
114EXPORT_SYMBOL_GPL(dm_bio_from_per_bio_data);
115
86a3238c 116unsigned int dm_bio_get_target_bio_nr(const struct bio *bio)
64f52b0e
MS
117{
118 return container_of(bio, struct dm_target_io, clone)->target_bio_nr;
119}
120EXPORT_SYMBOL_GPL(dm_bio_get_target_bio_nr);
121
ba61fdd1
JM
122#define MINOR_ALLOCED ((void *)-1)
123
115485e8 124#define DM_NUMA_NODE NUMA_NO_NODE
115485e8 125static int dm_numa_node = DM_NUMA_NODE;
faad87df 126
a666e5c0
MP
127#define DEFAULT_SWAP_BIOS (8 * 1048576 / PAGE_SIZE)
128static int swap_bios = DEFAULT_SWAP_BIOS;
129static int get_swap_bios(void)
130{
131 int latch = READ_ONCE(swap_bios);
b30f1607 132
a666e5c0
MP
133 if (unlikely(latch <= 0))
134 latch = DEFAULT_SWAP_BIOS;
135 return latch;
136}
137
86f1152b
BM
138struct table_device {
139 struct list_head list;
b0b4d7c6 140 refcount_t count;
86f1152b
BM
141 struct dm_dev dm_dev;
142};
143
e8603136
MS
144/*
145 * Bio-based DM's mempools' reserved IOs set by the user.
146 */
4cc96131 147#define RESERVED_BIO_BASED_IOS 16
86a3238c 148static unsigned int reserved_bio_based_ios = RESERVED_BIO_BASED_IOS;
e8603136 149
115485e8
MS
150static int __dm_get_module_param_int(int *module_param, int min, int max)
151{
6aa7de05 152 int param = READ_ONCE(*module_param);
115485e8
MS
153 int modified_param = 0;
154 bool modified = true;
155
156 if (param < min)
157 modified_param = min;
158 else if (param > max)
159 modified_param = max;
160 else
161 modified = false;
162
163 if (modified) {
164 (void)cmpxchg(module_param, param, modified_param);
165 param = modified_param;
166 }
167
168 return param;
169}
170
86a3238c 171unsigned int __dm_get_module_param(unsigned int *module_param, unsigned int def, unsigned int max)
f4790826 172{
86a3238c
HM
173 unsigned int param = READ_ONCE(*module_param);
174 unsigned int modified_param = 0;
f4790826 175
09c2d531
MS
176 if (!param)
177 modified_param = def;
178 else if (param > max)
179 modified_param = max;
f4790826 180
09c2d531
MS
181 if (modified_param) {
182 (void)cmpxchg(module_param, param, modified_param);
183 param = modified_param;
f4790826
MS
184 }
185
09c2d531 186 return param;
f4790826
MS
187}
188
86a3238c 189unsigned int dm_get_reserved_bio_based_ios(void)
e8603136 190{
09c2d531 191 return __dm_get_module_param(&reserved_bio_based_ios,
4cc96131 192 RESERVED_BIO_BASED_IOS, DM_RESERVED_MAX_IOS);
e8603136
MS
193}
194EXPORT_SYMBOL_GPL(dm_get_reserved_bio_based_ios);
195
86a3238c 196static unsigned int dm_get_numa_node(void)
115485e8
MS
197{
198 return __dm_get_module_param_int(&dm_numa_node,
199 DM_NUMA_NODE, num_online_nodes() - 1);
200}
201
1da177e4
LT
202static int __init local_init(void)
203{
e689fbab 204 int r;
1ae49ea2 205
51e5b2bd 206 r = dm_uevent_init();
51157b4a 207 if (r)
e689fbab 208 return r;
51e5b2bd 209
57bbf99c 210 deferred_remove_workqueue = alloc_ordered_workqueue("kdmremove", 0);
acfe0ad7
MP
211 if (!deferred_remove_workqueue) {
212 r = -ENOMEM;
213 goto out_uevent_exit;
214 }
215
1da177e4
LT
216 _major = major;
217 r = register_blkdev(_major, _name);
51157b4a 218 if (r < 0)
acfe0ad7 219 goto out_free_workqueue;
1da177e4
LT
220
221 if (!_major)
222 _major = r;
223
224 return 0;
51157b4a 225
acfe0ad7
MP
226out_free_workqueue:
227 destroy_workqueue(deferred_remove_workqueue);
51157b4a
KU
228out_uevent_exit:
229 dm_uevent_exit();
51157b4a
KU
230
231 return r;
1da177e4
LT
232}
233
234static void local_exit(void)
235{
acfe0ad7 236 destroy_workqueue(deferred_remove_workqueue);
2c140a24 237
00d59405 238 unregister_blkdev(_major, _name);
51e5b2bd 239 dm_uevent_exit();
1da177e4
LT
240
241 _major = 0;
242
243 DMINFO("cleaned up");
244}
245
b9249e55 246static int (*_inits[])(void) __initdata = {
1da177e4
LT
247 local_init,
248 dm_target_init,
249 dm_linear_init,
250 dm_stripe_init,
952b3557 251 dm_io_init,
945fa4d2 252 dm_kcopyd_init,
1da177e4 253 dm_interface_init,
fd2ed4d2 254 dm_statistics_init,
1da177e4
LT
255};
256
b9249e55 257static void (*_exits[])(void) = {
1da177e4
LT
258 local_exit,
259 dm_target_exit,
260 dm_linear_exit,
261 dm_stripe_exit,
952b3557 262 dm_io_exit,
945fa4d2 263 dm_kcopyd_exit,
1da177e4 264 dm_interface_exit,
fd2ed4d2 265 dm_statistics_exit,
1da177e4
LT
266};
267
268static int __init dm_init(void)
269{
270 const int count = ARRAY_SIZE(_inits);
1da177e4
LT
271 int r, i;
272
f1cd6cb2
TS
273#if (IS_ENABLED(CONFIG_IMA) && !IS_ENABLED(CONFIG_IMA_DISABLE_HTABLE))
274 DMWARN("CONFIG_IMA_DISABLE_HTABLE is disabled."
275 " Duplicate IMA measurements will not be recorded in the IMA log.");
276#endif
277
1da177e4
LT
278 for (i = 0; i < count; i++) {
279 r = _inits[i]();
280 if (r)
281 goto bad;
282 }
283
284 return 0;
f1cd6cb2 285bad:
1da177e4
LT
286 while (i--)
287 _exits[i]();
288
289 return r;
290}
291
292static void __exit dm_exit(void)
293{
294 int i = ARRAY_SIZE(_exits);
295
296 while (i--)
297 _exits[i]();
d15b774c
AK
298
299 /*
300 * Should be empty by this point.
301 */
d15b774c 302 idr_destroy(&_minor_idr);
1da177e4
LT
303}
304
305/*
306 * Block device functions
307 */
432a212c
MA
308int dm_deleting_md(struct mapped_device *md)
309{
310 return test_bit(DMF_DELETING, &md->flags);
311}
312
05bdb996 313static int dm_blk_open(struct gendisk *disk, blk_mode_t mode)
1da177e4
LT
314{
315 struct mapped_device *md;
316
fba9f90e
JM
317 spin_lock(&_minor_lock);
318
d32e2bf8 319 md = disk->private_data;
fba9f90e
JM
320 if (!md)
321 goto out;
322
5c6bd75d 323 if (test_bit(DMF_FREEING, &md->flags) ||
432a212c 324 dm_deleting_md(md)) {
fba9f90e
JM
325 md = NULL;
326 goto out;
327 }
328
1da177e4 329 dm_get(md);
5c6bd75d 330 atomic_inc(&md->open_count);
fba9f90e
JM
331out:
332 spin_unlock(&_minor_lock);
333
334 return md ? 0 : -ENXIO;
1da177e4
LT
335}
336
ae220766 337static void dm_blk_close(struct gendisk *disk)
1da177e4 338{
63a4f065 339 struct mapped_device *md;
6e9624b8 340
4a1aeb98
MB
341 spin_lock(&_minor_lock);
342
63a4f065
MS
343 md = disk->private_data;
344 if (WARN_ON(!md))
345 goto out;
346
2c140a24
MP
347 if (atomic_dec_and_test(&md->open_count) &&
348 (test_bit(DMF_DEFERRED_REMOVE, &md->flags)))
acfe0ad7 349 queue_work(deferred_remove_workqueue, &deferred_remove_work);
2c140a24 350
1da177e4 351 dm_put(md);
63a4f065 352out:
4a1aeb98 353 spin_unlock(&_minor_lock);
1da177e4
LT
354}
355
5c6bd75d
AK
356int dm_open_count(struct mapped_device *md)
357{
358 return atomic_read(&md->open_count);
359}
360
361/*
362 * Guarantees nothing is using the device before it's deleted.
363 */
2c140a24 364int dm_lock_for_deletion(struct mapped_device *md, bool mark_deferred, bool only_deferred)
5c6bd75d
AK
365{
366 int r = 0;
367
368 spin_lock(&_minor_lock);
369
2c140a24 370 if (dm_open_count(md)) {
5c6bd75d 371 r = -EBUSY;
2c140a24
MP
372 if (mark_deferred)
373 set_bit(DMF_DEFERRED_REMOVE, &md->flags);
374 } else if (only_deferred && !test_bit(DMF_DEFERRED_REMOVE, &md->flags))
375 r = -EEXIST;
5c6bd75d
AK
376 else
377 set_bit(DMF_DELETING, &md->flags);
378
379 spin_unlock(&_minor_lock);
380
381 return r;
382}
383
2c140a24
MP
384int dm_cancel_deferred_remove(struct mapped_device *md)
385{
386 int r = 0;
387
388 spin_lock(&_minor_lock);
389
390 if (test_bit(DMF_DELETING, &md->flags))
391 r = -EBUSY;
392 else
393 clear_bit(DMF_DEFERRED_REMOVE, &md->flags);
394
395 spin_unlock(&_minor_lock);
396
397 return r;
398}
399
400static void do_deferred_remove(struct work_struct *w)
401{
402 dm_deferred_remove();
403}
404
3ac51e74
DW
405static int dm_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
406{
407 struct mapped_device *md = bdev->bd_disk->private_data;
408
409 return dm_get_geometry(md, geo);
410}
411
971888c4 412static int dm_prepare_ioctl(struct mapped_device *md, int *srcu_idx,
5bd5e8d8 413 struct block_device **bdev)
aa129a22 414{
564b5c54 415 struct dm_target *ti;
6c182cd8 416 struct dm_table *map;
971888c4 417 int r;
aa129a22 418
6c182cd8 419retry:
e56f81e0 420 r = -ENOTTY;
971888c4 421 map = dm_get_live_table(md, srcu_idx);
aa129a22 422 if (!map || !dm_table_get_size(map))
971888c4 423 return r;
aa129a22
MB
424
425 /* We only support devices that have a single target */
2aec377a 426 if (map->num_targets != 1)
971888c4 427 return r;
aa129a22 428
564b5c54
MS
429 ti = dm_table_get_target(map, 0);
430 if (!ti->type->prepare_ioctl)
971888c4 431 return r;
519049af 432
971888c4
MS
433 if (dm_suspended_md(md))
434 return -EAGAIN;
aa129a22 435
564b5c54 436 r = ti->type->prepare_ioctl(ti, bdev);
5bbbfdf6 437 if (r == -ENOTCONN && !fatal_signal_pending(current)) {
971888c4 438 dm_put_live_table(md, *srcu_idx);
238d991f 439 fsleep(10000);
6c182cd8
HR
440 goto retry;
441 }
971888c4 442
e56f81e0
CH
443 return r;
444}
445
971888c4 446static void dm_unprepare_ioctl(struct mapped_device *md, int srcu_idx)
971888c4
MS
447{
448 dm_put_live_table(md, srcu_idx);
449}
450
05bdb996 451static int dm_blk_ioctl(struct block_device *bdev, blk_mode_t mode,
e56f81e0
CH
452 unsigned int cmd, unsigned long arg)
453{
454 struct mapped_device *md = bdev->bd_disk->private_data;
971888c4 455 int r, srcu_idx;
e56f81e0 456
5bd5e8d8 457 r = dm_prepare_ioctl(md, &srcu_idx, &bdev);
e56f81e0 458 if (r < 0)
971888c4 459 goto out;
6c182cd8 460
e56f81e0
CH
461 if (r > 0) {
462 /*
e980f623
CH
463 * Target determined this ioctl is being issued against a
464 * subset of the parent bdev; require extra privileges.
e56f81e0 465 */
e980f623 466 if (!capable(CAP_SYS_RAWIO)) {
0378c625 467 DMDEBUG_LIMIT(
e980f623
CH
468 "%s: sending ioctl %x to DM device without required privilege.",
469 current->comm, cmd);
470 r = -ENOIOCTLCMD;
e56f81e0 471 goto out;
e980f623 472 }
e56f81e0 473 }
6c182cd8 474
a7cb3d2f
CH
475 if (!bdev->bd_disk->fops->ioctl)
476 r = -ENOTTY;
477 else
478 r = bdev->bd_disk->fops->ioctl(bdev, mode, cmd, arg);
e56f81e0 479out:
971888c4 480 dm_unprepare_ioctl(md, srcu_idx);
aa129a22
MB
481 return r;
482}
483
7465d7ac
MS
484u64 dm_start_time_ns_from_clone(struct bio *bio)
485{
6c23f0bd 486 return jiffies_to_nsecs(clone_to_tio(bio)->io->start_time);
7465d7ac
MS
487}
488EXPORT_SYMBOL_GPL(dm_start_time_ns_from_clone);
489
06eed768 490static inline bool bio_is_flush_with_data(struct bio *bio)
7465d7ac 491{
8d394bc4
MS
492 return ((bio->bi_opf & REQ_PREFLUSH) && bio->bi_iter.bi_size);
493}
494
06eed768 495static inline unsigned int dm_io_sectors(struct dm_io *io, struct bio *bio)
8d394bc4 496{
d3de6d12
ML
497 /*
498 * If REQ_PREFLUSH set, don't account payload, it will be
499 * submitted (and accounted) after this flush completes.
500 */
501 if (bio_is_flush_with_data(bio))
06eed768
MS
502 return 0;
503 if (unlikely(dm_io_flagged(io, DM_IO_WAS_SPLIT)))
504 return io->sectors;
505 return bio_sectors(bio);
506}
8d394bc4 507
06eed768
MS
508static void dm_io_acct(struct dm_io *io, bool end)
509{
510 struct bio *bio = io->orig_bio;
8d394bc4 511
526d1006
LN
512 if (dm_io_flagged(io, DM_IO_BLK_STAT)) {
513 if (!end)
514 bdev_start_io_acct(bio->bi_bdev, bio_op(bio),
06eed768 515 io->start_time);
526d1006
LN
516 else
517 bdev_end_io_acct(bio->bi_bdev, bio_op(bio),
06eed768
MS
518 dm_io_sectors(io, bio),
519 io->start_time);
526d1006 520 }
7465d7ac 521
442761fd 522 if (static_branch_unlikely(&stats_enabled) &&
06eed768 523 unlikely(dm_stats_used(&io->md->stats))) {
7dd76d1f
ML
524 sector_t sector;
525
06eed768 526 if (unlikely(dm_io_flagged(io, DM_IO_WAS_SPLIT)))
7dd76d1f 527 sector = bio_end_sector(bio) - io->sector_offset;
06eed768
MS
528 else
529 sector = bio->bi_iter.bi_sector;
7dd76d1f 530
06eed768
MS
531 dm_stats_account_io(&io->md->stats, bio_data_dir(bio),
532 sector, dm_io_sectors(io, bio),
533 end, io->start_time, &io->stats_aux);
7dd76d1f 534 }
8d394bc4
MS
535}
536
b992b40d 537static void __dm_start_io_acct(struct dm_io *io)
8d394bc4 538{
e6926ad0 539 dm_io_acct(io, false);
7465d7ac
MS
540}
541
0fbb4d93 542static void dm_start_io_acct(struct dm_io *io, struct bio *clone)
7465d7ac 543{
0fbb4d93
MS
544 /*
545 * Ensure IO accounting is only ever started once.
0fbb4d93 546 */
3b03f7c1
MS
547 if (dm_io_flagged(io, DM_IO_ACCOUNTED))
548 return;
549
550 /* Expect no possibility for race unless DM_TIO_IS_DUPLICATE_BIO. */
551 if (!clone || likely(dm_tio_is_normal(clone_to_tio(clone)))) {
82f6cdcc
MS
552 dm_io_set_flag(io, DM_IO_ACCOUNTED);
553 } else {
554 unsigned long flags;
655f3aad 555 /* Can afford locking given DM_TIO_IS_DUPLICATE_BIO */
4d7bca13 556 spin_lock_irqsave(&io->lock, flags);
10eb3a0d
BM
557 if (dm_io_flagged(io, DM_IO_ACCOUNTED)) {
558 spin_unlock_irqrestore(&io->lock, flags);
559 return;
560 }
82f6cdcc 561 dm_io_set_flag(io, DM_IO_ACCOUNTED);
4d7bca13 562 spin_unlock_irqrestore(&io->lock, flags);
82f6cdcc 563 }
7465d7ac 564
b992b40d 565 __dm_start_io_acct(io);
0fbb4d93 566}
7465d7ac 567
b992b40d 568static void dm_end_io_acct(struct dm_io *io)
0fbb4d93 569{
e6926ad0 570 dm_io_acct(io, true);
7465d7ac 571}
978e51ba 572
6f25dd1c 573static struct dm_io *alloc_io(struct mapped_device *md, struct bio *bio, gfp_t gfp_mask)
1da177e4 574{
64f52b0e
MS
575 struct dm_io *io;
576 struct dm_target_io *tio;
577 struct bio *clone;
578
6f25dd1c
MS
579 clone = bio_alloc_clone(NULL, bio, gfp_mask, &md->mempools->io_bs);
580 if (unlikely(!clone))
581 return NULL;
6c23f0bd 582 tio = clone_to_tio(clone);
655f3aad
MS
583 tio->flags = 0;
584 dm_tio_set_flag(tio, DM_TIO_INSIDE_DM_IO);
64f52b0e
MS
585 tio->io = NULL;
586
587 io = container_of(tio, struct dm_io, tio);
588 io->magic = DM_IO_MAGIC;
84b98f4c 589 io->status = BLK_STS_OK;
0f14d60a
ML
590
591 /* one ref is for submission, the other is for completion */
592 atomic_set(&io->io_count, 2);
9f6dc633 593 this_cpu_inc(*md->pending_io);
7dd76d1f 594 io->orig_bio = bio;
978e51ba 595 io->md = md;
4d7bca13 596 spin_lock_init(&io->lock);
b879f915 597 io->start_time = jiffies;
82f6cdcc 598 io->flags = 0;
526d1006
LN
599 if (blk_queue_io_stat(md->queue))
600 dm_io_set_flag(io, DM_IO_BLK_STAT);
64f52b0e 601
c4f512d2
MS
602 if (static_branch_unlikely(&stats_enabled) &&
603 unlikely(dm_stats_used(&md->stats)))
442761fd 604 dm_stats_record_start(&md->stats, &io->stats_aux);
64f52b0e
MS
605
606 return io;
1da177e4
LT
607}
608
0119ab14 609static void free_io(struct dm_io *io)
1da177e4 610{
64f52b0e
MS
611 bio_put(&io->tio.clone);
612}
613
1d1068ce 614static struct bio *alloc_tio(struct clone_info *ci, struct dm_target *ti,
86a3238c 615 unsigned int target_bio_nr, unsigned int *len, gfp_t gfp_mask)
64f52b0e 616{
9dd1cd32 617 struct mapped_device *md = ci->io->md;
64f52b0e 618 struct dm_target_io *tio;
018b05eb 619 struct bio *clone;
64f52b0e
MS
620
621 if (!ci->io->tio.io) {
622 /* the dm_target_io embedded in ci->io is available */
623 tio = &ci->io->tio;
018b05eb
MS
624 /* alloc_io() already initialized embedded clone */
625 clone = &tio->clone;
64f52b0e 626 } else {
29dec90a
CH
627 clone = bio_alloc_clone(NULL, ci->bio, gfp_mask,
628 &md->mempools->bs);
64f52b0e
MS
629 if (!clone)
630 return NULL;
631
b99fdcdc
ML
632 /* REQ_DM_POLL_LIST shouldn't be inherited */
633 clone->bi_opf &= ~REQ_DM_POLL_LIST;
634
6c23f0bd 635 tio = clone_to_tio(clone);
655f3aad 636 tio->flags = 0; /* also clears DM_TIO_INSIDE_DM_IO */
64f52b0e
MS
637 }
638
639 tio->magic = DM_TIO_MAGIC;
640 tio->io = ci->io;
641 tio->ti = ti;
642 tio->target_bio_nr = target_bio_nr;
dc8e2021 643 tio->len_ptr = len;
743598f0 644 tio->old_sector = 0;
64f52b0e 645
9dd1cd32
MS
646 /* Set default bdev, but target must bio_set_dev() before issuing IO */
647 clone->bi_bdev = md->disk->part0;
648 if (unlikely(ti->needs_bio_set_dev))
649 bio_set_dev(clone, md->disk->part0);
650
018b05eb
MS
651 if (len) {
652 clone->bi_iter.bi_size = to_bytes(*len);
653 if (bio_integrity(clone))
654 bio_integrity_trim(clone);
655 }
64f52b0e 656
018b05eb 657 return clone;
1da177e4
LT
658}
659
1d1068ce 660static void free_tio(struct bio *clone)
1da177e4 661{
655f3aad 662 if (dm_tio_flagged(clone_to_tio(clone), DM_TIO_INSIDE_DM_IO))
64f52b0e 663 return;
1d1068ce 664 bio_put(clone);
1da177e4
LT
665}
666
667/*
668 * Add the bio to the list of deferred io.
669 */
92c63902 670static void queue_io(struct mapped_device *md, struct bio *bio)
1da177e4 671{
05447420 672 unsigned long flags;
1da177e4 673
05447420 674 spin_lock_irqsave(&md->deferred_lock, flags);
1da177e4 675 bio_list_add(&md->deferred, bio);
05447420 676 spin_unlock_irqrestore(&md->deferred_lock, flags);
6a8736d1 677 queue_work(md->wq, &md->work);
1da177e4
LT
678}
679
680/*
681 * Everyone (including functions in this file), should use this
682 * function to access the md->map field, and make sure they call
83d5e5b0 683 * dm_put_live_table() when finished.
1da177e4 684 */
563a225c
MS
685struct dm_table *dm_get_live_table(struct mapped_device *md,
686 int *srcu_idx) __acquires(md->io_barrier)
1da177e4 687{
83d5e5b0
MP
688 *srcu_idx = srcu_read_lock(&md->io_barrier);
689
690 return srcu_dereference(md->map, &md->io_barrier);
691}
1da177e4 692
563a225c
MS
693void dm_put_live_table(struct mapped_device *md,
694 int srcu_idx) __releases(md->io_barrier)
83d5e5b0
MP
695{
696 srcu_read_unlock(&md->io_barrier, srcu_idx);
697}
698
699void dm_sync_table(struct mapped_device *md)
700{
701 synchronize_srcu(&md->io_barrier);
702 synchronize_rcu_expedited();
703}
704
705/*
706 * A fast alternative to dm_get_live_table/dm_put_live_table.
707 * The caller must not block between these two functions.
708 */
709static struct dm_table *dm_get_live_table_fast(struct mapped_device *md) __acquires(RCU)
710{
711 rcu_read_lock();
712 return rcu_dereference(md->map);
713}
1da177e4 714
83d5e5b0
MP
715static void dm_put_live_table_fast(struct mapped_device *md) __releases(RCU)
716{
717 rcu_read_unlock();
1da177e4
LT
718}
719
971888c4
MS
720static char *_dm_claim_ptr = "I belong to device-mapper";
721
86f1152b
BM
722/*
723 * Open a table device so we can use it as a map destination.
724 */
b9a785d2 725static struct table_device *open_table_device(struct mapped_device *md,
05bdb996 726 dev_t dev, blk_mode_t mode)
86f1152b 727{
b9a785d2 728 struct table_device *td;
a28d893e
CB
729 struct file *bdev_file;
730 struct block_device *bdev;
cd913c76 731 u64 part_off;
86f1152b
BM
732 int r;
733
b9a785d2
CH
734 td = kmalloc_node(sizeof(*td), GFP_KERNEL, md->numa_node_id);
735 if (!td)
736 return ERR_PTR(-ENOMEM);
737 refcount_set(&td->count, 1);
86f1152b 738
a28d893e
CB
739 bdev_file = bdev_file_open_by_dev(dev, mode, _dm_claim_ptr, NULL);
740 if (IS_ERR(bdev_file)) {
741 r = PTR_ERR(bdev_file);
b9a785d2
CH
742 goto out_free_td;
743 }
86f1152b 744
a28d893e
CB
745 bdev = file_bdev(bdev_file);
746
1a581b72
CH
747 /*
748 * We can be called before the dm disk is added. In that case we can't
749 * register the holder relation here. It will be done once add_disk was
750 * called.
751 */
752 if (md->disk->slave_dir) {
a28d893e 753 r = bd_link_disk_holder(bdev, md->disk);
1a581b72
CH
754 if (r)
755 goto out_blkdev_put;
756 }
86f1152b 757
b9a785d2 758 td->dm_dev.mode = mode;
a28d893e
CB
759 td->dm_dev.bdev = bdev;
760 td->dm_dev.bdev_file = bdev_file;
761 td->dm_dev.dax_dev = fs_dax_get_by_bdev(bdev, &part_off,
c2fce61f 762 NULL, NULL);
b9a785d2
CH
763 format_dev_t(td->dm_dev.name, dev);
764 list_add(&td->list, &md->table_devices);
765 return td;
766
767out_blkdev_put:
a28d893e 768 fput(bdev_file);
b9a785d2
CH
769out_free_td:
770 kfree(td);
771 return ERR_PTR(r);
86f1152b
BM
772}
773
774/*
775 * Close a table device that we've been using.
776 */
777static void close_table_device(struct table_device *td, struct mapped_device *md)
778{
1a581b72
CH
779 if (md->disk->slave_dir)
780 bd_unlink_disk_holder(td->dm_dev.bdev, md->disk);
a28d893e 781 fput(td->dm_dev.bdev_file);
817bf402 782 put_dax(td->dm_dev.dax_dev);
7b586583
CH
783 list_del(&td->list);
784 kfree(td);
86f1152b
BM
785}
786
787static struct table_device *find_table_device(struct list_head *l, dev_t dev,
05bdb996 788 blk_mode_t mode)
8454fca4 789{
86f1152b
BM
790 struct table_device *td;
791
792 list_for_each_entry(td, l, list)
793 if (td->dm_dev.bdev->bd_dev == dev && td->dm_dev.mode == mode)
794 return td;
795
796 return NULL;
797}
798
05bdb996 799int dm_get_table_device(struct mapped_device *md, dev_t dev, blk_mode_t mode,
8454fca4
SS
800 struct dm_dev **result)
801{
86f1152b
BM
802 struct table_device *td;
803
804 mutex_lock(&md->table_devices_lock);
805 td = find_table_device(&md->table_devices, dev, mode);
806 if (!td) {
b9a785d2
CH
807 td = open_table_device(md, dev, mode);
808 if (IS_ERR(td)) {
86f1152b 809 mutex_unlock(&md->table_devices_lock);
b9a785d2 810 return PTR_ERR(td);
86f1152b 811 }
b0b4d7c6
ER
812 } else {
813 refcount_inc(&td->count);
86f1152b 814 }
86f1152b
BM
815 mutex_unlock(&md->table_devices_lock);
816
817 *result = &td->dm_dev;
818 return 0;
819}
86f1152b
BM
820
821void dm_put_table_device(struct mapped_device *md, struct dm_dev *d)
822{
823 struct table_device *td = container_of(d, struct table_device, dm_dev);
824
825 mutex_lock(&md->table_devices_lock);
7b586583 826 if (refcount_dec_and_test(&td->count))
86f1152b 827 close_table_device(td, md);
86f1152b
BM
828 mutex_unlock(&md->table_devices_lock);
829}
86f1152b 830
3ac51e74
DW
831/*
832 * Get the geometry associated with a dm device
833 */
834int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo)
835{
836 *geo = md->geometry;
837
838 return 0;
839}
840
841/*
842 * Set the geometry of a device.
843 */
844int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo)
845{
846 sector_t sz = (sector_t)geo->cylinders * geo->heads * geo->sectors;
847
848 if (geo->start > sz) {
43e6c111 849 DMERR("Start sector is beyond the geometry limits.");
3ac51e74
DW
850 return -EINVAL;
851 }
852
853 md->geometry = *geo;
854
855 return 0;
856}
857
2e93ccc1
KU
858static int __noflush_suspending(struct mapped_device *md)
859{
860 return test_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
861}
862
8b211aac 863static void dm_requeue_add_io(struct dm_io *io, bool first_stage)
1da177e4 864{
b35f8caa 865 struct mapped_device *md = io->md;
1da177e4 866
8b211aac
ML
867 if (first_stage) {
868 struct dm_io *next = md->requeue_list;
869
870 md->requeue_list = io;
871 io->next = next;
872 } else {
873 bio_list_add_head(&md->deferred, io->orig_bio);
874 }
875}
876
877static void dm_kick_requeue(struct mapped_device *md, bool first_stage)
878{
879 if (first_stage)
880 queue_work(md->wq, &md->requeue_work);
881 else
882 queue_work(md->wq, &md->work);
883}
884
444fe04f
ML
885/*
886 * Return true if the dm_io's original bio is requeued.
887 * io->status is updated with error if requeue disallowed.
888 */
8b211aac 889static bool dm_handle_requeue(struct dm_io *io, bool first_stage)
1da177e4 890{
8b211aac 891 struct bio *bio = io->orig_bio;
444fe04f
ML
892 bool handle_requeue = (io->status == BLK_STS_DM_REQUEUE);
893 bool handle_polled_eagain = ((io->status == BLK_STS_AGAIN) &&
894 (bio->bi_opf & REQ_POLLED));
895 struct mapped_device *md = io->md;
896 bool requeued = false;
1da177e4 897
444fe04f 898 if (handle_requeue || handle_polled_eagain) {
e2736347 899 unsigned long flags;
444fe04f
ML
900
901 if (bio->bi_opf & REQ_POLLED) {
902 /*
903 * Upper layer won't help us poll split bio
904 * (io->orig_bio may only reflect a subset of the
905 * pre-split original) so clear REQ_POLLED.
906 */
907 bio_clear_polled(bio);
908 }
909
e2736347 910 /*
444fe04f
ML
911 * Target requested pushing back the I/O or
912 * polled IO hit BLK_STS_AGAIN.
e2736347
MS
913 */
914 spin_lock_irqsave(&md->deferred_lock, flags);
444fe04f
ML
915 if ((__noflush_suspending(md) &&
916 !WARN_ON_ONCE(dm_is_zone_write(md, bio))) ||
8b211aac
ML
917 handle_polled_eagain || first_stage) {
918 dm_requeue_add_io(io, first_stage);
444fe04f 919 requeued = true;
e2736347 920 } else {
2e93ccc1 921 /*
e2736347
MS
922 * noflush suspend was interrupted or this is
923 * a write to a zoned target.
2e93ccc1 924 */
e2736347 925 io->status = BLK_STS_IOERR;
2e93ccc1 926 }
e2736347
MS
927 spin_unlock_irqrestore(&md->deferred_lock, flags);
928 }
2e93ccc1 929
444fe04f 930 if (requeued)
8b211aac 931 dm_kick_requeue(md, first_stage);
444fe04f
ML
932
933 return requeued;
934}
935
8b211aac 936static void __dm_io_complete(struct dm_io *io, bool first_stage)
444fe04f 937{
8b211aac 938 struct bio *bio = io->orig_bio;
444fe04f
ML
939 struct mapped_device *md = io->md;
940 blk_status_t io_error;
941 bool requeued;
942
8b211aac
ML
943 requeued = dm_handle_requeue(io, first_stage);
944 if (requeued && first_stage)
945 return;
444fe04f 946
e2736347 947 io_error = io->status;
82f6cdcc 948 if (dm_io_flagged(io, DM_IO_ACCOUNTED))
b992b40d 949 dm_end_io_acct(io);
e2736347
MS
950 else if (!io_error) {
951 /*
952 * Must handle target that DM_MAPIO_SUBMITTED only to
953 * then bio_endio() rather than dm_submit_bio_remap()
954 */
b992b40d
ML
955 __dm_start_io_acct(io);
956 dm_end_io_acct(io);
e2736347
MS
957 }
958 free_io(io);
959 smp_wmb();
960 this_cpu_dec(*md->pending_io);
6a8736d1 961
e2736347
MS
962 /* nudge anyone waiting on suspend queue */
963 if (unlikely(wq_has_sleeper(&md->wait)))
964 wake_up(&md->wait);
2e93ccc1 965
444fe04f
ML
966 /* Return early if the original bio was requeued */
967 if (requeued)
968 return;
e2736347
MS
969
970 if (bio_is_flush_with_data(bio)) {
971 /*
972 * Preflush done for flush with data, reissue
973 * without REQ_PREFLUSH.
974 */
975 bio->bi_opf &= ~REQ_PREFLUSH;
976 queue_io(md, bio);
977 } else {
978 /* done with normal IO or empty flush */
979 if (io_error)
980 bio->bi_status = io_error;
981 bio_endio(bio);
982 }
983}
984
8b211aac
ML
985static void dm_wq_requeue_work(struct work_struct *work)
986{
987 struct mapped_device *md = container_of(work, struct mapped_device,
988 requeue_work);
989 unsigned long flags;
990 struct dm_io *io;
991
992 /* reuse deferred lock to simplify dm_handle_requeue */
993 spin_lock_irqsave(&md->deferred_lock, flags);
994 io = md->requeue_list;
995 md->requeue_list = NULL;
996 spin_unlock_irqrestore(&md->deferred_lock, flags);
997
998 while (io) {
999 struct dm_io *next = io->next;
1000
46754bd0 1001 dm_io_rewind(io, &md->disk->bio_split);
8b211aac
ML
1002
1003 io->next = NULL;
1004 __dm_io_complete(io, false);
1005 io = next;
f77692d6 1006 cond_resched();
8b211aac
ML
1007 }
1008}
1009
1010/*
1011 * Two staged requeue:
1012 *
1013 * 1) io->orig_bio points to the real original bio, and the part mapped to
1014 * this io must be requeued, instead of other parts of the original bio.
1015 *
1016 * 2) io->orig_bio points to new cloned bio which matches the requeued dm_io.
1017 */
1018static void dm_io_complete(struct dm_io *io)
1019{
1020 bool first_requeue;
1021
1022 /*
1023 * Only dm_io that has been split needs two stage requeue, otherwise
1024 * we may run into long bio clone chain during suspend and OOM could
1025 * be triggered.
1026 *
1027 * Also flush data dm_io won't be marked as DM_IO_WAS_SPLIT, so they
1028 * also aren't handled via the first stage requeue.
1029 */
1030 if (dm_io_flagged(io, DM_IO_WAS_SPLIT))
1031 first_requeue = true;
1032 else
1033 first_requeue = false;
1034
1035 __dm_io_complete(io, first_requeue);
1036}
1037
1da177e4
LT
1038/*
1039 * Decrements the number of outstanding ios that a bio has been
1040 * cloned into, completing the original io if necc.
1041 */
84b98f4c
MS
1042static inline void __dm_io_dec_pending(struct dm_io *io)
1043{
1044 if (atomic_dec_and_test(&io->io_count))
1045 dm_io_complete(io);
1046}
1047
1048static void dm_io_set_error(struct dm_io *io, blk_status_t error)
1da177e4 1049{
84b98f4c
MS
1050 unsigned long flags;
1051
2e93ccc1 1052 /* Push-back supersedes any I/O errors */
84b98f4c
MS
1053 spin_lock_irqsave(&io->lock, flags);
1054 if (!(io->status == BLK_STS_DM_REQUEUE &&
1055 __noflush_suspending(io->md))) {
1056 io->status = error;
1da177e4 1057 }
84b98f4c
MS
1058 spin_unlock_irqrestore(&io->lock, flags);
1059}
1da177e4 1060
2e803cd9 1061static void dm_io_dec_pending(struct dm_io *io, blk_status_t error)
84b98f4c
MS
1062{
1063 if (unlikely(error))
1064 dm_io_set_error(io, error);
1065
1066 __dm_io_dec_pending(io);
1da177e4
LT
1067}
1068
f7995089
MS
1069/*
1070 * The queue_limits are only valid as long as you have a reference
1071 * count on 'md'. But _not_ imposing verification to avoid atomic_read(),
1072 */
1073static inline struct queue_limits *dm_get_queue_limits(struct mapped_device *md)
1074{
1075 return &md->queue->limits;
1076}
1077
bcb44433
MS
1078void disable_discard(struct mapped_device *md)
1079{
1080 struct queue_limits *limits = dm_get_queue_limits(md);
1081
1082 /* device doesn't really support DISCARD, disable it */
1083 limits->max_discard_sectors = 0;
bcb44433
MS
1084}
1085
ac62d620
CH
1086void disable_write_zeroes(struct mapped_device *md)
1087{
1088 struct queue_limits *limits = dm_get_queue_limits(md);
1089
1090 /* device doesn't really support WRITE ZEROES, disable it */
1091 limits->max_write_zeroes_sectors = 0;
1092}
1093
a666e5c0
MP
1094static bool swap_bios_limit(struct dm_target *ti, struct bio *bio)
1095{
1096 return unlikely((bio->bi_opf & REQ_SWAP) != 0) && unlikely(ti->limit_swap_bios);
1097}
1098
4246a0b6 1099static void clone_endio(struct bio *bio)
1da177e4 1100{
4e4cbee9 1101 blk_status_t error = bio->bi_status;
6c23f0bd 1102 struct dm_target_io *tio = clone_to_tio(bio);
6cbce280
MS
1103 struct dm_target *ti = tio->ti;
1104 dm_endio_fn endio = ti->type->end_io;
b35f8caa 1105 struct dm_io *io = tio->io;
6cbce280 1106 struct mapped_device *md = io->md;
1da177e4 1107
dddf3056
MS
1108 if (unlikely(error == BLK_STS_TARGET)) {
1109 if (bio_op(bio) == REQ_OP_DISCARD &&
1110 !bdev_max_discard_sectors(bio->bi_bdev))
1111 disable_discard(md);
1112 else if (bio_op(bio) == REQ_OP_WRITE_ZEROES &&
1113 !bdev_write_zeroes_sectors(bio->bi_bdev))
1114 disable_write_zeroes(md);
ca522482 1115 }
415c79e1 1116
dddf3056 1117 if (static_branch_unlikely(&zoned_enabled) &&
edd1dbc8 1118 unlikely(bdev_is_zoned(bio->bi_bdev)))
dddf3056
MS
1119 dm_zone_endio(io, bio);
1120
1be56909 1121 if (endio) {
6cbce280 1122 int r = endio(ti, bio, &error);
b30f1607 1123
1be56909
CH
1124 switch (r) {
1125 case DM_ENDIO_REQUEUE:
442761fd
MS
1126 if (static_branch_unlikely(&zoned_enabled)) {
1127 /*
1128 * Requeuing writes to a sequential zone of a zoned
1129 * target will break the sequential write pattern:
1130 * fail such IO.
1131 */
1132 if (WARN_ON_ONCE(dm_is_zone_write(md, bio)))
1133 error = BLK_STS_IOERR;
1134 else
1135 error = BLK_STS_DM_REQUEUE;
1136 } else
bf14e2b2 1137 error = BLK_STS_DM_REQUEUE;
df561f66 1138 fallthrough;
1be56909
CH
1139 case DM_ENDIO_DONE:
1140 break;
1141 case DM_ENDIO_INCOMPLETE:
1142 /* The target will handle the io */
1143 return;
1144 default:
43e6c111 1145 DMCRIT("unimplemented target endio return value: %d", r);
1be56909
CH
1146 BUG();
1147 }
1148 }
1149
442761fd
MS
1150 if (static_branch_unlikely(&swap_bios_enabled) &&
1151 unlikely(swap_bios_limit(ti, bio)))
a666e5c0 1152 up(&md->swap_bios_semaphore);
a666e5c0 1153
1d1068ce 1154 free_tio(bio);
e2118b3c 1155 dm_io_dec_pending(io, error);
1da177e4
LT
1156}
1157
56a67df7
MS
1158/*
1159 * Return maximum size of I/O possible at the supplied sector up to the current
1160 * target boundary.
1161 */
3720281d
MS
1162static inline sector_t max_io_len_target_boundary(struct dm_target *ti,
1163 sector_t target_offset)
56a67df7 1164{
56a67df7
MS
1165 return ti->len - target_offset;
1166}
1167
06961c48 1168static sector_t __max_io_len(struct dm_target *ti, sector_t sector,
be04c14a
MS
1169 unsigned int max_granularity,
1170 unsigned int max_sectors)
1da177e4 1171{
3720281d
MS
1172 sector_t target_offset = dm_target_offset(ti, sector);
1173 sector_t len = max_io_len_target_boundary(ti, target_offset);
1da177e4
LT
1174
1175 /*
3ee16db3
MS
1176 * Does the target need to split IO even further?
1177 * - varied (per target) IO splitting is a tenet of DM; this
1178 * explains why stacked chunk_sectors based splitting via
5a97806f 1179 * bio_split_to_limits() isn't possible here.
1da177e4 1180 */
06961c48 1181 if (!max_granularity)
c3949322
CH
1182 return len;
1183 return min_t(sector_t, len,
be04c14a 1184 min(max_sectors ? : queue_max_sectors(ti->table->md->queue),
06961c48
MS
1185 blk_chunk_sectors_left(target_offset, max_granularity)));
1186}
1187
1188static inline sector_t max_io_len(struct dm_target *ti, sector_t sector)
1189{
be04c14a 1190 return __max_io_len(ti, sector, ti->max_io_len, 0);
1da177e4
LT
1191}
1192
542f9038
MS
1193int dm_set_target_max_io_len(struct dm_target *ti, sector_t len)
1194{
1195 if (len > UINT_MAX) {
1196 DMERR("Specified maximum size of target IO (%llu) exceeds limit (%u)",
1197 (unsigned long long)len, UINT_MAX);
1198 ti->error = "Maximum size of target IO is too large";
1199 return -EINVAL;
1200 }
1201
75ae1936 1202 ti->max_io_len = (uint32_t) len;
542f9038
MS
1203
1204 return 0;
1205}
1206EXPORT_SYMBOL_GPL(dm_set_target_max_io_len);
1207
f26c5719 1208static struct dm_target *dm_dax_get_live_target(struct mapped_device *md,
3d97c829
MS
1209 sector_t sector, int *srcu_idx)
1210 __acquires(md->io_barrier)
545ed20e 1211{
545ed20e
TK
1212 struct dm_table *map;
1213 struct dm_target *ti;
545ed20e 1214
f26c5719 1215 map = dm_get_live_table(md, srcu_idx);
545ed20e 1216 if (!map)
f26c5719 1217 return NULL;
545ed20e
TK
1218
1219 ti = dm_table_find_target(map, sector);
123d87d5 1220 if (!ti)
f26c5719 1221 return NULL;
545ed20e 1222
f26c5719
DW
1223 return ti;
1224}
545ed20e 1225
f26c5719 1226static long dm_dax_direct_access(struct dax_device *dax_dev, pgoff_t pgoff,
e511c4a3
JC
1227 long nr_pages, enum dax_access_mode mode, void **kaddr,
1228 pfn_t *pfn)
f26c5719
DW
1229{
1230 struct mapped_device *md = dax_get_private(dax_dev);
1231 sector_t sector = pgoff * PAGE_SECTORS;
1232 struct dm_target *ti;
1233 long len, ret = -EIO;
1234 int srcu_idx;
545ed20e 1235
f26c5719 1236 ti = dm_dax_get_live_target(md, sector, &srcu_idx);
545ed20e 1237
f26c5719
DW
1238 if (!ti)
1239 goto out;
1240 if (!ti->type->direct_access)
1241 goto out;
3720281d 1242 len = max_io_len(ti, sector) / PAGE_SECTORS;
f26c5719
DW
1243 if (len < 1)
1244 goto out;
1245 nr_pages = min(len, nr_pages);
e511c4a3 1246 ret = ti->type->direct_access(ti, pgoff, nr_pages, mode, kaddr, pfn);
817bf402 1247
f26c5719 1248 out:
545ed20e 1249 dm_put_live_table(md, srcu_idx);
f26c5719
DW
1250
1251 return ret;
545ed20e
TK
1252}
1253
cdf6cdcd
VG
1254static int dm_dax_zero_page_range(struct dax_device *dax_dev, pgoff_t pgoff,
1255 size_t nr_pages)
1256{
1257 struct mapped_device *md = dax_get_private(dax_dev);
1258 sector_t sector = pgoff * PAGE_SECTORS;
1259 struct dm_target *ti;
1260 int ret = -EIO;
1261 int srcu_idx;
1262
1263 ti = dm_dax_get_live_target(md, sector, &srcu_idx);
1264
1265 if (!ti)
1266 goto out;
1267 if (WARN_ON(!ti->type->dax_zero_page_range)) {
1268 /*
1269 * ->zero_page_range() is mandatory dax operation. If we are
1270 * here, something is wrong.
1271 */
cdf6cdcd
VG
1272 goto out;
1273 }
1274 ret = ti->type->dax_zero_page_range(ti, pgoff, nr_pages);
cdf6cdcd
VG
1275 out:
1276 dm_put_live_table(md, srcu_idx);
1277
1278 return ret;
1279}
1280
047218ec
JC
1281static size_t dm_dax_recovery_write(struct dax_device *dax_dev, pgoff_t pgoff,
1282 void *addr, size_t bytes, struct iov_iter *i)
1283{
1284 struct mapped_device *md = dax_get_private(dax_dev);
1285 sector_t sector = pgoff * PAGE_SECTORS;
1286 struct dm_target *ti;
1287 int srcu_idx;
1288 long ret = 0;
1289
1290 ti = dm_dax_get_live_target(md, sector, &srcu_idx);
1291 if (!ti || !ti->type->dax_recovery_write)
1292 goto out;
1293
1294 ret = ti->type->dax_recovery_write(ti, pgoff, addr, bytes, i);
1295out:
1296 dm_put_live_table(md, srcu_idx);
1297 return ret;
1298}
1299
1dd40c3e
MP
1300/*
1301 * A target may call dm_accept_partial_bio only from the map routine. It is
6842d264 1302 * allowed for all bio types except REQ_PREFLUSH, REQ_OP_ZONE_* zone management
e6fc9f62
MS
1303 * operations, REQ_OP_ZONE_APPEND (zone append writes) and any bio serviced by
1304 * __send_duplicate_bios().
1dd40c3e
MP
1305 *
1306 * dm_accept_partial_bio informs the dm that the target only wants to process
1307 * additional n_sectors sectors of the bio and the rest of the data should be
1308 * sent in a next bio.
1309 *
1310 * A diagram that explains the arithmetics:
1311 * +--------------------+---------------+-------+
1312 * | 1 | 2 | 3 |
1313 * +--------------------+---------------+-------+
1314 *
1315 * <-------------- *tio->len_ptr --------------->
bdb34759 1316 * <----- bio_sectors ----->
1dd40c3e
MP
1317 * <-- n_sectors -->
1318 *
1319 * Region 1 was already iterated over with bio_advance or similar function.
1320 * (it may be empty if the target doesn't use bio_advance)
1321 * Region 2 is the remaining bio size that the target wants to process.
1322 * (it may be empty if region 1 is non-empty, although there is no reason
1323 * to make it empty)
1324 * The target requires that region 3 is to be sent in the next bio.
1325 *
1326 * If the target wants to receive multiple copies of the bio (via num_*bios, etc),
1327 * the partially processed part (the sum of regions 1+2) must be the same for all
1328 * copies of the bio.
1329 */
86a3238c 1330void dm_accept_partial_bio(struct bio *bio, unsigned int n_sectors)
1dd40c3e 1331{
6c23f0bd 1332 struct dm_target_io *tio = clone_to_tio(bio);
8b211aac 1333 struct dm_io *io = tio->io;
86a3238c 1334 unsigned int bio_sectors = bio_sectors(bio);
6842d264 1335
655f3aad 1336 BUG_ON(dm_tio_flagged(tio, DM_TIO_IS_DUPLICATE_BIO));
6842d264
DLM
1337 BUG_ON(op_is_zone_mgmt(bio_op(bio)));
1338 BUG_ON(bio_op(bio) == REQ_OP_ZONE_APPEND);
bdb34759
MS
1339 BUG_ON(bio_sectors > *tio->len_ptr);
1340 BUG_ON(n_sectors > bio_sectors);
6842d264 1341
bdb34759 1342 *tio->len_ptr -= bio_sectors - n_sectors;
1dd40c3e 1343 bio->bi_iter.bi_size = n_sectors << SECTOR_SHIFT;
7dd76d1f
ML
1344
1345 /*
1346 * __split_and_process_bio() may have already saved mapped part
1347 * for accounting but it is being reduced so update accordingly.
1348 */
8b211aac
ML
1349 dm_io_set_flag(io, DM_IO_WAS_SPLIT);
1350 io->sectors = n_sectors;
1351 io->sector_offset = bio_sectors(io->orig_bio);
1dd40c3e
MP
1352}
1353EXPORT_SYMBOL_GPL(dm_accept_partial_bio);
1354
0fbb4d93
MS
1355/*
1356 * @clone: clone bio that DM core passed to target's .map function
1357 * @tgt_clone: clone of @clone bio that target needs submitted
0fbb4d93
MS
1358 *
1359 * Targets should use this interface to submit bios they take
1360 * ownership of when returning DM_MAPIO_SUBMITTED.
1361 *
1362 * Target should also enable ti->accounts_remapped_io
1363 */
b7f8dff0 1364void dm_submit_bio_remap(struct bio *clone, struct bio *tgt_clone)
0fbb4d93
MS
1365{
1366 struct dm_target_io *tio = clone_to_tio(clone);
1367 struct dm_io *io = tio->io;
1368
1369 /* establish bio that will get submitted */
1370 if (!tgt_clone)
1371 tgt_clone = clone;
1372
1373 /*
1374 * Account io->origin_bio to DM dev on behalf of target
1375 * that took ownership of IO with DM_MAPIO_SUBMITTED.
1376 */
9d20653f 1377 dm_start_io_acct(io, clone);
0fbb4d93 1378
9d20653f 1379 trace_block_bio_remap(tgt_clone, disk_devt(io->md->disk),
0fbb4d93 1380 tio->old_sector);
9d20653f 1381 submit_bio_noacct(tgt_clone);
0fbb4d93
MS
1382}
1383EXPORT_SYMBOL_GPL(dm_submit_bio_remap);
1384
a666e5c0
MP
1385static noinline void __set_swap_bios_limit(struct mapped_device *md, int latch)
1386{
1387 mutex_lock(&md->swap_bios_lock);
1388 while (latch < md->swap_bios) {
1389 cond_resched();
1390 down(&md->swap_bios_semaphore);
1391 md->swap_bios--;
1392 }
1393 while (latch > md->swap_bios) {
1394 cond_resched();
1395 up(&md->swap_bios_semaphore);
1396 md->swap_bios++;
1397 }
1398 mutex_unlock(&md->swap_bios_lock);
1399}
1400
1561b396 1401static void __map_bio(struct bio *clone)
1da177e4 1402{
1561b396 1403 struct dm_target_io *tio = clone_to_tio(clone);
bd2a49b8 1404 struct dm_target *ti = tio->ti;
6cbce280
MS
1405 struct dm_io *io = tio->io;
1406 struct mapped_device *md = io->md;
1407 int r;
1da177e4 1408
1da177e4 1409 clone->bi_end_io = clone_endio;
1da177e4
LT
1410
1411 /*
0fbb4d93 1412 * Map the clone.
1da177e4 1413 */
743598f0 1414 tio->old_sector = clone->bi_iter.bi_sector;
d67a5f4b 1415
442761fd
MS
1416 if (static_branch_unlikely(&swap_bios_enabled) &&
1417 unlikely(swap_bios_limit(ti, clone))) {
a666e5c0 1418 int latch = get_swap_bios();
b30f1607 1419
a666e5c0
MP
1420 if (unlikely(latch != md->swap_bios))
1421 __set_swap_bios_limit(md, latch);
1422 down(&md->swap_bios_semaphore);
1423 }
1424
442761fd
MS
1425 if (static_branch_unlikely(&zoned_enabled)) {
1426 /*
1427 * Check if the IO needs a special mapping due to zone append
1428 * emulation on zoned target. In this case, dm_zone_map_bio()
1429 * calls the target map operation.
1430 */
1431 if (unlikely(dm_emulate_zone_append(md)))
1432 r = dm_zone_map_bio(tio);
f1445032
MP
1433 else
1434 goto do_map;
1435 } else {
1436do_map:
1437 if (likely(ti->type->map == linear_map))
1438 r = linear_map(ti, clone);
1439 else if (ti->type->map == stripe_map)
1440 r = stripe_map(ti, clone);
442761fd
MS
1441 else
1442 r = ti->type->map(ti, clone);
f1445032 1443 }
bb37d772 1444
846785e6
CH
1445 switch (r) {
1446 case DM_MAPIO_SUBMITTED:
0fbb4d93
MS
1447 /* target has assumed ownership of this io */
1448 if (!ti->accounts_remapped_io)
9d20653f 1449 dm_start_io_acct(io, clone);
846785e6
CH
1450 break;
1451 case DM_MAPIO_REMAPPED:
9d20653f 1452 dm_submit_bio_remap(clone, NULL);
846785e6
CH
1453 break;
1454 case DM_MAPIO_KILL:
846785e6 1455 case DM_MAPIO_REQUEUE:
442761fd
MS
1456 if (static_branch_unlikely(&swap_bios_enabled) &&
1457 unlikely(swap_bios_limit(ti, clone)))
6cbce280 1458 up(&md->swap_bios_semaphore);
1d1068ce 1459 free_tio(clone);
90a2326e
MS
1460 if (r == DM_MAPIO_KILL)
1461 dm_io_dec_pending(io, BLK_STS_IOERR);
1462 else
1463 dm_io_dec_pending(io, BLK_STS_DM_REQUEUE);
846785e6
CH
1464 break;
1465 default:
43e6c111 1466 DMCRIT("unimplemented target map return value: %d", r);
45cbcd79 1467 BUG();
1da177e4
LT
1468 }
1469}
1da177e4 1470
86a3238c 1471static void setup_split_accounting(struct clone_info *ci, unsigned int len)
7dd76d1f
ML
1472{
1473 struct dm_io *io = ci->io;
1474
1475 if (ci->sector_count > len) {
1476 /*
1477 * Split needed, save the mapped part for accounting.
1478 * NOTE: dm_accept_partial_bio() will update accordingly.
1479 */
1480 dm_io_set_flag(io, DM_IO_WAS_SPLIT);
1481 io->sectors = len;
8b211aac 1482 io->sector_offset = bio_sectors(ci->bio);
7dd76d1f
ML
1483 }
1484}
1485
318716dd 1486static void alloc_multiple_bios(struct bio_list *blist, struct clone_info *ci,
f7b58a69 1487 struct dm_target *ti, unsigned int num_bios,
4a2fe296 1488 unsigned *len, gfp_t gfp_flag)
f9ab94ce 1489{
1d1068ce 1490 struct bio *bio;
4a2fe296 1491 int try = (gfp_flag & GFP_NOWAIT) ? 0 : 1;
dba14160 1492
4a2fe296 1493 for (; try < 2; try++) {
318716dd 1494 int bio_nr;
318716dd 1495
4a2fe296 1496 if (try && num_bios > 1)
bc02cdbe 1497 mutex_lock(&ci->io->md->table_devices_lock);
318716dd 1498 for (bio_nr = 0; bio_nr < num_bios; bio_nr++) {
f7b58a69 1499 bio = alloc_tio(ci, ti, bio_nr, len,
dc8e2021 1500 try ? GFP_NOIO : GFP_NOWAIT);
1d1068ce 1501 if (!bio)
318716dd
MS
1502 break;
1503
1d1068ce 1504 bio_list_add(blist, bio);
318716dd 1505 }
4a2fe296 1506 if (try && num_bios > 1)
bc02cdbe 1507 mutex_unlock(&ci->io->md->table_devices_lock);
318716dd
MS
1508 if (bio_nr == num_bios)
1509 return;
1510
6c23f0bd 1511 while ((bio = bio_list_pop(blist)))
1d1068ce 1512 free_tio(bio);
318716dd 1513 }
9015df24
AK
1514}
1515
34dbaa88 1516static unsigned int __send_duplicate_bios(struct clone_info *ci, struct dm_target *ti,
4a2fe296
MS
1517 unsigned int num_bios, unsigned int *len,
1518 gfp_t gfp_flag)
06a426ce 1519{
318716dd 1520 struct bio_list blist = BIO_EMPTY_LIST;
8eabf5d0 1521 struct bio *clone;
564b5c54 1522 unsigned int ret = 0;
06a426ce 1523
4a2fe296
MS
1524 if (WARN_ON_ONCE(num_bios == 0)) /* num_bios = 0 is a bug in caller */
1525 return 0;
1526
1527 /* dm_accept_partial_bio() is not supported with shared tio->len_ptr */
1528 if (len)
1529 setup_split_accounting(ci, *len);
1530
1531 /*
1532 * Using alloc_multiple_bios(), even if num_bios is 1, to consistently
1533 * support allocating using GFP_NOWAIT with GFP_NOIO fallback.
1534 */
1535 alloc_multiple_bios(&blist, ci, ti, num_bios, len, gfp_flag);
1536 while ((clone = bio_list_pop(&blist))) {
1537 if (num_bios > 1)
655f3aad 1538 dm_tio_set_flag(clone_to_tio(clone), DM_TIO_IS_DUPLICATE_BIO);
4a2fe296
MS
1539 __map_bio(clone);
1540 ret += 1;
318716dd 1541 }
0f14d60a
ML
1542
1543 return ret;
06a426ce
MS
1544}
1545
332f2b1e 1546static void __send_empty_flush(struct clone_info *ci)
f9ab94ce 1547{
564b5c54 1548 struct dm_table *t = ci->map;
828678b8
MS
1549 struct bio flush_bio;
1550
1551 /*
1552 * Use an on-stack bio for this, it's safe since we don't
1553 * need to reference it after submit. It's just used as
1554 * the basis for the clone(s).
1555 */
49add496
CH
1556 bio_init(&flush_bio, ci->io->md->disk->part0, NULL, 0,
1557 REQ_OP_WRITE | REQ_PREFLUSH | REQ_SYNC);
47d95102 1558
828678b8
MS
1559 ci->bio = &flush_bio;
1560 ci->sector_count = 0;
92b914e2 1561 ci->io->tio.clone.bi_iter.bi_size = 0;
f9ab94ce 1562
564b5c54
MS
1563 for (unsigned int i = 0; i < t->num_targets; i++) {
1564 unsigned int bios;
1565 struct dm_target *ti = dm_table_get_target(t, i);
0f14d60a 1566
4a2fe296
MS
1567 if (unlikely(ti->num_flush_bios == 0))
1568 continue;
1569
0f14d60a 1570 atomic_add(ti->num_flush_bios, &ci->io->io_count);
4a2fe296
MS
1571 bios = __send_duplicate_bios(ci, ti, ti->num_flush_bios,
1572 NULL, GFP_NOWAIT);
0f14d60a
ML
1573 atomic_sub(ti->num_flush_bios - bios, &ci->io->io_count);
1574 }
1575
1576 /*
1577 * alloc_io() takes one extra reference for submission, so the
1578 * reference won't reach 0 without the following subtraction
1579 */
1580 atomic_sub(1, &ci->io->io_count);
828678b8
MS
1581
1582 bio_uninit(ci->bio);
f9ab94ce
MP
1583}
1584
4a2fe296
MS
1585static void __send_abnormal_io(struct clone_info *ci, struct dm_target *ti,
1586 unsigned int num_bios, unsigned int max_granularity,
1587 unsigned int max_sectors)
ba1cbad9 1588{
86a3238c 1589 unsigned int len, bios;
ba1cbad9 1590
3720281d 1591 len = min_t(sector_t, ci->sector_count,
be04c14a 1592 __max_io_len(ti, ci->sector, max_granularity, max_sectors));
51b86f9a 1593
0f14d60a 1594 atomic_add(num_bios, &ci->io->io_count);
4a2fe296 1595 bios = __send_duplicate_bios(ci, ti, num_bios, &len, GFP_NOIO);
0f14d60a
ML
1596 /*
1597 * alloc_io() takes one extra reference for submission, so the
1598 * reference won't reach 0 without the following (+1) subtraction
1599 */
1600 atomic_sub(num_bios - bios + 1, &ci->io->io_count);
7dd06a25 1601
3d7f4562
MS
1602 ci->sector += len;
1603 ci->sector_count -= len;
ba1cbad9
MS
1604}
1605
568c73a3
MS
1606static bool is_abnormal_io(struct bio *bio)
1607{
a3282b43 1608 enum req_op op = bio_op(bio);
568c73a3 1609
4edadf6d
MS
1610 if (op != REQ_OP_READ && op != REQ_OP_WRITE && op != REQ_OP_FLUSH) {
1611 switch (op) {
1612 case REQ_OP_DISCARD:
1613 case REQ_OP_SECURE_ERASE:
1614 case REQ_OP_WRITE_ZEROES:
1615 return true;
1616 default:
1617 break;
1618 }
568c73a3
MS
1619 }
1620
4edadf6d 1621 return false;
568c73a3
MS
1622}
1623
4edadf6d
MS
1624static blk_status_t __process_abnormal_io(struct clone_info *ci,
1625 struct dm_target *ti)
0519c71e 1626{
86a3238c 1627 unsigned int num_bios = 0;
06961c48 1628 unsigned int max_granularity = 0;
be04c14a 1629 unsigned int max_sectors = 0;
13f6facf 1630 struct queue_limits *limits = dm_get_queue_limits(ti->table->md);
0519c71e 1631
e6fc9f62 1632 switch (bio_op(ci->bio)) {
9679b5a7
MS
1633 case REQ_OP_DISCARD:
1634 num_bios = ti->num_discard_bios;
be04c14a 1635 max_sectors = limits->max_discard_sectors;
13f6facf 1636 if (ti->max_discard_granularity)
be04c14a 1637 max_granularity = max_sectors;
9679b5a7
MS
1638 break;
1639 case REQ_OP_SECURE_ERASE:
1640 num_bios = ti->num_secure_erase_bios;
be04c14a 1641 max_sectors = limits->max_secure_erase_sectors;
13f6facf 1642 if (ti->max_secure_erase_granularity)
be04c14a 1643 max_granularity = max_sectors;
9679b5a7 1644 break;
9679b5a7
MS
1645 case REQ_OP_WRITE_ZEROES:
1646 num_bios = ti->num_write_zeroes_bios;
be04c14a 1647 max_sectors = limits->max_write_zeroes_sectors;
13f6facf 1648 if (ti->max_write_zeroes_granularity)
be04c14a 1649 max_granularity = max_sectors;
9679b5a7 1650 break;
2d9b02be
BVA
1651 default:
1652 break;
9679b5a7 1653 }
0519c71e 1654
e6fc9f62
MS
1655 /*
1656 * Even though the device advertised support for this type of
1657 * request, that does not mean every target supports it, and
1658 * reconfiguration might also have changed that since the
1659 * check was performed.
1660 */
84b98f4c 1661 if (unlikely(!num_bios))
4edadf6d
MS
1662 return BLK_STS_NOTSUPP;
1663
4a2fe296
MS
1664 __send_abnormal_io(ci, ti, num_bios, max_granularity, max_sectors);
1665
4edadf6d 1666 return BLK_STS_OK;
0519c71e
MS
1667}
1668
b99fdcdc 1669/*
ec211631 1670 * Reuse ->bi_private as dm_io list head for storing all dm_io instances
b99fdcdc
ML
1671 * associated with this bio, and this bio's bi_private needs to be
1672 * stored in dm_io->data before the reuse.
1673 *
1674 * bio->bi_private is owned by fs or upper layer, so block layer won't
1675 * touch it after splitting. Meantime it won't be changed by anyone after
1676 * bio is submitted. So this reuse is safe.
1677 */
ec211631 1678static inline struct dm_io **dm_poll_list_head(struct bio *bio)
b99fdcdc 1679{
ec211631 1680 return (struct dm_io **)&bio->bi_private;
b99fdcdc
ML
1681}
1682
1683static void dm_queue_poll_io(struct bio *bio, struct dm_io *io)
1684{
ec211631 1685 struct dm_io **head = dm_poll_list_head(bio);
b99fdcdc
ML
1686
1687 if (!(bio->bi_opf & REQ_DM_POLL_LIST)) {
1688 bio->bi_opf |= REQ_DM_POLL_LIST;
1689 /*
1690 * Save .bi_private into dm_io, so that we can reuse
ec211631 1691 * .bi_private as dm_io list head for storing dm_io list
b99fdcdc
ML
1692 */
1693 io->data = bio->bi_private;
1694
b99fdcdc
ML
1695 /* tell block layer to poll for completion */
1696 bio->bi_cookie = ~BLK_QC_T_NONE;
ec211631
ML
1697
1698 io->next = NULL;
b99fdcdc
ML
1699 } else {
1700 /*
1701 * bio recursed due to split, reuse original poll list,
1702 * and save bio->bi_private too.
1703 */
ec211631
ML
1704 io->data = (*head)->data;
1705 io->next = *head;
b99fdcdc
ML
1706 }
1707
ec211631 1708 *head = io;
b99fdcdc
ML
1709}
1710
e4c93811
AK
1711/*
1712 * Select the correct strategy for processing a non-flush bio.
1713 */
84b98f4c 1714static blk_status_t __split_and_process_bio(struct clone_info *ci)
0ce65797 1715{
66bdaa43 1716 struct bio *clone;
512875bd 1717 struct dm_target *ti;
86a3238c 1718 unsigned int len;
0ce65797 1719
512875bd 1720 ti = dm_table_find_target(ci->map, ci->sector);
4edadf6d
MS
1721 if (unlikely(!ti))
1722 return BLK_STS_IOERR;
1ee88de3 1723
1ee88de3 1724 if (unlikely(ci->is_abnormal_io))
4edadf6d 1725 return __process_abnormal_io(ci, ti);
3d7f4562 1726
b99fdcdc
ML
1727 /*
1728 * Only support bio polling for normal IO, and the target io is
1729 * exactly inside the dm_io instance (verified in dm_poll_dm_io)
1730 */
a3282b43 1731 ci->submit_as_polled = !!(ci->bio->bi_opf & REQ_POLLED);
0ce65797 1732
3720281d 1733 len = min_t(sector_t, max_io_len(ti, ci->sector), ci->sector_count);
7dd76d1f 1734 setup_split_accounting(ci, len);
6f25dd1c
MS
1735
1736 if (unlikely(ci->bio->bi_opf & REQ_NOWAIT)) {
1737 if (unlikely(!dm_target_supports_nowait(ti->type)))
1738 return BLK_STS_NOTSUPP;
1739
1740 clone = alloc_tio(ci, ti, 0, &len, GFP_NOWAIT);
1741 if (unlikely(!clone))
1742 return BLK_STS_AGAIN;
1743 } else {
1744 clone = alloc_tio(ci, ti, 0, &len, GFP_NOIO);
1745 }
66bdaa43 1746 __map_bio(clone);
0ce65797 1747
1c3b13e6
KO
1748 ci->sector += len;
1749 ci->sector_count -= len;
0ce65797 1750
84b98f4c 1751 return BLK_STS_OK;
0ce65797
MS
1752}
1753
6f25dd1c 1754static void init_clone_info(struct clone_info *ci, struct dm_io *io,
4edadf6d 1755 struct dm_table *map, struct bio *bio, bool is_abnormal)
978e51ba
MS
1756{
1757 ci->map = map;
6f25dd1c 1758 ci->io = io;
d41e077a 1759 ci->bio = bio;
4edadf6d 1760 ci->is_abnormal_io = is_abnormal;
b99fdcdc 1761 ci->submit_as_polled = false;
978e51ba 1762 ci->sector = bio->bi_iter.bi_sector;
d41e077a
MS
1763 ci->sector_count = bio_sectors(bio);
1764
1765 /* Shouldn't happen but sector_count was being set to 0 so... */
442761fd
MS
1766 if (static_branch_unlikely(&zoned_enabled) &&
1767 WARN_ON_ONCE(op_is_zone_mgmt(bio_op(bio)) && ci->sector_count))
d41e077a 1768 ci->sector_count = 0;
978e51ba
MS
1769}
1770
1da177e4 1771/*
14fe594d 1772 * Entry point to split a bio into clones and submit them to the targets.
1da177e4 1773 */
96c9865c
MS
1774static void dm_split_and_process_bio(struct mapped_device *md,
1775 struct dm_table *map, struct bio *bio)
0ce65797 1776{
1da177e4 1777 struct clone_info ci;
4857abf6 1778 struct dm_io *io;
84b98f4c 1779 blk_status_t error = BLK_STS_OK;
4edadf6d
MS
1780 bool is_abnormal;
1781
1782 is_abnormal = is_abnormal_io(bio);
1783 if (unlikely(is_abnormal)) {
1784 /*
5a97806f 1785 * Use bio_split_to_limits() for abnormal IO (e.g. discard, etc)
4edadf6d
MS
1786 * otherwise associated queue_limits won't be imposed.
1787 */
5a97806f 1788 bio = bio_split_to_limits(bio);
613b1488
JA
1789 if (!bio)
1790 return;
4edadf6d 1791 }
1da177e4 1792
6f25dd1c
MS
1793 /* Only support nowait for normal IO */
1794 if (unlikely(bio->bi_opf & REQ_NOWAIT) && !is_abnormal) {
1795 io = alloc_io(md, bio, GFP_NOWAIT);
1796 if (unlikely(!io)) {
1797 /* Unable to do anything without dm_io. */
1798 bio_wouldblock_error(bio);
1799 return;
1800 }
1801 } else {
1802 io = alloc_io(md, bio, GFP_NOIO);
1803 }
1804 init_clone_info(&ci, io, map, bio, is_abnormal);
0ce65797 1805
1eff9d32 1806 if (bio->bi_opf & REQ_PREFLUSH) {
332f2b1e 1807 __send_empty_flush(&ci);
e2736347 1808 /* dm_io_complete submits any data associated with flush */
d41e077a 1809 goto out;
d87f4c14 1810 }
0ce65797 1811
d41e077a
MS
1812 error = __split_and_process_bio(&ci);
1813 if (error || !ci.sector_count)
1814 goto out;
d41e077a
MS
1815 /*
1816 * Remainder must be passed to submit_bio_noacct() so it gets handled
1817 * *after* bios already submitted have been completely processed.
d41e077a 1818 */
8b211aac
ML
1819 bio_trim(bio, io->sectors, ci.sector_count);
1820 trace_block_split(bio, bio->bi_iter.bi_sector);
1821 bio_inc_remaining(bio);
d41e077a
MS
1822 submit_bio_noacct(bio);
1823out:
b99fdcdc
ML
1824 /*
1825 * Drop the extra reference count for non-POLLED bio, and hold one
1826 * reference for POLLED bio, which will be released in dm_poll_bio
1827 *
ec211631
ML
1828 * Add every dm_io instance into the dm_io list head which is stored
1829 * in bio->bi_private, so that dm_poll_bio can poll them all.
b99fdcdc 1830 */
0f14d60a
ML
1831 if (error || !ci.submit_as_polled) {
1832 /*
1833 * In case of submission failure, the extra reference for
1834 * submitting io isn't consumed yet
1835 */
1836 if (error)
1837 atomic_dec(&io->io_count);
1838 dm_io_dec_pending(io, error);
1839 } else
4857abf6 1840 dm_queue_poll_io(bio, io);
0ce65797
MS
1841}
1842
3e08773c 1843static void dm_submit_bio(struct bio *bio)
cec47e3d 1844{
309dca30 1845 struct mapped_device *md = bio->bi_bdev->bd_disk->private_data;
83d5e5b0
MP
1846 int srcu_idx;
1847 struct dm_table *map;
cec47e3d 1848
a9ce3853 1849 map = dm_get_live_table(md, &srcu_idx);
29e4013d 1850
fa247089
MS
1851 /* If suspended, or map not yet available, queue this IO for later */
1852 if (unlikely(test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) ||
1853 unlikely(!map)) {
6abc4946
KK
1854 if (bio->bi_opf & REQ_NOWAIT)
1855 bio_wouldblock_error(bio);
b2abdb1b 1856 else if (bio->bi_opf & REQ_RAHEAD)
54d9a1b4 1857 bio_io_error(bio);
b2abdb1b
MS
1858 else
1859 queue_io(md, bio);
1860 goto out;
cec47e3d 1861 }
1da177e4 1862
96c9865c 1863 dm_split_and_process_bio(md, map, bio);
b2abdb1b 1864out:
a9ce3853 1865 dm_put_live_table(md, srcu_idx);
978e51ba
MS
1866}
1867
b99fdcdc
ML
1868static bool dm_poll_dm_io(struct dm_io *io, struct io_comp_batch *iob,
1869 unsigned int flags)
1870{
655f3aad 1871 WARN_ON_ONCE(!dm_tio_is_normal(&io->tio));
b99fdcdc
ML
1872
1873 /* don't poll if the mapped io is done */
1874 if (atomic_read(&io->io_count) > 1)
1875 bio_poll(&io->tio.clone, iob, flags);
1876
1877 /* bio_poll holds the last reference */
1878 return atomic_read(&io->io_count) == 1;
1879}
1880
1881static int dm_poll_bio(struct bio *bio, struct io_comp_batch *iob,
1882 unsigned int flags)
1883{
ec211631
ML
1884 struct dm_io **head = dm_poll_list_head(bio);
1885 struct dm_io *list = *head;
1886 struct dm_io *tmp = NULL;
1887 struct dm_io *curr, *next;
b99fdcdc
ML
1888
1889 /* Only poll normal bio which was marked as REQ_DM_POLL_LIST */
1890 if (!(bio->bi_opf & REQ_DM_POLL_LIST))
1891 return 0;
1892
ec211631 1893 WARN_ON_ONCE(!list);
b99fdcdc
ML
1894
1895 /*
1896 * Restore .bi_private before possibly completing dm_io.
1897 *
1898 * bio_poll() is only possible once @bio has been completely
1899 * submitted via submit_bio_noacct()'s depth-first submission.
1900 * So there is no dm_queue_poll_io() race associated with
1901 * clearing REQ_DM_POLL_LIST here.
1902 */
1903 bio->bi_opf &= ~REQ_DM_POLL_LIST;
ec211631 1904 bio->bi_private = list->data;
b99fdcdc 1905
ec211631
ML
1906 for (curr = list, next = curr->next; curr; curr = next, next =
1907 curr ? curr->next : NULL) {
1908 if (dm_poll_dm_io(curr, iob, flags)) {
b99fdcdc 1909 /*
84b98f4c
MS
1910 * clone_endio() has already occurred, so no
1911 * error handling is needed here.
b99fdcdc 1912 */
ec211631
ML
1913 __dm_io_dec_pending(curr);
1914 } else {
1915 curr->next = tmp;
1916 tmp = curr;
b99fdcdc
ML
1917 }
1918 }
1919
1920 /* Not done? */
ec211631 1921 if (tmp) {
b99fdcdc
ML
1922 bio->bi_opf |= REQ_DM_POLL_LIST;
1923 /* Reset bio->bi_private to dm_io list head */
ec211631 1924 *head = tmp;
b99fdcdc
ML
1925 return 0;
1926 }
1927 return 1;
1928}
1929
a4a82ce3
HM
1930/*
1931 *---------------------------------------------------------------
1da177e4 1932 * An IDR is used to keep track of allocated minor numbers.
a4a82ce3
HM
1933 *---------------------------------------------------------------
1934 */
2b06cfff 1935static void free_minor(int minor)
1da177e4 1936{
f32c10b0 1937 spin_lock(&_minor_lock);
1da177e4 1938 idr_remove(&_minor_idr, minor);
f32c10b0 1939 spin_unlock(&_minor_lock);
1da177e4
LT
1940}
1941
1942/*
1943 * See if the device with a specific minor # is free.
1944 */
cf13ab8e 1945static int specific_minor(int minor)
1da177e4 1946{
c9d76be6 1947 int r;
1da177e4
LT
1948
1949 if (minor >= (1 << MINORBITS))
1950 return -EINVAL;
1951
c9d76be6 1952 idr_preload(GFP_KERNEL);
f32c10b0 1953 spin_lock(&_minor_lock);
1da177e4 1954
c9d76be6 1955 r = idr_alloc(&_minor_idr, MINOR_ALLOCED, minor, minor + 1, GFP_NOWAIT);
1da177e4 1956
f32c10b0 1957 spin_unlock(&_minor_lock);
c9d76be6
TH
1958 idr_preload_end();
1959 if (r < 0)
1960 return r == -ENOSPC ? -EBUSY : r;
1961 return 0;
1da177e4
LT
1962}
1963
cf13ab8e 1964static int next_free_minor(int *minor)
1da177e4 1965{
c9d76be6 1966 int r;
62f75c2f 1967
c9d76be6 1968 idr_preload(GFP_KERNEL);
f32c10b0 1969 spin_lock(&_minor_lock);
1da177e4 1970
c9d76be6 1971 r = idr_alloc(&_minor_idr, MINOR_ALLOCED, 0, 1 << MINORBITS, GFP_NOWAIT);
1da177e4 1972
f32c10b0 1973 spin_unlock(&_minor_lock);
c9d76be6
TH
1974 idr_preload_end();
1975 if (r < 0)
1976 return r;
1977 *minor = r;
1978 return 0;
1da177e4
LT
1979}
1980
83d5cde4 1981static const struct block_device_operations dm_blk_dops;
681cc5e8 1982static const struct block_device_operations dm_rq_blk_dops;
f26c5719 1983static const struct dax_operations dm_dax_ops;
1da177e4 1984
53d5914f
MP
1985static void dm_wq_work(struct work_struct *work);
1986
aa6ce87a 1987#ifdef CONFIG_BLK_INLINE_ENCRYPTION
cb77cb5a 1988static void dm_queue_destroy_crypto_profile(struct request_queue *q)
aa6ce87a 1989{
cb77cb5a 1990 dm_destroy_crypto_profile(q->crypto_profile);
aa6ce87a
ST
1991}
1992
1993#else /* CONFIG_BLK_INLINE_ENCRYPTION */
1994
cb77cb5a 1995static inline void dm_queue_destroy_crypto_profile(struct request_queue *q)
aa6ce87a
ST
1996{
1997}
1998#endif /* !CONFIG_BLK_INLINE_ENCRYPTION */
1999
0f20972f
MS
2000static void cleanup_mapped_device(struct mapped_device *md)
2001{
0f20972f
MS
2002 if (md->wq)
2003 destroy_workqueue(md->wq);
29dec90a 2004 dm_free_md_mempools(md->mempools);
0f20972f 2005
f26c5719 2006 if (md->dax_dev) {
fb08a190 2007 dax_remove_host(md->disk);
f26c5719
DW
2008 kill_dax(md->dax_dev);
2009 put_dax(md->dax_dev);
2010 md->dax_dev = NULL;
2011 }
2012
588b7f5d 2013 dm_cleanup_zoned_dev(md);
0f20972f
MS
2014 if (md->disk) {
2015 spin_lock(&_minor_lock);
2016 md->disk->private_data = NULL;
2017 spin_unlock(&_minor_lock);
89f871af 2018 if (dm_get_md_type(md) != DM_TYPE_NONE) {
1a581b72
CH
2019 struct table_device *td;
2020
89f871af 2021 dm_sysfs_exit(md);
1a581b72
CH
2022 list_for_each_entry(td, &md->table_devices, list) {
2023 bd_unlink_disk_holder(td->dm_dev.bdev,
2024 md->disk);
2025 }
d563792c
YK
2026
2027 /*
2028 * Hold lock to make sure del_gendisk() won't concurrent
2029 * with open/close_table_device().
2030 */
2031 mutex_lock(&md->table_devices_lock);
89f871af 2032 del_gendisk(md->disk);
d563792c 2033 mutex_unlock(&md->table_devices_lock);
89f871af 2034 }
cb77cb5a 2035 dm_queue_destroy_crypto_profile(md->queue);
8b9ab626 2036 put_disk(md->disk);
74a2b6ec 2037 }
0f20972f 2038
9f6dc633
MS
2039 if (md->pending_io) {
2040 free_percpu(md->pending_io);
2041 md->pending_io = NULL;
2042 }
2043
d09960b0
TE
2044 cleanup_srcu_struct(&md->io_barrier);
2045
d5ffebdd
MS
2046 mutex_destroy(&md->suspend_lock);
2047 mutex_destroy(&md->type_lock);
2048 mutex_destroy(&md->table_devices_lock);
a666e5c0 2049 mutex_destroy(&md->swap_bios_lock);
d5ffebdd 2050
4cc96131 2051 dm_mq_cleanup_mapped_device(md);
0f20972f
MS
2052}
2053
1da177e4
LT
2054/*
2055 * Allocate and initialise a blank device with a given minor.
2056 */
2b06cfff 2057static struct mapped_device *alloc_dev(int minor)
1da177e4 2058{
115485e8 2059 int r, numa_node_id = dm_get_numa_node();
c2929072 2060 struct dax_device *dax_dev;
115485e8 2061 struct mapped_device *md;
ba61fdd1 2062 void *old_md;
1da177e4 2063
856eb091 2064 md = kvzalloc_node(sizeof(*md), GFP_KERNEL, numa_node_id);
1da177e4 2065 if (!md) {
43e6c111 2066 DMERR("unable to allocate device, out of memory.");
1da177e4
LT
2067 return NULL;
2068 }
2069
10da4f79 2070 if (!try_module_get(THIS_MODULE))
6ed7ade8 2071 goto bad_module_get;
10da4f79 2072
1da177e4 2073 /* get a minor number for the dev */
2b06cfff 2074 if (minor == DM_ANY_MINOR)
cf13ab8e 2075 r = next_free_minor(&minor);
2b06cfff 2076 else
cf13ab8e 2077 r = specific_minor(minor);
1da177e4 2078 if (r < 0)
6ed7ade8 2079 goto bad_minor;
1da177e4 2080
83d5e5b0
MP
2081 r = init_srcu_struct(&md->io_barrier);
2082 if (r < 0)
2083 goto bad_io_barrier;
2084
115485e8 2085 md->numa_node_id = numa_node_id;
591ddcfc 2086 md->init_tio_pdu = false;
a5664dad 2087 md->type = DM_TYPE_NONE;
e61290a4 2088 mutex_init(&md->suspend_lock);
a5664dad 2089 mutex_init(&md->type_lock);
86f1152b 2090 mutex_init(&md->table_devices_lock);
022c2611 2091 spin_lock_init(&md->deferred_lock);
1da177e4 2092 atomic_set(&md->holders, 1);
5c6bd75d 2093 atomic_set(&md->open_count, 0);
1da177e4 2094 atomic_set(&md->event_nr, 0);
7a8c3d3b
MA
2095 atomic_set(&md->uevent_seq, 0);
2096 INIT_LIST_HEAD(&md->uevent_list);
86f1152b 2097 INIT_LIST_HEAD(&md->table_devices);
7a8c3d3b 2098 spin_lock_init(&md->uevent_lock);
1da177e4 2099
47ace7e0 2100 /*
c62b37d9
CH
2101 * default to bio-based until DM table is loaded and md->type
2102 * established. If request-based table is loaded: blk-mq will
2103 * override accordingly.
47ace7e0 2104 */
74fa8f9c
CH
2105 md->disk = blk_alloc_disk(NULL, md->numa_node_id);
2106 if (IS_ERR(md->disk))
0f20972f 2107 goto bad;
74fe6ba9 2108 md->queue = md->disk->queue;
1da177e4 2109
f0b04115 2110 init_waitqueue_head(&md->wait);
53d5914f 2111 INIT_WORK(&md->work, dm_wq_work);
8b211aac 2112 INIT_WORK(&md->requeue_work, dm_wq_requeue_work);
f0b04115 2113 init_waitqueue_head(&md->eventq);
2995fa78 2114 init_completion(&md->kobj_holder.completion);
f0b04115 2115
8b211aac 2116 md->requeue_list = NULL;
a666e5c0
MP
2117 md->swap_bios = get_swap_bios();
2118 sema_init(&md->swap_bios_semaphore, md->swap_bios);
2119 mutex_init(&md->swap_bios_lock);
2120
1da177e4
LT
2121 md->disk->major = _major;
2122 md->disk->first_minor = minor;
74fe6ba9 2123 md->disk->minors = 1;
1ebe2e5f 2124 md->disk->flags |= GENHD_FL_NO_PART;
1da177e4 2125 md->disk->fops = &dm_blk_dops;
1da177e4
LT
2126 md->disk->private_data = md;
2127 sprintf(md->disk->disk_name, "dm-%d", minor);
f26c5719 2128
c2929072
MD
2129 dax_dev = alloc_dax(md, &dm_dax_ops);
2130 if (IS_ERR(dax_dev)) {
2131 if (PTR_ERR(dax_dev) != -EOPNOTSUPP)
976431b0 2132 goto bad;
c2929072
MD
2133 } else {
2134 set_dax_nocache(dax_dev);
2135 set_dax_nomc(dax_dev);
2136 md->dax_dev = dax_dev;
2137 if (dax_add_host(dax_dev, md->disk))
976431b0
DW
2138 goto bad;
2139 }
f26c5719 2140
7e51f257 2141 format_dev_t(md->name, MKDEV(_major, minor));
1da177e4 2142
c7c879ee 2143 md->wq = alloc_workqueue("kdmflush/%s", WQ_MEM_RECLAIM, 0, md->name);
304f3f6a 2144 if (!md->wq)
0f20972f 2145 goto bad;
304f3f6a 2146
9f6dc633
MS
2147 md->pending_io = alloc_percpu(unsigned long);
2148 if (!md->pending_io)
2149 goto bad;
2150
d3aa3e06
JJ
2151 r = dm_stats_init(&md->stats);
2152 if (r < 0)
2153 goto bad;
fd2ed4d2 2154
ba61fdd1 2155 /* Populate the mapping, nobody knows we exist yet */
f32c10b0 2156 spin_lock(&_minor_lock);
ba61fdd1 2157 old_md = idr_replace(&_minor_idr, md, minor);
f32c10b0 2158 spin_unlock(&_minor_lock);
ba61fdd1
JM
2159
2160 BUG_ON(old_md != MINOR_ALLOCED);
2161
1da177e4
LT
2162 return md;
2163
0f20972f
MS
2164bad:
2165 cleanup_mapped_device(md);
83d5e5b0 2166bad_io_barrier:
1da177e4 2167 free_minor(minor);
6ed7ade8 2168bad_minor:
10da4f79 2169 module_put(THIS_MODULE);
6ed7ade8 2170bad_module_get:
856eb091 2171 kvfree(md);
1da177e4
LT
2172 return NULL;
2173}
2174
ae9da83f
JN
2175static void unlock_fs(struct mapped_device *md);
2176
1da177e4
LT
2177static void free_dev(struct mapped_device *md)
2178{
f331c029 2179 int minor = MINOR(disk_devt(md->disk));
63d94e48 2180
32a926da 2181 unlock_fs(md);
2eb6e1e3 2182
0f20972f 2183 cleanup_mapped_device(md);
63a4f065 2184
992ec6a9 2185 WARN_ON_ONCE(!list_empty(&md->table_devices));
63a4f065 2186 dm_stats_cleanup(&md->stats);
63a4f065
MS
2187 free_minor(minor);
2188
10da4f79 2189 module_put(THIS_MODULE);
856eb091 2190 kvfree(md);
1da177e4
LT
2191}
2192
2193/*
2194 * Bind a table to the device.
2195 */
2196static void event_callback(void *context)
2197{
7a8c3d3b
MA
2198 unsigned long flags;
2199 LIST_HEAD(uevents);
d695e441 2200 struct mapped_device *md = context;
1da177e4 2201
7a8c3d3b
MA
2202 spin_lock_irqsave(&md->uevent_lock, flags);
2203 list_splice_init(&md->uevent_list, &uevents);
2204 spin_unlock_irqrestore(&md->uevent_lock, flags);
2205
ed9e1982 2206 dm_send_uevents(&uevents, &disk_to_dev(md->disk)->kobj);
7a8c3d3b 2207
1da177e4
LT
2208 atomic_inc(&md->event_nr);
2209 wake_up(&md->eventq);
62e08243 2210 dm_issue_global_event();
1da177e4
LT
2211}
2212
042d2a9b
AK
2213/*
2214 * Returns old map, which caller must destroy.
2215 */
2216static struct dm_table *__bind(struct mapped_device *md, struct dm_table *t,
2217 struct queue_limits *limits)
1da177e4 2218{
042d2a9b 2219 struct dm_table *old_map;
1da177e4 2220 sector_t size;
2a2a4c51 2221 int ret;
1da177e4 2222
5a8f1f80
BVA
2223 lockdep_assert_held(&md->suspend_lock);
2224
1da177e4 2225 size = dm_table_get_size(t);
3ac51e74
DW
2226
2227 /*
2228 * Wipe any geometry if the size of the table changed.
2229 */
fd2ed4d2 2230 if (size != dm_get_size(md))
3ac51e74
DW
2231 memset(&md->geometry, 0, sizeof(md->geometry));
2232
7533afa1 2233 set_capacity(md->disk, size);
d5816876 2234
2ca3310e
AK
2235 dm_table_event_callback(t, event_callback, md);
2236
f5b4aee1 2237 if (dm_table_request_based(t)) {
16f12266 2238 /*
9c37de29
MS
2239 * Leverage the fact that request-based DM targets are
2240 * immutable singletons - used to optimize dm_mq_queue_rq.
16f12266
MS
2241 */
2242 md->immutable_target = dm_table_get_immutable_target(t);
e6ee8c0b 2243
29dec90a
CH
2244 /*
2245 * There is no need to reload with request-based dm because the
2246 * size of front_pad doesn't change.
2247 *
2248 * Note for future: If you are to reload bioset, prep-ed
2249 * requests in the queue may refer to bio from the old bioset,
2250 * so you must walk through the queue to unprep.
2251 */
2252 if (!md->mempools) {
2253 md->mempools = t->mempools;
2254 t->mempools = NULL;
2255 }
2256 } else {
2257 /*
2258 * The md may already have mempools that need changing.
2259 * If so, reload bioset because front_pad may have changed
2260 * because a different table was loaded.
2261 */
2262 dm_free_md_mempools(md->mempools);
2263 md->mempools = t->mempools;
2264 t->mempools = NULL;
2a2a4c51 2265 }
e6ee8c0b 2266
f5b4aee1 2267 ret = dm_table_set_restrictions(t, md->queue, limits);
bb37d772
DLM
2268 if (ret) {
2269 old_map = ERR_PTR(ret);
2270 goto out;
2271 }
2272
a12f5d48 2273 old_map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
1d3aa6f6 2274 rcu_assign_pointer(md->map, (void *)t);
36a0456f
AK
2275 md->immutable_target_type = dm_table_get_immutable_target_type(t);
2276
41abc4e1
HR
2277 if (old_map)
2278 dm_sync_table(md);
2a2a4c51 2279out:
042d2a9b 2280 return old_map;
1da177e4
LT
2281}
2282
a7940155
AK
2283/*
2284 * Returns unbound table for the caller to free.
2285 */
2286static struct dm_table *__unbind(struct mapped_device *md)
1da177e4 2287{
a12f5d48 2288 struct dm_table *map = rcu_dereference_protected(md->map, 1);
1da177e4
LT
2289
2290 if (!map)
a7940155 2291 return NULL;
1da177e4
LT
2292
2293 dm_table_event_callback(map, NULL, NULL);
9cdb8520 2294 RCU_INIT_POINTER(md->map, NULL);
83d5e5b0 2295 dm_sync_table(md);
a7940155
AK
2296
2297 return map;
1da177e4
LT
2298}
2299
2300/*
2301 * Constructor for a new device.
2302 */
2b06cfff 2303int dm_create(int minor, struct mapped_device **result)
1da177e4
LT
2304{
2305 struct mapped_device *md;
2306
2b06cfff 2307 md = alloc_dev(minor);
1da177e4
LT
2308 if (!md)
2309 return -ENXIO;
2310
91ccbbac
TS
2311 dm_ima_reset_data(md);
2312
1da177e4
LT
2313 *result = md;
2314 return 0;
2315}
2316
a5664dad
MS
2317/*
2318 * Functions to manage md->type.
2319 * All are required to hold md->type_lock.
2320 */
2321void dm_lock_md_type(struct mapped_device *md)
2322{
2323 mutex_lock(&md->type_lock);
2324}
2325
2326void dm_unlock_md_type(struct mapped_device *md)
2327{
2328 mutex_unlock(&md->type_lock);
2329}
2330
7e0d574f 2331void dm_set_md_type(struct mapped_device *md, enum dm_queue_mode type)
a5664dad 2332{
00c4fc3b 2333 BUG_ON(!mutex_is_locked(&md->type_lock));
a5664dad
MS
2334 md->type = type;
2335}
2336
7e0d574f 2337enum dm_queue_mode dm_get_md_type(struct mapped_device *md)
a5664dad
MS
2338{
2339 return md->type;
2340}
2341
36a0456f
AK
2342struct target_type *dm_get_immutable_target_type(struct mapped_device *md)
2343{
2344 return md->immutable_target_type;
2345}
2346
4a0b4ddf
MS
2347/*
2348 * Setup the DM device's queue based on md's type
2349 */
591ddcfc 2350int dm_setup_md_queue(struct mapped_device *md, struct dm_table *t)
4a0b4ddf 2351{
ba305859 2352 enum dm_queue_mode type = dm_table_get_type(t);
c100ec49 2353 struct queue_limits limits;
1a581b72 2354 struct table_device *td;
ba305859 2355 int r;
bfebd1cd 2356
545ed20e 2357 switch (type) {
bfebd1cd 2358 case DM_TYPE_REQUEST_BASED:
681cc5e8 2359 md->disk->fops = &dm_rq_blk_dops;
e83068a5 2360 r = dm_mq_init_request_queue(md, t);
bfebd1cd 2361 if (r) {
681cc5e8 2362 DMERR("Cannot initialize queue for request-based dm mapped device");
bfebd1cd
MS
2363 return r;
2364 }
2365 break;
2366 case DM_TYPE_BIO_BASED:
545ed20e 2367 case DM_TYPE_DAX_BIO_BASED:
526d1006 2368 blk_queue_flag_set(QUEUE_FLAG_IO_STAT, md->queue);
bfebd1cd 2369 break;
7e0d574f
BVA
2370 case DM_TYPE_NONE:
2371 WARN_ON_ONCE(true);
2372 break;
4a0b4ddf
MS
2373 }
2374
c100ec49
MS
2375 r = dm_calculate_queue_limits(t, &limits);
2376 if (r) {
2377 DMERR("Cannot calculate initial queue limits");
2378 return r;
2379 }
bb37d772
DLM
2380 r = dm_table_set_restrictions(t, md->queue, &limits);
2381 if (r)
2382 return r;
2383
d563792c
YK
2384 /*
2385 * Hold lock to make sure add_disk() and del_gendisk() won't concurrent
2386 * with open_table_device() and close_table_device().
2387 */
2388 mutex_lock(&md->table_devices_lock);
e7089f65 2389 r = add_disk(md->disk);
d563792c 2390 mutex_unlock(&md->table_devices_lock);
e7089f65
LC
2391 if (r)
2392 return r;
c100ec49 2393
1a581b72
CH
2394 /*
2395 * Register the holder relationship for devices added before the disk
2396 * was live.
2397 */
2398 list_for_each_entry(td, &md->table_devices, list) {
2399 r = bd_link_disk_holder(td->dm_dev.bdev, md->disk);
2400 if (r)
2401 goto out_undo_holders;
89f871af 2402 }
d563792c 2403
1a581b72
CH
2404 r = dm_sysfs_init(md);
2405 if (r)
2406 goto out_undo_holders;
2407
89f871af 2408 md->type = type;
4a0b4ddf 2409 return 0;
1a581b72
CH
2410
2411out_undo_holders:
2412 list_for_each_entry_continue_reverse(td, &md->table_devices, list)
2413 bd_unlink_disk_holder(td->dm_dev.bdev, md->disk);
2414 mutex_lock(&md->table_devices_lock);
2415 del_gendisk(md->disk);
2416 mutex_unlock(&md->table_devices_lock);
2417 return r;
4a0b4ddf
MS
2418}
2419
2bec1f4a 2420struct mapped_device *dm_get_md(dev_t dev)
1da177e4
LT
2421{
2422 struct mapped_device *md;
86a3238c 2423 unsigned int minor = MINOR(dev);
1da177e4
LT
2424
2425 if (MAJOR(dev) != _major || minor >= (1 << MINORBITS))
2426 return NULL;
2427
f32c10b0 2428 spin_lock(&_minor_lock);
1da177e4
LT
2429
2430 md = idr_find(&_minor_idr, minor);
49de5769
MS
2431 if (!md || md == MINOR_ALLOCED || (MINOR(disk_devt(dm_disk(md))) != minor) ||
2432 test_bit(DMF_FREEING, &md->flags) || dm_deleting_md(md)) {
2433 md = NULL;
2434 goto out;
fba9f90e 2435 }
49de5769 2436 dm_get(md);
fba9f90e 2437out:
f32c10b0 2438 spin_unlock(&_minor_lock);
1da177e4 2439
637842cf
DT
2440 return md;
2441}
3cf2e4ba 2442EXPORT_SYMBOL_GPL(dm_get_md);
d229a958 2443
9ade92a9 2444void *dm_get_mdptr(struct mapped_device *md)
637842cf 2445{
9ade92a9 2446 return md->interface_ptr;
1da177e4
LT
2447}
2448
2449void dm_set_mdptr(struct mapped_device *md, void *ptr)
2450{
2451 md->interface_ptr = ptr;
2452}
2453
2454void dm_get(struct mapped_device *md)
2455{
2456 atomic_inc(&md->holders);
3f77316d 2457 BUG_ON(test_bit(DMF_FREEING, &md->flags));
1da177e4
LT
2458}
2459
09ee96b2
MP
2460int dm_hold(struct mapped_device *md)
2461{
2462 spin_lock(&_minor_lock);
2463 if (test_bit(DMF_FREEING, &md->flags)) {
2464 spin_unlock(&_minor_lock);
2465 return -EBUSY;
2466 }
2467 dm_get(md);
2468 spin_unlock(&_minor_lock);
2469 return 0;
2470}
2471EXPORT_SYMBOL_GPL(dm_hold);
2472
72d94861
AK
2473const char *dm_device_name(struct mapped_device *md)
2474{
2475 return md->name;
2476}
2477EXPORT_SYMBOL_GPL(dm_device_name);
2478
3f77316d 2479static void __dm_destroy(struct mapped_device *md, bool wait)
1da177e4 2480{
1134e5ae 2481 struct dm_table *map;
83d5e5b0 2482 int srcu_idx;
1da177e4 2483
3f77316d 2484 might_sleep();
fba9f90e 2485
63a4f065 2486 spin_lock(&_minor_lock);
3f77316d
KU
2487 idr_replace(&_minor_idr, MINOR_ALLOCED, MINOR(disk_devt(dm_disk(md))));
2488 set_bit(DMF_FREEING, &md->flags);
2489 spin_unlock(&_minor_lock);
3b785fbc 2490
7a5428dc 2491 blk_mark_disk_dead(md->disk);
3f77316d 2492
ab7c7bb6
MP
2493 /*
2494 * Take suspend_lock so that presuspend and postsuspend methods
2495 * do not race with internal suspend.
2496 */
2497 mutex_lock(&md->suspend_lock);
2a708cff 2498 map = dm_get_live_table(md, &srcu_idx);
3f77316d
KU
2499 if (!dm_suspended_md(md)) {
2500 dm_table_presuspend_targets(map);
adc0daad 2501 set_bit(DMF_SUSPENDED, &md->flags);
5df96f2b 2502 set_bit(DMF_POST_SUSPENDING, &md->flags);
3f77316d 2503 dm_table_postsuspend_targets(map);
1da177e4 2504 }
238d991f 2505 /* dm_put_live_table must be before fsleep, otherwise deadlock is possible */
83d5e5b0 2506 dm_put_live_table(md, srcu_idx);
2a708cff 2507 mutex_unlock(&md->suspend_lock);
83d5e5b0 2508
3f77316d
KU
2509 /*
2510 * Rare, but there may be I/O requests still going to complete,
2511 * for example. Wait for all references to disappear.
2512 * No one should increment the reference count of the mapped_device,
2513 * after the mapped_device state becomes DMF_FREEING.
2514 */
2515 if (wait)
2516 while (atomic_read(&md->holders))
238d991f 2517 fsleep(1000);
3f77316d
KU
2518 else if (atomic_read(&md->holders))
2519 DMWARN("%s: Forcibly removing mapped_device still in use! (%d users)",
2520 dm_device_name(md), atomic_read(&md->holders));
2521
3f77316d
KU
2522 dm_table_destroy(__unbind(md));
2523 free_dev(md);
2524}
2525
2526void dm_destroy(struct mapped_device *md)
2527{
2528 __dm_destroy(md, true);
2529}
2530
2531void dm_destroy_immediate(struct mapped_device *md)
2532{
2533 __dm_destroy(md, false);
2534}
2535
2536void dm_put(struct mapped_device *md)
2537{
2538 atomic_dec(&md->holders);
1da177e4 2539}
79eb885c 2540EXPORT_SYMBOL_GPL(dm_put);
1da177e4 2541
9f6dc633 2542static bool dm_in_flight_bios(struct mapped_device *md)
85067747
ML
2543{
2544 int cpu;
9f6dc633 2545 unsigned long sum = 0;
85067747 2546
9f6dc633
MS
2547 for_each_possible_cpu(cpu)
2548 sum += *per_cpu_ptr(md->pending_io, cpu);
85067747
ML
2549
2550 return sum != 0;
2551}
2552
2f064a59 2553static int dm_wait_for_bios_completion(struct mapped_device *md, unsigned int task_state)
46125c1c
MB
2554{
2555 int r = 0;
9f4c3f87 2556 DEFINE_WAIT(wait);
46125c1c 2557
85067747 2558 while (true) {
9f4c3f87 2559 prepare_to_wait(&md->wait, &wait, task_state);
46125c1c 2560
9f6dc633 2561 if (!dm_in_flight_bios(md))
46125c1c
MB
2562 break;
2563
e3fabdfd 2564 if (signal_pending_state(task_state, current)) {
46125c1c
MB
2565 r = -EINTR;
2566 break;
2567 }
2568
2569 io_schedule();
2570 }
9f4c3f87 2571 finish_wait(&md->wait, &wait);
b44ebeb0 2572
9f6dc633
MS
2573 smp_rmb();
2574
46125c1c
MB
2575 return r;
2576}
2577
2f064a59 2578static int dm_wait_for_completion(struct mapped_device *md, unsigned int task_state)
85067747
ML
2579{
2580 int r = 0;
2581
2582 if (!queue_is_mq(md->queue))
2583 return dm_wait_for_bios_completion(md, task_state);
2584
2585 while (true) {
2586 if (!blk_mq_queue_inflight(md->queue))
2587 break;
2588
2589 if (signal_pending_state(task_state, current)) {
2590 r = -EINTR;
2591 break;
2592 }
2593
238d991f 2594 fsleep(5000);
85067747
ML
2595 }
2596
2597 return r;
2598}
2599
1da177e4
LT
2600/*
2601 * Process the deferred bios
2602 */
ef208587 2603static void dm_wq_work(struct work_struct *work)
1da177e4 2604{
0c2915b8
MS
2605 struct mapped_device *md = container_of(work, struct mapped_device, work);
2606 struct bio *bio;
ef208587 2607
3b00b203 2608 while (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
df12ee99 2609 spin_lock_irq(&md->deferred_lock);
0c2915b8 2610 bio = bio_list_pop(&md->deferred);
df12ee99
AK
2611 spin_unlock_irq(&md->deferred_lock);
2612
0c2915b8 2613 if (!bio)
df12ee99 2614 break;
022c2611 2615
0c2915b8 2616 submit_bio_noacct(bio);
0ca44fce 2617 cond_resched();
022c2611 2618 }
1da177e4
LT
2619}
2620
9a1fb464 2621static void dm_queue_flush(struct mapped_device *md)
304f3f6a 2622{
3b00b203 2623 clear_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
4e857c58 2624 smp_mb__after_atomic();
53d5914f 2625 queue_work(md->wq, &md->work);
304f3f6a
MB
2626}
2627
1da177e4 2628/*
042d2a9b 2629 * Swap in a new table, returning the old one for the caller to destroy.
1da177e4 2630 */
042d2a9b 2631struct dm_table *dm_swap_table(struct mapped_device *md, struct dm_table *table)
1da177e4 2632{
87eb5b21 2633 struct dm_table *live_map = NULL, *map = ERR_PTR(-EINVAL);
754c5fc7 2634 struct queue_limits limits;
042d2a9b 2635 int r;
1da177e4 2636
e61290a4 2637 mutex_lock(&md->suspend_lock);
1da177e4
LT
2638
2639 /* device must be suspended */
4f186f8b 2640 if (!dm_suspended_md(md))
93c534ae 2641 goto out;
1da177e4 2642
3ae70656
MS
2643 /*
2644 * If the new table has no data devices, retain the existing limits.
2645 * This helps multipath with queue_if_no_path if all paths disappear,
2646 * then new I/O is queued based on these limits, and then some paths
2647 * reappear.
2648 */
2649 if (dm_table_has_no_data_devices(table)) {
83d5e5b0 2650 live_map = dm_get_live_table_fast(md);
3ae70656
MS
2651 if (live_map)
2652 limits = md->queue->limits;
83d5e5b0 2653 dm_put_live_table_fast(md);
3ae70656
MS
2654 }
2655
87eb5b21
MC
2656 if (!live_map) {
2657 r = dm_calculate_queue_limits(table, &limits);
2658 if (r) {
2659 map = ERR_PTR(r);
2660 goto out;
2661 }
042d2a9b 2662 }
754c5fc7 2663
042d2a9b 2664 map = __bind(md, table, &limits);
62e08243 2665 dm_issue_global_event();
1da177e4 2666
93c534ae 2667out:
e61290a4 2668 mutex_unlock(&md->suspend_lock);
042d2a9b 2669 return map;
1da177e4
LT
2670}
2671
2672/*
2673 * Functions to lock and unlock any filesystem running on the
2674 * device.
2675 */
2ca3310e 2676static int lock_fs(struct mapped_device *md)
1da177e4 2677{
e39e2e95 2678 int r;
1da177e4 2679
040f04bd 2680 WARN_ON(test_bit(DMF_FROZEN, &md->flags));
aa8d7c2f 2681
982c3b30 2682 r = bdev_freeze(md->disk->part0);
040f04bd
CH
2683 if (!r)
2684 set_bit(DMF_FROZEN, &md->flags);
2685 return r;
1da177e4
LT
2686}
2687
2ca3310e 2688static void unlock_fs(struct mapped_device *md)
1da177e4 2689{
aa8d7c2f
AK
2690 if (!test_bit(DMF_FROZEN, &md->flags))
2691 return;
982c3b30 2692 bdev_thaw(md->disk->part0);
aa8d7c2f 2693 clear_bit(DMF_FROZEN, &md->flags);
1da177e4
LT
2694}
2695
2696/*
b48633f8
BVA
2697 * @suspend_flags: DM_SUSPEND_LOCKFS_FLAG and/or DM_SUSPEND_NOFLUSH_FLAG
2698 * @task_state: e.g. TASK_INTERRUPTIBLE or TASK_UNINTERRUPTIBLE
2699 * @dmf_suspended_flag: DMF_SUSPENDED or DMF_SUSPENDED_INTERNALLY
2700 *
ffcc3936
MS
2701 * If __dm_suspend returns 0, the device is completely quiescent
2702 * now. There is no request-processing activity. All new requests
2703 * are being added to md->deferred list.
cec47e3d 2704 */
ffcc3936 2705static int __dm_suspend(struct mapped_device *md, struct dm_table *map,
86a3238c 2706 unsigned int suspend_flags, unsigned int task_state,
eaf9a736 2707 int dmf_suspended_flag)
1da177e4 2708{
ffcc3936
MS
2709 bool do_lockfs = suspend_flags & DM_SUSPEND_LOCKFS_FLAG;
2710 bool noflush = suspend_flags & DM_SUSPEND_NOFLUSH_FLAG;
2711 int r;
1da177e4 2712
5a8f1f80
BVA
2713 lockdep_assert_held(&md->suspend_lock);
2714
2e93ccc1
KU
2715 /*
2716 * DMF_NOFLUSH_SUSPENDING must be set before presuspend.
2717 * This flag is cleared before dm_suspend returns.
2718 */
2719 if (noflush)
2720 set_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
86331f39 2721 else
ac75b09f 2722 DMDEBUG("%s: suspending with flush", dm_device_name(md));
2e93ccc1 2723
d67ee213
MS
2724 /*
2725 * This gets reverted if there's an error later and the targets
2726 * provide the .presuspend_undo hook.
2727 */
cf222b37
AK
2728 dm_table_presuspend_targets(map);
2729
32a926da 2730 /*
9f518b27
KU
2731 * Flush I/O to the device.
2732 * Any I/O submitted after lock_fs() may not be flushed.
2733 * noflush takes precedence over do_lockfs.
2734 * (lock_fs() flushes I/Os and waits for them to complete.)
32a926da
MP
2735 */
2736 if (!noflush && do_lockfs) {
2737 r = lock_fs(md);
d67ee213
MS
2738 if (r) {
2739 dm_table_presuspend_undo_targets(map);
ffcc3936 2740 return r;
d67ee213 2741 }
aa8d7c2f 2742 }
1da177e4
LT
2743
2744 /*
3b00b203
MP
2745 * Here we must make sure that no processes are submitting requests
2746 * to target drivers i.e. no one may be executing
96c9865c 2747 * dm_split_and_process_bio from dm_submit_bio.
3b00b203 2748 *
96c9865c 2749 * To get all processes out of dm_split_and_process_bio in dm_submit_bio,
3b00b203 2750 * we take the write lock. To prevent any process from reentering
96c9865c 2751 * dm_split_and_process_bio from dm_submit_bio and quiesce the thread
0cede372 2752 * (dm_wq_work), we set DMF_BLOCK_IO_FOR_SUSPEND and call
6a8736d1 2753 * flush_workqueue(md->wq).
1da177e4 2754 */
1eb787ec 2755 set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
41abc4e1
HR
2756 if (map)
2757 synchronize_srcu(&md->io_barrier);
1da177e4 2758
d0bcb878 2759 /*
29e4013d
TH
2760 * Stop md->queue before flushing md->wq in case request-based
2761 * dm defers requests to md->wq from md->queue.
d0bcb878 2762 */
6a23e05c 2763 if (dm_request_based(md))
eca7ee6d 2764 dm_stop_queue(md->queue);
cec47e3d 2765
d0bcb878
KU
2766 flush_workqueue(md->wq);
2767
1da177e4 2768 /*
3b00b203
MP
2769 * At this point no more requests are entering target request routines.
2770 * We call dm_wait_for_completion to wait for all existing requests
2771 * to finish.
1da177e4 2772 */
b48633f8 2773 r = dm_wait_for_completion(md, task_state);
eaf9a736
MS
2774 if (!r)
2775 set_bit(dmf_suspended_flag, &md->flags);
1da177e4 2776
6d6f10df 2777 if (noflush)
022c2611 2778 clear_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
41abc4e1
HR
2779 if (map)
2780 synchronize_srcu(&md->io_barrier);
2e93ccc1 2781
1da177e4 2782 /* were we interrupted ? */
46125c1c 2783 if (r < 0) {
9a1fb464 2784 dm_queue_flush(md);
73d410c0 2785
cec47e3d 2786 if (dm_request_based(md))
eca7ee6d 2787 dm_start_queue(md->queue);
cec47e3d 2788
2ca3310e 2789 unlock_fs(md);
d67ee213 2790 dm_table_presuspend_undo_targets(map);
ffcc3936 2791 /* pushback list is already flushed, so skip flush */
2ca3310e 2792 }
1da177e4 2793
ffcc3936
MS
2794 return r;
2795}
2796
2797/*
2798 * We need to be able to change a mapping table under a mounted
2799 * filesystem. For example we might want to move some data in
2800 * the background. Before the table can be swapped with
2801 * dm_bind_table, dm_suspend must be called to flush any in
2802 * flight bios and ensure that any further io gets deferred.
2803 */
2804/*
2805 * Suspend mechanism in request-based dm.
2806 *
2807 * 1. Flush all I/Os by lock_fs() if needed.
2808 * 2. Stop dispatching any I/O by stopping the request_queue.
2809 * 3. Wait for all in-flight I/Os to be completed or requeued.
2810 *
2811 * To abort suspend, start the request_queue.
2812 */
86a3238c 2813int dm_suspend(struct mapped_device *md, unsigned int suspend_flags)
ffcc3936
MS
2814{
2815 struct dm_table *map = NULL;
2816 int r = 0;
2817
2818retry:
2819 mutex_lock_nested(&md->suspend_lock, SINGLE_DEPTH_NESTING);
2820
2821 if (dm_suspended_md(md)) {
2822 r = -EINVAL;
2823 goto out_unlock;
2824 }
2825
2826 if (dm_suspended_internally_md(md)) {
2827 /* already internally suspended, wait for internal resume */
2828 mutex_unlock(&md->suspend_lock);
2829 r = wait_on_bit(&md->flags, DMF_SUSPENDED_INTERNALLY, TASK_INTERRUPTIBLE);
2830 if (r)
2831 return r;
2832 goto retry;
2833 }
2834
a12f5d48 2835 map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
2760904d
LL
2836 if (!map) {
2837 /* avoid deadlock with fs/namespace.c:do_mount() */
2838 suspend_flags &= ~DM_SUSPEND_LOCKFS_FLAG;
2839 }
ffcc3936 2840
eaf9a736 2841 r = __dm_suspend(md, map, suspend_flags, TASK_INTERRUPTIBLE, DMF_SUSPENDED);
ffcc3936
MS
2842 if (r)
2843 goto out_unlock;
3b00b203 2844
5df96f2b 2845 set_bit(DMF_POST_SUSPENDING, &md->flags);
4d4471cb 2846 dm_table_postsuspend_targets(map);
5df96f2b 2847 clear_bit(DMF_POST_SUSPENDING, &md->flags);
4d4471cb 2848
d287483d 2849out_unlock:
e61290a4 2850 mutex_unlock(&md->suspend_lock);
cf222b37 2851 return r;
1da177e4
LT
2852}
2853
ffcc3936
MS
2854static int __dm_resume(struct mapped_device *md, struct dm_table *map)
2855{
2856 if (map) {
2857 int r = dm_table_resume_targets(map);
b30f1607 2858
ffcc3936
MS
2859 if (r)
2860 return r;
2861 }
2862
2863 dm_queue_flush(md);
2864
2865 /*
2866 * Flushing deferred I/Os must be done after targets are resumed
2867 * so that mapping of targets can work correctly.
2868 * Request-based dm is queueing the deferred I/Os in its request_queue.
2869 */
2870 if (dm_request_based(md))
eca7ee6d 2871 dm_start_queue(md->queue);
ffcc3936
MS
2872
2873 unlock_fs(md);
2874
2875 return 0;
2876}
2877
1da177e4
LT
2878int dm_resume(struct mapped_device *md)
2879{
8dc23658 2880 int r;
cf222b37 2881 struct dm_table *map = NULL;
1da177e4 2882
ffcc3936 2883retry:
8dc23658 2884 r = -EINVAL;
ffcc3936
MS
2885 mutex_lock_nested(&md->suspend_lock, SINGLE_DEPTH_NESTING);
2886
4f186f8b 2887 if (!dm_suspended_md(md))
cf222b37 2888 goto out;
cf222b37 2889
ffcc3936
MS
2890 if (dm_suspended_internally_md(md)) {
2891 /* already internally suspended, wait for internal resume */
2892 mutex_unlock(&md->suspend_lock);
2893 r = wait_on_bit(&md->flags, DMF_SUSPENDED_INTERNALLY, TASK_INTERRUPTIBLE);
2894 if (r)
2895 return r;
2896 goto retry;
2897 }
2898
a12f5d48 2899 map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
2ca3310e 2900 if (!map || !dm_table_get_size(map))
cf222b37 2901 goto out;
1da177e4 2902
ffcc3936 2903 r = __dm_resume(md, map);
8757b776
MB
2904 if (r)
2905 goto out;
2ca3310e 2906
2ca3310e 2907 clear_bit(DMF_SUSPENDED, &md->flags);
cf222b37 2908out:
e61290a4 2909 mutex_unlock(&md->suspend_lock);
2ca3310e 2910
cf222b37 2911 return r;
1da177e4
LT
2912}
2913
fd2ed4d2
MP
2914/*
2915 * Internal suspend/resume works like userspace-driven suspend. It waits
2916 * until all bios finish and prevents issuing new bios to the target drivers.
2917 * It may be used only from the kernel.
fd2ed4d2
MP
2918 */
2919
86a3238c 2920static void __dm_internal_suspend(struct mapped_device *md, unsigned int suspend_flags)
fd2ed4d2 2921{
ffcc3936
MS
2922 struct dm_table *map = NULL;
2923
1ea0654e
BVA
2924 lockdep_assert_held(&md->suspend_lock);
2925
96b26c8c 2926 if (md->internal_suspend_count++)
ffcc3936
MS
2927 return; /* nested internal suspend */
2928
2929 if (dm_suspended_md(md)) {
2930 set_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
2931 return; /* nest suspend */
2932 }
2933
a12f5d48 2934 map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
ffcc3936
MS
2935
2936 /*
2937 * Using TASK_UNINTERRUPTIBLE because only NOFLUSH internal suspend is
2938 * supported. Properly supporting a TASK_INTERRUPTIBLE internal suspend
2939 * would require changing .presuspend to return an error -- avoid this
2940 * until there is a need for more elaborate variants of internal suspend.
2941 */
eaf9a736
MS
2942 (void) __dm_suspend(md, map, suspend_flags, TASK_UNINTERRUPTIBLE,
2943 DMF_SUSPENDED_INTERNALLY);
ffcc3936 2944
5df96f2b 2945 set_bit(DMF_POST_SUSPENDING, &md->flags);
ffcc3936 2946 dm_table_postsuspend_targets(map);
5df96f2b 2947 clear_bit(DMF_POST_SUSPENDING, &md->flags);
ffcc3936
MS
2948}
2949
2950static void __dm_internal_resume(struct mapped_device *md)
2951{
65e8fbde
MP
2952 int r;
2953 struct dm_table *map;
2954
96b26c8c
MP
2955 BUG_ON(!md->internal_suspend_count);
2956
2957 if (--md->internal_suspend_count)
ffcc3936
MS
2958 return; /* resume from nested internal suspend */
2959
fd2ed4d2 2960 if (dm_suspended_md(md))
ffcc3936
MS
2961 goto done; /* resume from nested suspend */
2962
65e8fbde
MP
2963 map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
2964 r = __dm_resume(md, map);
2965 if (r) {
2966 /*
2967 * If a preresume method of some target failed, we are in a
2968 * tricky situation. We can't return an error to the caller. We
2969 * can't fake success because then the "resume" and
2970 * "postsuspend" methods would not be paired correctly, and it
2971 * would break various targets, for example it would cause list
2972 * corruption in the "origin" target.
2973 *
2974 * So, we fake normal suspend here, to make sure that the
2975 * "resume" and "postsuspend" methods will be paired correctly.
2976 */
2977 DMERR("Preresume method failed: %d", r);
2978 set_bit(DMF_SUSPENDED, &md->flags);
2979 }
ffcc3936
MS
2980done:
2981 clear_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
2982 smp_mb__after_atomic();
2983 wake_up_bit(&md->flags, DMF_SUSPENDED_INTERNALLY);
2984}
2985
2986void dm_internal_suspend_noflush(struct mapped_device *md)
2987{
2988 mutex_lock(&md->suspend_lock);
2989 __dm_internal_suspend(md, DM_SUSPEND_NOFLUSH_FLAG);
2990 mutex_unlock(&md->suspend_lock);
2991}
2992EXPORT_SYMBOL_GPL(dm_internal_suspend_noflush);
2993
2994void dm_internal_resume(struct mapped_device *md)
2995{
2996 mutex_lock(&md->suspend_lock);
2997 __dm_internal_resume(md);
2998 mutex_unlock(&md->suspend_lock);
2999}
3000EXPORT_SYMBOL_GPL(dm_internal_resume);
3001
3002/*
3003 * Fast variants of internal suspend/resume hold md->suspend_lock,
3004 * which prevents interaction with userspace-driven suspend.
3005 */
3006
3007void dm_internal_suspend_fast(struct mapped_device *md)
3008{
3009 mutex_lock(&md->suspend_lock);
3010 if (dm_suspended_md(md) || dm_suspended_internally_md(md))
fd2ed4d2
MP
3011 return;
3012
3013 set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
3014 synchronize_srcu(&md->io_barrier);
3015 flush_workqueue(md->wq);
3016 dm_wait_for_completion(md, TASK_UNINTERRUPTIBLE);
3017}
b735fede 3018EXPORT_SYMBOL_GPL(dm_internal_suspend_fast);
fd2ed4d2 3019
ffcc3936 3020void dm_internal_resume_fast(struct mapped_device *md)
fd2ed4d2 3021{
ffcc3936 3022 if (dm_suspended_md(md) || dm_suspended_internally_md(md))
fd2ed4d2
MP
3023 goto done;
3024
3025 dm_queue_flush(md);
3026
3027done:
3028 mutex_unlock(&md->suspend_lock);
3029}
b735fede 3030EXPORT_SYMBOL_GPL(dm_internal_resume_fast);
fd2ed4d2 3031
a4a82ce3
HM
3032/*
3033 *---------------------------------------------------------------
1da177e4 3034 * Event notification.
a4a82ce3
HM
3035 *---------------------------------------------------------------
3036 */
3abf85b5 3037int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
86a3238c 3038 unsigned int cookie, bool need_resize_uevent)
69267a30 3039{
6958c1c6 3040 int r;
86a3238c 3041 unsigned int noio_flag;
60935eb2 3042 char udev_cookie[DM_COOKIE_LENGTH];
7533afa1
MP
3043 char *envp[3] = { NULL, NULL, NULL };
3044 char **envpp = envp;
3045 if (cookie) {
60935eb2
MB
3046 snprintf(udev_cookie, DM_COOKIE_LENGTH, "%s=%u",
3047 DM_COOKIE_ENV_VAR_NAME, cookie);
7533afa1 3048 *envpp++ = udev_cookie;
60935eb2 3049 }
7533afa1
MP
3050 if (need_resize_uevent) {
3051 *envpp++ = "RESIZE=1";
3052 }
3053
3054 noio_flag = memalloc_noio_save();
3055
3056 r = kobject_uevent_env(&disk_to_dev(md->disk)->kobj, action, envp);
6958c1c6
MP
3057
3058 memalloc_noio_restore(noio_flag);
3059
3060 return r;
69267a30
AK
3061}
3062
7a8c3d3b
MA
3063uint32_t dm_next_uevent_seq(struct mapped_device *md)
3064{
3065 return atomic_add_return(1, &md->uevent_seq);
3066}
3067
1da177e4
LT
3068uint32_t dm_get_event_nr(struct mapped_device *md)
3069{
3070 return atomic_read(&md->event_nr);
3071}
3072
3073int dm_wait_event(struct mapped_device *md, int event_nr)
3074{
3075 return wait_event_interruptible(md->eventq,
3076 (event_nr != atomic_read(&md->event_nr)));
3077}
3078
7a8c3d3b
MA
3079void dm_uevent_add(struct mapped_device *md, struct list_head *elist)
3080{
3081 unsigned long flags;
3082
3083 spin_lock_irqsave(&md->uevent_lock, flags);
3084 list_add(elist, &md->uevent_list);
3085 spin_unlock_irqrestore(&md->uevent_lock, flags);
3086}
3087
1da177e4
LT
3088/*
3089 * The gendisk is only valid as long as you have a reference
3090 * count on 'md'.
3091 */
3092struct gendisk *dm_disk(struct mapped_device *md)
3093{
3094 return md->disk;
3095}
65ff5b7d 3096EXPORT_SYMBOL_GPL(dm_disk);
1da177e4 3097
784aae73
MB
3098struct kobject *dm_kobject(struct mapped_device *md)
3099{
2995fa78 3100 return &md->kobj_holder.kobj;
784aae73
MB
3101}
3102
784aae73
MB
3103struct mapped_device *dm_get_from_kobject(struct kobject *kobj)
3104{
3105 struct mapped_device *md;
3106
2995fa78 3107 md = container_of(kobj, struct mapped_device, kobj_holder.kobj);
784aae73 3108
b9a41d21
HT
3109 spin_lock(&_minor_lock);
3110 if (test_bit(DMF_FREEING, &md->flags) || dm_deleting_md(md)) {
3111 md = NULL;
3112 goto out;
3113 }
784aae73 3114 dm_get(md);
b9a41d21
HT
3115out:
3116 spin_unlock(&_minor_lock);
3117
784aae73
MB
3118 return md;
3119}
3120
4f186f8b 3121int dm_suspended_md(struct mapped_device *md)
1da177e4
LT
3122{
3123 return test_bit(DMF_SUSPENDED, &md->flags);
3124}
3125
5df96f2b
MP
3126static int dm_post_suspending_md(struct mapped_device *md)
3127{
3128 return test_bit(DMF_POST_SUSPENDING, &md->flags);
3129}
3130
ffcc3936
MS
3131int dm_suspended_internally_md(struct mapped_device *md)
3132{
3133 return test_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
3134}
3135
2c140a24
MP
3136int dm_test_deferred_remove_flag(struct mapped_device *md)
3137{
3138 return test_bit(DMF_DEFERRED_REMOVE, &md->flags);
3139}
3140
64dbce58
KU
3141int dm_suspended(struct dm_target *ti)
3142{
33bd6f06 3143 return dm_suspended_md(ti->table->md);
64dbce58
KU
3144}
3145EXPORT_SYMBOL_GPL(dm_suspended);
3146
5df96f2b
MP
3147int dm_post_suspending(struct dm_target *ti)
3148{
33bd6f06 3149 return dm_post_suspending_md(ti->table->md);
5df96f2b
MP
3150}
3151EXPORT_SYMBOL_GPL(dm_post_suspending);
3152
2e93ccc1
KU
3153int dm_noflush_suspending(struct dm_target *ti)
3154{
33bd6f06 3155 return __noflush_suspending(ti->table->md);
2e93ccc1
KU
3156}
3157EXPORT_SYMBOL_GPL(dm_noflush_suspending);
3158
e6ee8c0b
KU
3159void dm_free_md_mempools(struct dm_md_mempools *pools)
3160{
3161 if (!pools)
3162 return;
3163
6f1c819c
KO
3164 bioset_exit(&pools->bs);
3165 bioset_exit(&pools->io_bs);
e6ee8c0b
KU
3166
3167 kfree(pools);
3168}
3169
9c72bad1
CH
3170struct dm_pr {
3171 u64 old_key;
3172 u64 new_key;
3173 u32 flags;
c6adada5 3174 bool abort;
9c72bad1 3175 bool fail_early;
8dd87f3c 3176 int ret;
70151087 3177 enum pr_type type;
8a8da082
MC
3178 struct pr_keys *read_keys;
3179 struct pr_held_reservation *rsv;
9c72bad1
CH
3180};
3181
3182static int dm_call_pr(struct block_device *bdev, iterate_devices_callout_fn fn,
8dd87f3c 3183 struct dm_pr *pr)
71cdb697
CH
3184{
3185 struct mapped_device *md = bdev->bd_disk->private_data;
9c72bad1
CH
3186 struct dm_table *table;
3187 struct dm_target *ti;
3188 int ret = -ENOTTY, srcu_idx;
71cdb697 3189
9c72bad1
CH
3190 table = dm_get_live_table(md, &srcu_idx);
3191 if (!table || !dm_table_get_size(table))
3192 goto out;
71cdb697 3193
9c72bad1 3194 /* We only support devices that have a single target */
2aec377a 3195 if (table->num_targets != 1)
9c72bad1
CH
3196 goto out;
3197 ti = dm_table_get_target(table, 0);
71cdb697 3198
e120a5f1
MS
3199 if (dm_suspended_md(md)) {
3200 ret = -EAGAIN;
3201 goto out;
3202 }
3203
9c72bad1
CH
3204 ret = -EINVAL;
3205 if (!ti->type->iterate_devices)
3206 goto out;
3207
8dd87f3c
MC
3208 ti->type->iterate_devices(ti, fn, pr);
3209 ret = 0;
9c72bad1
CH
3210out:
3211 dm_put_live_table(md, srcu_idx);
3212 return ret;
3213}
3214
3215/*
3216 * For register / unregister we need to manually call out to every path.
3217 */
3218static int __dm_pr_register(struct dm_target *ti, struct dm_dev *dev,
3219 sector_t start, sector_t len, void *data)
3220{
3221 struct dm_pr *pr = data;
3222 const struct pr_ops *ops = dev->bdev->bd_disk->fops->pr_ops;
8dd87f3c
MC
3223 int ret;
3224
3225 if (!ops || !ops->pr_register) {
3226 pr->ret = -EOPNOTSUPP;
3227 return -1;
3228 }
9c72bad1 3229
8dd87f3c
MC
3230 ret = ops->pr_register(dev->bdev, pr->old_key, pr->new_key, pr->flags);
3231 if (!ret)
3232 return 0;
3233
3234 if (!pr->ret)
3235 pr->ret = ret;
9c72bad1 3236
8dd87f3c
MC
3237 if (pr->fail_early)
3238 return -1;
3239
3240 return 0;
9c72bad1
CH
3241}
3242
3243static int dm_pr_register(struct block_device *bdev, u64 old_key, u64 new_key,
3244 u32 flags)
3245{
3246 struct dm_pr pr = {
3247 .old_key = old_key,
3248 .new_key = new_key,
3249 .flags = flags,
3250 .fail_early = true,
8dd87f3c 3251 .ret = 0,
9c72bad1
CH
3252 };
3253 int ret;
3254
3255 ret = dm_call_pr(bdev, __dm_pr_register, &pr);
8dd87f3c
MC
3256 if (ret) {
3257 /* Didn't even get to register a path */
3258 return ret;
9c72bad1
CH
3259 }
3260
8dd87f3c
MC
3261 if (!pr.ret)
3262 return 0;
3263 ret = pr.ret;
3264
3265 if (!new_key)
3266 return ret;
3267
3268 /* unregister all paths if we failed to register any path */
3269 pr.old_key = new_key;
3270 pr.new_key = 0;
3271 pr.flags = 0;
3272 pr.fail_early = false;
3273 (void) dm_call_pr(bdev, __dm_pr_register, &pr);
9c72bad1 3274 return ret;
71cdb697
CH
3275}
3276
70151087
MC
3277
3278static int __dm_pr_reserve(struct dm_target *ti, struct dm_dev *dev,
3279 sector_t start, sector_t len, void *data)
3280{
3281 struct dm_pr *pr = data;
3282 const struct pr_ops *ops = dev->bdev->bd_disk->fops->pr_ops;
3283
3284 if (!ops || !ops->pr_reserve) {
3285 pr->ret = -EOPNOTSUPP;
3286 return -1;
3287 }
3288
3289 pr->ret = ops->pr_reserve(dev->bdev, pr->old_key, pr->type, pr->flags);
3290 if (!pr->ret)
3291 return -1;
3292
3293 return 0;
3294}
3295
71cdb697 3296static int dm_pr_reserve(struct block_device *bdev, u64 key, enum pr_type type,
956a4025 3297 u32 flags)
71cdb697 3298{
70151087
MC
3299 struct dm_pr pr = {
3300 .old_key = key,
3301 .flags = flags,
3302 .type = type,
3303 .fail_early = false,
3304 .ret = 0,
3305 };
3306 int ret;
71cdb697 3307
70151087
MC
3308 ret = dm_call_pr(bdev, __dm_pr_reserve, &pr);
3309 if (ret)
3310 return ret;
71cdb697 3311
70151087 3312 return pr.ret;
71cdb697
CH
3313}
3314
08a3c338
MC
3315/*
3316 * If there is a non-All Registrants type of reservation, the release must be
3317 * sent down the holding path. For the cases where there is no reservation or
3318 * the path is not the holder the device will also return success, so we must
3319 * try each path to make sure we got the correct path.
3320 */
3321static int __dm_pr_release(struct dm_target *ti, struct dm_dev *dev,
3322 sector_t start, sector_t len, void *data)
3323{
3324 struct dm_pr *pr = data;
3325 const struct pr_ops *ops = dev->bdev->bd_disk->fops->pr_ops;
3326
3327 if (!ops || !ops->pr_release) {
3328 pr->ret = -EOPNOTSUPP;
3329 return -1;
3330 }
3331
3332 pr->ret = ops->pr_release(dev->bdev, pr->old_key, pr->type);
3333 if (pr->ret)
3334 return -1;
3335
3336 return 0;
71cdb697
CH
3337}
3338
3339static int dm_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
3340{
08a3c338
MC
3341 struct dm_pr pr = {
3342 .old_key = key,
3343 .type = type,
3344 .fail_early = false,
3345 };
3346 int ret;
71cdb697 3347
08a3c338
MC
3348 ret = dm_call_pr(bdev, __dm_pr_release, &pr);
3349 if (ret)
3350 return ret;
71cdb697 3351
08a3c338 3352 return pr.ret;
71cdb697
CH
3353}
3354
c6adada5
MC
3355static int __dm_pr_preempt(struct dm_target *ti, struct dm_dev *dev,
3356 sector_t start, sector_t len, void *data)
3357{
3358 struct dm_pr *pr = data;
3359 const struct pr_ops *ops = dev->bdev->bd_disk->fops->pr_ops;
3360
3361 if (!ops || !ops->pr_preempt) {
3362 pr->ret = -EOPNOTSUPP;
3363 return -1;
3364 }
3365
3366 pr->ret = ops->pr_preempt(dev->bdev, pr->old_key, pr->new_key, pr->type,
3367 pr->abort);
3368 if (!pr->ret)
3369 return -1;
3370
3371 return 0;
71cdb697
CH
3372}
3373
3374static int dm_pr_preempt(struct block_device *bdev, u64 old_key, u64 new_key,
956a4025 3375 enum pr_type type, bool abort)
71cdb697 3376{
c6adada5
MC
3377 struct dm_pr pr = {
3378 .new_key = new_key,
3379 .old_key = old_key,
3380 .type = type,
3381 .fail_early = false,
3382 };
3383 int ret;
71cdb697 3384
c6adada5
MC
3385 ret = dm_call_pr(bdev, __dm_pr_preempt, &pr);
3386 if (ret)
3387 return ret;
71cdb697 3388
c6adada5 3389 return pr.ret;
71cdb697
CH
3390}
3391
3392static int dm_pr_clear(struct block_device *bdev, u64 key)
3393{
3394 struct mapped_device *md = bdev->bd_disk->private_data;
3395 const struct pr_ops *ops;
971888c4 3396 int r, srcu_idx;
71cdb697 3397
5bd5e8d8 3398 r = dm_prepare_ioctl(md, &srcu_idx, &bdev);
71cdb697 3399 if (r < 0)
971888c4 3400 goto out;
71cdb697
CH
3401
3402 ops = bdev->bd_disk->fops->pr_ops;
3403 if (ops && ops->pr_clear)
3404 r = ops->pr_clear(bdev, key);
3405 else
3406 r = -EOPNOTSUPP;
971888c4
MS
3407out:
3408 dm_unprepare_ioctl(md, srcu_idx);
71cdb697
CH
3409 return r;
3410}
3411
8a8da082
MC
3412static int __dm_pr_read_keys(struct dm_target *ti, struct dm_dev *dev,
3413 sector_t start, sector_t len, void *data)
3414{
3415 struct dm_pr *pr = data;
3416 const struct pr_ops *ops = dev->bdev->bd_disk->fops->pr_ops;
3417
3418 if (!ops || !ops->pr_read_keys) {
3419 pr->ret = -EOPNOTSUPP;
3420 return -1;
3421 }
3422
3423 pr->ret = ops->pr_read_keys(dev->bdev, pr->read_keys);
3424 if (!pr->ret)
3425 return -1;
3426
3427 return 0;
3428}
3429
3430static int dm_pr_read_keys(struct block_device *bdev, struct pr_keys *keys)
3431{
3432 struct dm_pr pr = {
3433 .read_keys = keys,
3434 };
3435 int ret;
3436
3437 ret = dm_call_pr(bdev, __dm_pr_read_keys, &pr);
3438 if (ret)
3439 return ret;
3440
3441 return pr.ret;
3442}
3443
3444static int __dm_pr_read_reservation(struct dm_target *ti, struct dm_dev *dev,
3445 sector_t start, sector_t len, void *data)
3446{
3447 struct dm_pr *pr = data;
3448 const struct pr_ops *ops = dev->bdev->bd_disk->fops->pr_ops;
3449
3450 if (!ops || !ops->pr_read_reservation) {
3451 pr->ret = -EOPNOTSUPP;
3452 return -1;
3453 }
3454
3455 pr->ret = ops->pr_read_reservation(dev->bdev, pr->rsv);
3456 if (!pr->ret)
3457 return -1;
3458
3459 return 0;
3460}
3461
3462static int dm_pr_read_reservation(struct block_device *bdev,
3463 struct pr_held_reservation *rsv)
3464{
3465 struct dm_pr pr = {
3466 .rsv = rsv,
3467 };
3468 int ret;
3469
3470 ret = dm_call_pr(bdev, __dm_pr_read_reservation, &pr);
3471 if (ret)
3472 return ret;
3473
3474 return pr.ret;
3475}
3476
71cdb697
CH
3477static const struct pr_ops dm_pr_ops = {
3478 .pr_register = dm_pr_register,
3479 .pr_reserve = dm_pr_reserve,
3480 .pr_release = dm_pr_release,
3481 .pr_preempt = dm_pr_preempt,
3482 .pr_clear = dm_pr_clear,
8a8da082
MC
3483 .pr_read_keys = dm_pr_read_keys,
3484 .pr_read_reservation = dm_pr_read_reservation,
71cdb697
CH
3485};
3486
83d5cde4 3487static const struct block_device_operations dm_blk_dops = {
c62b37d9 3488 .submit_bio = dm_submit_bio,
b99fdcdc 3489 .poll_bio = dm_poll_bio,
1da177e4
LT
3490 .open = dm_blk_open,
3491 .release = dm_blk_close,
aa129a22 3492 .ioctl = dm_blk_ioctl,
3ac51e74 3493 .getgeo = dm_blk_getgeo,
e76239a3 3494 .report_zones = dm_blk_report_zones,
71cdb697 3495 .pr_ops = &dm_pr_ops,
1da177e4
LT
3496 .owner = THIS_MODULE
3497};
3498
681cc5e8
MS
3499static const struct block_device_operations dm_rq_blk_dops = {
3500 .open = dm_blk_open,
3501 .release = dm_blk_close,
3502 .ioctl = dm_blk_ioctl,
3503 .getgeo = dm_blk_getgeo,
3504 .pr_ops = &dm_pr_ops,
3505 .owner = THIS_MODULE
3506};
3507
f26c5719
DW
3508static const struct dax_operations dm_dax_ops = {
3509 .direct_access = dm_dax_direct_access,
cdf6cdcd 3510 .zero_page_range = dm_dax_zero_page_range,
047218ec 3511 .recovery_write = dm_dax_recovery_write,
f26c5719
DW
3512};
3513
1da177e4
LT
3514/*
3515 * module hooks
3516 */
3517module_init(dm_init);
3518module_exit(dm_exit);
3519
3520module_param(major, uint, 0);
3521MODULE_PARM_DESC(major, "The major number of the device mapper");
f4790826 3522
6a808034 3523module_param(reserved_bio_based_ios, uint, 0644);
e8603136
MS
3524MODULE_PARM_DESC(reserved_bio_based_ios, "Reserved IOs in bio-based mempools");
3525
6a808034 3526module_param(dm_numa_node, int, 0644);
115485e8
MS
3527MODULE_PARM_DESC(dm_numa_node, "NUMA node for DM device memory allocations");
3528
6a808034 3529module_param(swap_bios, int, 0644);
a666e5c0
MP
3530MODULE_PARM_DESC(swap_bios, "Maximum allowed inflight swap IOs");
3531
1da177e4 3532MODULE_DESCRIPTION(DM_NAME " driver");
fa34e589 3533MODULE_AUTHOR("Joe Thornber <dm-devel@lists.linux.dev>");
1da177e4 3534MODULE_LICENSE("GPL");