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