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