drivers/md/dm.c

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