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