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