block/blk-core.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (C) 1991, 1992 Linus Torvalds
   4  * Copyright (C) 1994,      Karl Keyte: Added support for disk statistics
   5  * Elevator latency, (C) 2000  Andrea Arcangeli <andrea@suse.de> SuSE
   6  * Queue request tables / lock, selectable elevator, Jens Axboe <axboe@suse.de>
   7  * kernel-doc documentation started by NeilBrown <neilb@cse.unsw.edu.au>
   8  *      -  July2000
   9  * bio rewrite, highmem i/o, etc, Jens Axboe <axboe@suse.de> - may 2001
  10  */
  11
  12 /*
  13  * This handles all read/write requests to block devices
  14  */
  15 #include <linux/kernel.h>
  16 #include <linux/module.h>
  17 #include <linux/bio.h>
  18 #include <linux/blkdev.h>
  19 #include <linux/blk-pm.h>
  20 #include <linux/blk-integrity.h>
  21 #include <linux/highmem.h>
  22 #include <linux/mm.h>
  23 #include <linux/pagemap.h>
  24 #include <linux/kernel_stat.h>
  25 #include <linux/string.h>
  26 #include <linux/init.h>
  27 #include <linux/completion.h>
  28 #include <linux/slab.h>
  29 #include <linux/swap.h>
  30 #include <linux/writeback.h>
  31 #include <linux/task_io_accounting_ops.h>
  32 #include <linux/fault-inject.h>
  33 #include <linux/list_sort.h>
  34 #include <linux/delay.h>
  35 #include <linux/ratelimit.h>
  36 #include <linux/pm_runtime.h>
  37 #include <linux/t10-pi.h>
  38 #include <linux/debugfs.h>
  39 #include <linux/bpf.h>
  40 #include <linux/part_stat.h>
  41 #include <linux/sched/sysctl.h>
  42 #include <linux/blk-crypto.h>
  43
  44 #define CREATE_TRACE_POINTS
  45 #include <trace/events/block.h>
  46
  47 #include "blk.h"
  48 #include "blk-mq-sched.h"
  49 #include "blk-pm.h"
  50 #include "blk-cgroup.h"
  51 #include "blk-throttle.h"
  52
  53 struct dentry *blk_debugfs_root;
  54
  55 EXPORT_TRACEPOINT_SYMBOL_GPL(block_bio_remap);
  56 EXPORT_TRACEPOINT_SYMBOL_GPL(block_rq_remap);
  57 EXPORT_TRACEPOINT_SYMBOL_GPL(block_bio_complete);
  58 EXPORT_TRACEPOINT_SYMBOL_GPL(block_split);
  59 EXPORT_TRACEPOINT_SYMBOL_GPL(block_unplug);
  60 EXPORT_TRACEPOINT_SYMBOL_GPL(block_rq_insert);
  61
  62 DEFINE_IDA(blk_queue_ida);
  63
  64 /*
  65  * For queue allocation
  66  */
  67 struct kmem_cache *blk_requestq_cachep;
  68 struct kmem_cache *blk_requestq_srcu_cachep;
  69
  70 /*
  71  * Controlling structure to kblockd
  72  */
  73 static struct workqueue_struct *kblockd_workqueue;
  74
  75 /**
  76  * blk_queue_flag_set - atomically set a queue flag
  77  * @flag: flag to be set
  78  * @q: request queue
  79  */
  80 void blk_queue_flag_set(unsigned int flag, struct request_queue *q)
  81 {
  82         set_bit(flag, &q->queue_flags);
  83 }
  84 EXPORT_SYMBOL(blk_queue_flag_set);
  85
  86 /**
  87  * blk_queue_flag_clear - atomically clear a queue flag
  88  * @flag: flag to be cleared
  89  * @q: request queue
  90  */
  91 void blk_queue_flag_clear(unsigned int flag, struct request_queue *q)
  92 {
  93         clear_bit(flag, &q->queue_flags);
  94 }
  95 EXPORT_SYMBOL(blk_queue_flag_clear);
  96
  97 /**
  98  * blk_queue_flag_test_and_set - atomically test and set a queue flag
  99  * @flag: flag to be set
 100  * @q: request queue
 101  *
 102  * Returns the previous value of @flag - 0 if the flag was not set and 1 if
 103  * the flag was already set.
 104  */
 105 bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q)
 106 {
 107         return test_and_set_bit(flag, &q->queue_flags);
 108 }
 109 EXPORT_SYMBOL_GPL(blk_queue_flag_test_and_set);
 110
 111 #define REQ_OP_NAME(name) [REQ_OP_##name] = #name
 112 static const char *const blk_op_name[] = {
 113         REQ_OP_NAME(READ),
 114         REQ_OP_NAME(WRITE),
 115         REQ_OP_NAME(FLUSH),
 116         REQ_OP_NAME(DISCARD),
 117         REQ_OP_NAME(SECURE_ERASE),
 118         REQ_OP_NAME(ZONE_RESET),
 119         REQ_OP_NAME(ZONE_RESET_ALL),
 120         REQ_OP_NAME(ZONE_OPEN),
 121         REQ_OP_NAME(ZONE_CLOSE),
 122         REQ_OP_NAME(ZONE_FINISH),
 123         REQ_OP_NAME(ZONE_APPEND),
 124         REQ_OP_NAME(WRITE_ZEROES),
 125         REQ_OP_NAME(DRV_IN),
 126         REQ_OP_NAME(DRV_OUT),
 127 };
 128 #undef REQ_OP_NAME
 129
 130 /**
 131  * blk_op_str - Return string XXX in the REQ_OP_XXX.
 132  * @op: REQ_OP_XXX.
 133  *
 134  * Description: Centralize block layer function to convert REQ_OP_XXX into
 135  * string format. Useful in the debugging and tracing bio or request. For
 136  * invalid REQ_OP_XXX it returns string "UNKNOWN".
 137  */
 138 inline const char *blk_op_str(enum req_op op)
 139 {
 140         const char *op_str = "UNKNOWN";
 141
 142         if (op < ARRAY_SIZE(blk_op_name) && blk_op_name[op])
 143                 op_str = blk_op_name[op];
 144
 145         return op_str;
 146 }
 147 EXPORT_SYMBOL_GPL(blk_op_str);
 148
 149 static const struct {
 150         int             errno;
 151         const char      *name;
 152 } blk_errors[] = {
 153         [BLK_STS_OK]            = { 0,          "" },
 154         [BLK_STS_NOTSUPP]       = { -EOPNOTSUPP, "operation not supported" },
 155         [BLK_STS_TIMEOUT]       = { -ETIMEDOUT, "timeout" },
 156         [BLK_STS_NOSPC]         = { -ENOSPC,    "critical space allocation" },
 157         [BLK_STS_TRANSPORT]     = { -ENOLINK,   "recoverable transport" },
 158         [BLK_STS_TARGET]        = { -EREMOTEIO, "critical target" },
 159         [BLK_STS_NEXUS]         = { -EBADE,     "critical nexus" },
 160         [BLK_STS_MEDIUM]        = { -ENODATA,   "critical medium" },
 161         [BLK_STS_PROTECTION]    = { -EILSEQ,    "protection" },
 162         [BLK_STS_RESOURCE]      = { -ENOMEM,    "kernel resource" },
 163         [BLK_STS_DEV_RESOURCE]  = { -EBUSY,     "device resource" },
 164         [BLK_STS_AGAIN]         = { -EAGAIN,    "nonblocking retry" },
 165         [BLK_STS_OFFLINE]       = { -ENODEV,    "device offline" },
 166
 167         /* device mapper special case, should not leak out: */
 168         [BLK_STS_DM_REQUEUE]    = { -EREMCHG, "dm internal retry" },
 169
 170         /* zone device specific errors */
 171         [BLK_STS_ZONE_OPEN_RESOURCE]    = { -ETOOMANYREFS, "open zones exceeded" },
 172         [BLK_STS_ZONE_ACTIVE_RESOURCE]  = { -EOVERFLOW, "active zones exceeded" },
 173
 174         /* everything else not covered above: */
 175         [BLK_STS_IOERR]         = { -EIO,       "I/O" },
 176 };
 177
 178 blk_status_t errno_to_blk_status(int errno)
 179 {
 180         int i;
 181
 182         for (i = 0; i < ARRAY_SIZE(blk_errors); i++) {
 183                 if (blk_errors[i].errno == errno)
 184                         return (__force blk_status_t)i;
 185         }
 186
 187         return BLK_STS_IOERR;
 188 }
 189 EXPORT_SYMBOL_GPL(errno_to_blk_status);
 190
 191 int blk_status_to_errno(blk_status_t status)
 192 {
 193         int idx = (__force int)status;
 194
 195         if (WARN_ON_ONCE(idx >= ARRAY_SIZE(blk_errors)))
 196                 return -EIO;
 197         return blk_errors[idx].errno;
 198 }
 199 EXPORT_SYMBOL_GPL(blk_status_to_errno);
 200
 201 const char *blk_status_to_str(blk_status_t status)
 202 {
 203         int idx = (__force int)status;
 204
 205         if (WARN_ON_ONCE(idx >= ARRAY_SIZE(blk_errors)))
 206                 return "<null>";
 207         return blk_errors[idx].name;
 208 }
 209
 210 /**
 211  * blk_sync_queue - cancel any pending callbacks on a queue
 212  * @q: the queue
 213  *
 214  * Description:
 215  *     The block layer may perform asynchronous callback activity
 216  *     on a queue, such as calling the unplug function after a timeout.
 217  *     A block device may call blk_sync_queue to ensure that any
 218  *     such activity is cancelled, thus allowing it to release resources
 219  *     that the callbacks might use. The caller must already have made sure
 220  *     that its ->submit_bio will not re-add plugging prior to calling
 221  *     this function.
 222  *
 223  *     This function does not cancel any asynchronous activity arising
 224  *     out of elevator or throttling code. That would require elevator_exit()
 225  *     and blkcg_exit_queue() to be called with queue lock initialized.
 226  *
 227  */
 228 void blk_sync_queue(struct request_queue *q)
 229 {
 230         del_timer_sync(&q->timeout);
 231         cancel_work_sync(&q->timeout_work);
 232 }
 233 EXPORT_SYMBOL(blk_sync_queue);
 234
 235 /**
 236  * blk_set_pm_only - increment pm_only counter
 237  * @q: request queue pointer
 238  */
 239 void blk_set_pm_only(struct request_queue *q)
 240 {
 241         atomic_inc(&q->pm_only);
 242 }
 243 EXPORT_SYMBOL_GPL(blk_set_pm_only);
 244
 245 void blk_clear_pm_only(struct request_queue *q)
 246 {
 247         int pm_only;
 248
 249         pm_only = atomic_dec_return(&q->pm_only);
 250         WARN_ON_ONCE(pm_only < 0);
 251         if (pm_only == 0)
 252                 wake_up_all(&q->mq_freeze_wq);
 253 }
 254 EXPORT_SYMBOL_GPL(blk_clear_pm_only);
 255
 256 /**
 257  * blk_put_queue - decrement the request_queue refcount
 258  * @q: the request_queue structure to decrement the refcount for
 259  *
 260  * Decrements the refcount of the request_queue kobject. When this reaches 0
 261  * we'll have blk_release_queue() called.
 262  *
 263  * Context: Any context, but the last reference must not be dropped from
 264  *          atomic context.
 265  */
 266 void blk_put_queue(struct request_queue *q)
 267 {
 268         kobject_put(&q->kobj);
 269 }
 270 EXPORT_SYMBOL(blk_put_queue);
 271
 272 void blk_queue_start_drain(struct request_queue *q)
 273 {
 274         /*
 275          * When queue DYING flag is set, we need to block new req
 276          * entering queue, so we call blk_freeze_queue_start() to
 277          * prevent I/O from crossing blk_queue_enter().
 278          */
 279         blk_freeze_queue_start(q);
 280         if (queue_is_mq(q))
 281                 blk_mq_wake_waiters(q);
 282         /* Make blk_queue_enter() reexamine the DYING flag. */
 283         wake_up_all(&q->mq_freeze_wq);
 284 }
 285
 286 /**
 287  * blk_queue_enter() - try to increase q->q_usage_counter
 288  * @q: request queue pointer
 289  * @flags: BLK_MQ_REQ_NOWAIT and/or BLK_MQ_REQ_PM
 290  */
 291 int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags)
 292 {
 293         const bool pm = flags & BLK_MQ_REQ_PM;
 294
 295         while (!blk_try_enter_queue(q, pm)) {
 296                 if (flags & BLK_MQ_REQ_NOWAIT)
 297                         return -EAGAIN;
 298
 299                 /*
 300                  * read pair of barrier in blk_freeze_queue_start(), we need to
 301                  * order reading __PERCPU_REF_DEAD flag of .q_usage_counter and
 302                  * reading .mq_freeze_depth or queue dying flag, otherwise the
 303                  * following wait may never return if the two reads are
 304                  * reordered.
 305                  */
 306                 smp_rmb();
 307                 wait_event(q->mq_freeze_wq,
 308                            (!q->mq_freeze_depth &&
 309                             blk_pm_resume_queue(pm, q)) ||
 310                            blk_queue_dying(q));
 311                 if (blk_queue_dying(q))
 312                         return -ENODEV;
 313         }
 314
 315         return 0;
 316 }
 317
 318 int __bio_queue_enter(struct request_queue *q, struct bio *bio)
 319 {
 320         while (!blk_try_enter_queue(q, false)) {
 321                 struct gendisk *disk = bio->bi_bdev->bd_disk;
 322
 323                 if (bio->bi_opf & REQ_NOWAIT) {
 324                         if (test_bit(GD_DEAD, &disk->state))
 325                                 goto dead;
 326                         bio_wouldblock_error(bio);
 327                         return -EAGAIN;
 328                 }
 329
 330                 /*
 331                  * read pair of barrier in blk_freeze_queue_start(), we need to
 332                  * order reading __PERCPU_REF_DEAD flag of .q_usage_counter and
 333                  * reading .mq_freeze_depth or queue dying flag, otherwise the
 334                  * following wait may never return if the two reads are
 335                  * reordered.
 336                  */
 337                 smp_rmb();
 338                 wait_event(q->mq_freeze_wq,
 339                            (!q->mq_freeze_depth &&
 340                             blk_pm_resume_queue(false, q)) ||
 341                            test_bit(GD_DEAD, &disk->state));
 342                 if (test_bit(GD_DEAD, &disk->state))
 343                         goto dead;
 344         }
 345
 346         return 0;
 347 dead:
 348         bio_io_error(bio);
 349         return -ENODEV;
 350 }
 351
 352 void blk_queue_exit(struct request_queue *q)
 353 {
 354         percpu_ref_put(&q->q_usage_counter);
 355 }
 356
 357 static void blk_queue_usage_counter_release(struct percpu_ref *ref)
 358 {
 359         struct request_queue *q =
 360                 container_of(ref, struct request_queue, q_usage_counter);
 361
 362         wake_up_all(&q->mq_freeze_wq);
 363 }
 364
 365 static void blk_rq_timed_out_timer(struct timer_list *t)
 366 {
 367         struct request_queue *q = from_timer(q, t, timeout);
 368
 369         kblockd_schedule_work(&q->timeout_work);
 370 }
 371
 372 static void blk_timeout_work(struct work_struct *work)
 373 {
 374 }
 375
 376 struct request_queue *blk_alloc_queue(int node_id, bool alloc_srcu)
 377 {
 378         struct request_queue *q;
 379
 380         q = kmem_cache_alloc_node(blk_get_queue_kmem_cache(alloc_srcu),
 381                         GFP_KERNEL | __GFP_ZERO, node_id);
 382         if (!q)
 383                 return NULL;
 384
 385         if (alloc_srcu) {
 386                 blk_queue_flag_set(QUEUE_FLAG_HAS_SRCU, q);
 387                 if (init_srcu_struct(q->srcu) != 0)
 388                         goto fail_q;
 389         }
 390
 391         q->last_merge = NULL;
 392
 393         q->id = ida_alloc(&blk_queue_ida, GFP_KERNEL);
 394         if (q->id < 0)
 395                 goto fail_srcu;
 396
 397         q->stats = blk_alloc_queue_stats();
 398         if (!q->stats)
 399                 goto fail_id;
 400
 401         q->node = node_id;
 402
 403         atomic_set(&q->nr_active_requests_shared_tags, 0);
 404
 405         timer_setup(&q->timeout, blk_rq_timed_out_timer, 0);
 406         INIT_WORK(&q->timeout_work, blk_timeout_work);
 407         INIT_LIST_HEAD(&q->icq_list);
 408
 409         kobject_init(&q->kobj, &blk_queue_ktype);
 410
 411         mutex_init(&q->debugfs_mutex);
 412         mutex_init(&q->sysfs_lock);
 413         mutex_init(&q->sysfs_dir_lock);
 414         spin_lock_init(&q->queue_lock);
 415
 416         init_waitqueue_head(&q->mq_freeze_wq);
 417         mutex_init(&q->mq_freeze_lock);
 418
 419         /*
 420          * Init percpu_ref in atomic mode so that it's faster to shutdown.
 421          * See blk_register_queue() for details.
 422          */
 423         if (percpu_ref_init(&q->q_usage_counter,
 424                                 blk_queue_usage_counter_release,
 425                                 PERCPU_REF_INIT_ATOMIC, GFP_KERNEL))
 426                 goto fail_stats;
 427
 428         blk_queue_dma_alignment(q, 511);
 429         blk_set_default_limits(&q->limits);
 430         q->nr_requests = BLKDEV_DEFAULT_RQ;
 431
 432         return q;
 433
 434 fail_stats:
 435         blk_free_queue_stats(q->stats);
 436 fail_id:
 437         ida_free(&blk_queue_ida, q->id);
 438 fail_srcu:
 439         if (alloc_srcu)
 440                 cleanup_srcu_struct(q->srcu);
 441 fail_q:
 442         kmem_cache_free(blk_get_queue_kmem_cache(alloc_srcu), q);
 443         return NULL;
 444 }
 445
 446 /**
 447  * blk_get_queue - increment the request_queue refcount
 448  * @q: the request_queue structure to increment the refcount for
 449  *
 450  * Increment the refcount of the request_queue kobject.
 451  *
 452  * Context: Any context.
 453  */
 454 bool blk_get_queue(struct request_queue *q)
 455 {
 456         if (unlikely(blk_queue_dying(q)))
 457                 return false;
 458         kobject_get(&q->kobj);
 459         return true;
 460 }
 461 EXPORT_SYMBOL(blk_get_queue);
 462
 463 #ifdef CONFIG_FAIL_MAKE_REQUEST
 464
 465 static DECLARE_FAULT_ATTR(fail_make_request);
 466
 467 static int __init setup_fail_make_request(char *str)
 468 {
 469         return setup_fault_attr(&fail_make_request, str);
 470 }
 471 __setup("fail_make_request=", setup_fail_make_request);
 472
 473 bool should_fail_request(struct block_device *part, unsigned int bytes)
 474 {
 475         return part->bd_make_it_fail && should_fail(&fail_make_request, bytes);
 476 }
 477
 478 static int __init fail_make_request_debugfs(void)
 479 {
 480         struct dentry *dir = fault_create_debugfs_attr("fail_make_request",
 481                                                 NULL, &fail_make_request);
 482
 483         return PTR_ERR_OR_ZERO(dir);
 484 }
 485
 486 late_initcall(fail_make_request_debugfs);
 487 #endif /* CONFIG_FAIL_MAKE_REQUEST */
 488
 489 static inline void bio_check_ro(struct bio *bio)
 490 {
 491         if (op_is_write(bio_op(bio)) && bdev_read_only(bio->bi_bdev)) {
 492                 if (op_is_flush(bio->bi_opf) && !bio_sectors(bio))
 493                         return;
 494                 pr_warn("Trying to write to read-only block-device %pg\n",
 495                         bio->bi_bdev);
 496                 /* Older lvm-tools actually trigger this */
 497         }
 498 }
 499
 500 static noinline int should_fail_bio(struct bio *bio)
 501 {
 502         if (should_fail_request(bdev_whole(bio->bi_bdev), bio->bi_iter.bi_size))
 503                 return -EIO;
 504         return 0;
 505 }
 506 ALLOW_ERROR_INJECTION(should_fail_bio, ERRNO);
 507
 508 /*
 509  * Check whether this bio extends beyond the end of the device or partition.
 510  * This may well happen - the kernel calls bread() without checking the size of
 511  * the device, e.g., when mounting a file system.
 512  */
 513 static inline int bio_check_eod(struct bio *bio)
 514 {
 515         sector_t maxsector = bdev_nr_sectors(bio->bi_bdev);
 516         unsigned int nr_sectors = bio_sectors(bio);
 517
 518         if (nr_sectors && maxsector &&
 519             (nr_sectors > maxsector ||
 520              bio->bi_iter.bi_sector > maxsector - nr_sectors)) {
 521                 pr_info_ratelimited("%s: attempt to access beyond end of device\n"
 522                                     "%pg: rw=%d, sector=%llu, nr_sectors = %u limit=%llu\n",
 523                                     current->comm, bio->bi_bdev, bio->bi_opf,
 524                                     bio->bi_iter.bi_sector, nr_sectors, maxsector);
 525                 return -EIO;
 526         }
 527         return 0;
 528 }
 529
 530 /*
 531  * Remap block n of partition p to block n+start(p) of the disk.
 532  */
 533 static int blk_partition_remap(struct bio *bio)
 534 {
 535         struct block_device *p = bio->bi_bdev;
 536
 537         if (unlikely(should_fail_request(p, bio->bi_iter.bi_size)))
 538                 return -EIO;
 539         if (bio_sectors(bio)) {
 540                 bio->bi_iter.bi_sector += p->bd_start_sect;
 541                 trace_block_bio_remap(bio, p->bd_dev,
 542                                       bio->bi_iter.bi_sector -
 543                                       p->bd_start_sect);
 544         }
 545         bio_set_flag(bio, BIO_REMAPPED);
 546         return 0;
 547 }
 548
 549 /*
 550  * Check write append to a zoned block device.
 551  */
 552 static inline blk_status_t blk_check_zone_append(struct request_queue *q,
 553                                                  struct bio *bio)
 554 {
 555         int nr_sectors = bio_sectors(bio);
 556
 557         /* Only applicable to zoned block devices */
 558         if (!bdev_is_zoned(bio->bi_bdev))
 559                 return BLK_STS_NOTSUPP;
 560
 561         /* The bio sector must point to the start of a sequential zone */
 562         if (bio->bi_iter.bi_sector & (bdev_zone_sectors(bio->bi_bdev) - 1) ||
 563             !bio_zone_is_seq(bio))
 564                 return BLK_STS_IOERR;
 565
 566         /*
 567          * Not allowed to cross zone boundaries. Otherwise, the BIO will be
 568          * split and could result in non-contiguous sectors being written in
 569          * different zones.
 570          */
 571         if (nr_sectors > q->limits.chunk_sectors)
 572                 return BLK_STS_IOERR;
 573
 574         /* Make sure the BIO is small enough and will not get split */
 575         if (nr_sectors > q->limits.max_zone_append_sectors)
 576                 return BLK_STS_IOERR;
 577
 578         bio->bi_opf |= REQ_NOMERGE;
 579
 580         return BLK_STS_OK;
 581 }
 582
 583 static void __submit_bio(struct bio *bio)
 584 {
 585         struct gendisk *disk = bio->bi_bdev->bd_disk;
 586
 587         if (unlikely(!blk_crypto_bio_prep(&bio)))
 588                 return;
 589
 590         if (!disk->fops->submit_bio) {
 591                 blk_mq_submit_bio(bio);
 592         } else if (likely(bio_queue_enter(bio) == 0)) {
 593                 disk->fops->submit_bio(bio);
 594                 blk_queue_exit(disk->queue);
 595         }
 596 }
 597
 598 /*
 599  * The loop in this function may be a bit non-obvious, and so deserves some
 600  * explanation:
 601  *
 602  *  - Before entering the loop, bio->bi_next is NULL (as all callers ensure
 603  *    that), so we have a list with a single bio.
 604  *  - We pretend that we have just taken it off a longer list, so we assign
 605  *    bio_list to a pointer to the bio_list_on_stack, thus initialising the
 606  *    bio_list of new bios to be added.  ->submit_bio() may indeed add some more
 607  *    bios through a recursive call to submit_bio_noacct.  If it did, we find a
 608  *    non-NULL value in bio_list and re-enter the loop from the top.
 609  *  - In this case we really did just take the bio of the top of the list (no
 610  *    pretending) and so remove it from bio_list, and call into ->submit_bio()
 611  *    again.
 612  *
 613  * bio_list_on_stack[0] contains bios submitted by the current ->submit_bio.
 614  * bio_list_on_stack[1] contains bios that were submitted before the current
 615  *      ->submit_bio, but that haven't been processed yet.
 616  */
 617 static void __submit_bio_noacct(struct bio *bio)
 618 {
 619         struct bio_list bio_list_on_stack[2];
 620
 621         BUG_ON(bio->bi_next);
 622
 623         bio_list_init(&bio_list_on_stack[0]);
 624         current->bio_list = bio_list_on_stack;
 625
 626         do {
 627                 struct request_queue *q = bdev_get_queue(bio->bi_bdev);
 628                 struct bio_list lower, same;
 629
 630                 /*
 631                  * Create a fresh bio_list for all subordinate requests.
 632                  */
 633                 bio_list_on_stack[1] = bio_list_on_stack[0];
 634                 bio_list_init(&bio_list_on_stack[0]);
 635
 636                 __submit_bio(bio);
 637
 638                 /*
 639                  * Sort new bios into those for a lower level and those for the
 640                  * same level.
 641                  */
 642                 bio_list_init(&lower);
 643                 bio_list_init(&same);
 644                 while ((bio = bio_list_pop(&bio_list_on_stack[0])) != NULL)
 645                         if (q == bdev_get_queue(bio->bi_bdev))
 646                                 bio_list_add(&same, bio);
 647                         else
 648                                 bio_list_add(&lower, bio);
 649
 650                 /*
 651                  * Now assemble so we handle the lowest level first.
 652                  */
 653                 bio_list_merge(&bio_list_on_stack[0], &lower);
 654                 bio_list_merge(&bio_list_on_stack[0], &same);
 655                 bio_list_merge(&bio_list_on_stack[0], &bio_list_on_stack[1]);
 656         } while ((bio = bio_list_pop(&bio_list_on_stack[0])));
 657
 658         current->bio_list = NULL;
 659 }
 660
 661 static void __submit_bio_noacct_mq(struct bio *bio)
 662 {
 663         struct bio_list bio_list[2] = { };
 664
 665         current->bio_list = bio_list;
 666
 667         do {
 668                 __submit_bio(bio);
 669         } while ((bio = bio_list_pop(&bio_list[0])));
 670
 671         current->bio_list = NULL;
 672 }
 673
 674 void submit_bio_noacct_nocheck(struct bio *bio)
 675 {
 676         /*
 677          * We only want one ->submit_bio to be active at a time, else stack
 678          * usage with stacked devices could be a problem.  Use current->bio_list
 679          * to collect a list of requests submited by a ->submit_bio method while
 680          * it is active, and then process them after it returned.
 681          */
 682         if (current->bio_list)
 683                 bio_list_add(&current->bio_list[0], bio);
 684         else if (!bio->bi_bdev->bd_disk->fops->submit_bio)
 685                 __submit_bio_noacct_mq(bio);
 686         else
 687                 __submit_bio_noacct(bio);
 688 }
 689
 690 /**
 691  * submit_bio_noacct - re-submit a bio to the block device layer for I/O
 692  * @bio:  The bio describing the location in memory and on the device.
 693  *
 694  * This is a version of submit_bio() that shall only be used for I/O that is
 695  * resubmitted to lower level drivers by stacking block drivers.  All file
 696  * systems and other upper level users of the block layer should use
 697  * submit_bio() instead.
 698  */
 699 void submit_bio_noacct(struct bio *bio)
 700 {
 701         struct block_device *bdev = bio->bi_bdev;
 702         struct request_queue *q = bdev_get_queue(bdev);
 703         blk_status_t status = BLK_STS_IOERR;
 704         struct blk_plug *plug;
 705
 706         might_sleep();
 707
 708         plug = blk_mq_plug(bio);
 709         if (plug && plug->nowait)
 710                 bio->bi_opf |= REQ_NOWAIT;
 711
 712         /*
 713          * For a REQ_NOWAIT based request, return -EOPNOTSUPP
 714          * if queue does not support NOWAIT.
 715          */
 716         if ((bio->bi_opf & REQ_NOWAIT) && !bdev_nowait(bdev))
 717                 goto not_supported;
 718
 719         if (should_fail_bio(bio))
 720                 goto end_io;
 721         bio_check_ro(bio);
 722         if (!bio_flagged(bio, BIO_REMAPPED)) {
 723                 if (unlikely(bio_check_eod(bio)))
 724                         goto end_io;
 725                 if (bdev->bd_partno && unlikely(blk_partition_remap(bio)))
 726                         goto end_io;
 727         }
 728
 729         /*
 730          * Filter flush bio's early so that bio based drivers without flush
 731          * support don't have to worry about them.
 732          */
 733         if (op_is_flush(bio->bi_opf) &&
 734             !test_bit(QUEUE_FLAG_WC, &q->queue_flags)) {
 735                 bio->bi_opf &= ~(REQ_PREFLUSH | REQ_FUA);
 736                 if (!bio_sectors(bio)) {
 737                         status = BLK_STS_OK;
 738                         goto end_io;
 739                 }
 740         }
 741
 742         if (!test_bit(QUEUE_FLAG_POLL, &q->queue_flags))
 743                 bio_clear_polled(bio);
 744
 745         switch (bio_op(bio)) {
 746         case REQ_OP_DISCARD:
 747                 if (!bdev_max_discard_sectors(bdev))
 748                         goto not_supported;
 749                 break;
 750         case REQ_OP_SECURE_ERASE:
 751                 if (!bdev_max_secure_erase_sectors(bdev))
 752                         goto not_supported;
 753                 break;
 754         case REQ_OP_ZONE_APPEND:
 755                 status = blk_check_zone_append(q, bio);
 756                 if (status != BLK_STS_OK)
 757                         goto end_io;
 758                 break;
 759         case REQ_OP_ZONE_RESET:
 760         case REQ_OP_ZONE_OPEN:
 761         case REQ_OP_ZONE_CLOSE:
 762         case REQ_OP_ZONE_FINISH:
 763                 if (!bdev_is_zoned(bio->bi_bdev))
 764                         goto not_supported;
 765                 break;
 766         case REQ_OP_ZONE_RESET_ALL:
 767                 if (!bdev_is_zoned(bio->bi_bdev) || !blk_queue_zone_resetall(q))
 768                         goto not_supported;
 769                 break;
 770         case REQ_OP_WRITE_ZEROES:
 771                 if (!q->limits.max_write_zeroes_sectors)
 772                         goto not_supported;
 773                 break;
 774         default:
 775                 break;
 776         }
 777
 778         if (blk_throtl_bio(bio))
 779                 return;
 780
 781         blk_cgroup_bio_start(bio);
 782         blkcg_bio_issue_init(bio);
 783
 784         if (!bio_flagged(bio, BIO_TRACE_COMPLETION)) {
 785                 trace_block_bio_queue(bio);
 786                 /* Now that enqueuing has been traced, we need to trace
 787                  * completion as well.
 788                  */
 789                 bio_set_flag(bio, BIO_TRACE_COMPLETION);
 790         }
 791         submit_bio_noacct_nocheck(bio);
 792         return;
 793
 794 not_supported:
 795         status = BLK_STS_NOTSUPP;
 796 end_io:
 797         bio->bi_status = status;
 798         bio_endio(bio);
 799 }
 800 EXPORT_SYMBOL(submit_bio_noacct);
 801
 802 /**
 803  * submit_bio - submit a bio to the block device layer for I/O
 804  * @bio: The &struct bio which describes the I/O
 805  *
 806  * submit_bio() is used to submit I/O requests to block devices.  It is passed a
 807  * fully set up &struct bio that describes the I/O that needs to be done.  The
 808  * bio will be send to the device described by the bi_bdev field.
 809  *
 810  * The success/failure status of the request, along with notification of
 811  * completion, is delivered asynchronously through the ->bi_end_io() callback
 812  * in @bio.  The bio must NOT be touched by the caller until ->bi_end_io() has
 813  * been called.
 814  */
 815 void submit_bio(struct bio *bio)
 816 {
 817         if (blkcg_punt_bio_submit(bio))
 818                 return;
 819
 820         if (bio_op(bio) == REQ_OP_READ) {
 821                 task_io_account_read(bio->bi_iter.bi_size);
 822                 count_vm_events(PGPGIN, bio_sectors(bio));
 823         } else if (bio_op(bio) == REQ_OP_WRITE) {
 824                 count_vm_events(PGPGOUT, bio_sectors(bio));
 825         }
 826
 827         submit_bio_noacct(bio);
 828 }
 829 EXPORT_SYMBOL(submit_bio);
 830
 831 /**
 832  * bio_poll - poll for BIO completions
 833  * @bio: bio to poll for
 834  * @iob: batches of IO
 835  * @flags: BLK_POLL_* flags that control the behavior
 836  *
 837  * Poll for completions on queue associated with the bio. Returns number of
 838  * completed entries found.
 839  *
 840  * Note: the caller must either be the context that submitted @bio, or
 841  * be in a RCU critical section to prevent freeing of @bio.
 842  */
 843 int bio_poll(struct bio *bio, struct io_comp_batch *iob, unsigned int flags)
 844 {
 845         struct request_queue *q = bdev_get_queue(bio->bi_bdev);
 846         blk_qc_t cookie = READ_ONCE(bio->bi_cookie);
 847         int ret = 0;
 848
 849         if (cookie == BLK_QC_T_NONE ||
 850             !test_bit(QUEUE_FLAG_POLL, &q->queue_flags))
 851                 return 0;
 852
 853         /*
 854          * As the requests that require a zone lock are not plugged in the
 855          * first place, directly accessing the plug instead of using
 856          * blk_mq_plug() should not have any consequences during flushing for
 857          * zoned devices.
 858          */
 859         blk_flush_plug(current->plug, false);
 860
 861         if (bio_queue_enter(bio))
 862                 return 0;
 863         if (queue_is_mq(q)) {
 864                 ret = blk_mq_poll(q, cookie, iob, flags);
 865         } else {
 866                 struct gendisk *disk = q->disk;
 867
 868                 if (disk && disk->fops->poll_bio)
 869                         ret = disk->fops->poll_bio(bio, iob, flags);
 870         }
 871         blk_queue_exit(q);
 872         return ret;
 873 }
 874 EXPORT_SYMBOL_GPL(bio_poll);
 875
 876 /*
 877  * Helper to implement file_operations.iopoll.  Requires the bio to be stored
 878  * in iocb->private, and cleared before freeing the bio.
 879  */
 880 int iocb_bio_iopoll(struct kiocb *kiocb, struct io_comp_batch *iob,
 881                     unsigned int flags)
 882 {
 883         struct bio *bio;
 884         int ret = 0;
 885
 886         /*
 887          * Note: the bio cache only uses SLAB_TYPESAFE_BY_RCU, so bio can
 888          * point to a freshly allocated bio at this point.  If that happens
 889          * we have a few cases to consider:
 890          *
 891          *  1) the bio is beeing initialized and bi_bdev is NULL.  We can just
 892          *     simply nothing in this case
 893          *  2) the bio points to a not poll enabled device.  bio_poll will catch
 894          *     this and return 0
 895          *  3) the bio points to a poll capable device, including but not
 896          *     limited to the one that the original bio pointed to.  In this
 897          *     case we will call into the actual poll method and poll for I/O,
 898          *     even if we don't need to, but it won't cause harm either.
 899          *
 900          * For cases 2) and 3) above the RCU grace period ensures that bi_bdev
 901          * is still allocated. Because partitions hold a reference to the whole
 902          * device bdev and thus disk, the disk is also still valid.  Grabbing
 903          * a reference to the queue in bio_poll() ensures the hctxs and requests
 904          * are still valid as well.
 905          */
 906         rcu_read_lock();
 907         bio = READ_ONCE(kiocb->private);
 908         if (bio && bio->bi_bdev)
 909                 ret = bio_poll(bio, iob, flags);
 910         rcu_read_unlock();
 911
 912         return ret;
 913 }
 914 EXPORT_SYMBOL_GPL(iocb_bio_iopoll);
 915
 916 void update_io_ticks(struct block_device *part, unsigned long now, bool end)
 917 {
 918         unsigned long stamp;
 919 again:
 920         stamp = READ_ONCE(part->bd_stamp);
 921         if (unlikely(time_after(now, stamp))) {
 922                 if (likely(try_cmpxchg(&part->bd_stamp, &stamp, now)))
 923                         __part_stat_add(part, io_ticks, end ? now - stamp : 1);
 924         }
 925         if (part->bd_partno) {
 926                 part = bdev_whole(part);
 927                 goto again;
 928         }
 929 }
 930
 931 unsigned long bdev_start_io_acct(struct block_device *bdev,
 932                                  unsigned int sectors, enum req_op op,
 933                                  unsigned long start_time)
 934 {
 935         const int sgrp = op_stat_group(op);
 936
 937         part_stat_lock();
 938         update_io_ticks(bdev, start_time, false);
 939         part_stat_inc(bdev, ios[sgrp]);
 940         part_stat_add(bdev, sectors[sgrp], sectors);
 941         part_stat_local_inc(bdev, in_flight[op_is_write(op)]);
 942         part_stat_unlock();
 943
 944         return start_time;
 945 }
 946 EXPORT_SYMBOL(bdev_start_io_acct);
 947
 948 /**
 949  * bio_start_io_acct_time - start I/O accounting for bio based drivers
 950  * @bio:        bio to start account for
 951  * @start_time: start time that should be passed back to bio_end_io_acct().
 952  */
 953 void bio_start_io_acct_time(struct bio *bio, unsigned long start_time)
 954 {
 955         bdev_start_io_acct(bio->bi_bdev, bio_sectors(bio),
 956                            bio_op(bio), start_time);
 957 }
 958 EXPORT_SYMBOL_GPL(bio_start_io_acct_time);
 959
 960 /**
 961  * bio_start_io_acct - start I/O accounting for bio based drivers
 962  * @bio:        bio to start account for
 963  *
 964  * Returns the start time that should be passed back to bio_end_io_acct().
 965  */
 966 unsigned long bio_start_io_acct(struct bio *bio)
 967 {
 968         return bdev_start_io_acct(bio->bi_bdev, bio_sectors(bio),
 969                                   bio_op(bio), jiffies);
 970 }
 971 EXPORT_SYMBOL_GPL(bio_start_io_acct);
 972
 973 void bdev_end_io_acct(struct block_device *bdev, enum req_op op,
 974                       unsigned long start_time)
 975 {
 976         const int sgrp = op_stat_group(op);
 977         unsigned long now = READ_ONCE(jiffies);
 978         unsigned long duration = now - start_time;
 979
 980         part_stat_lock();
 981         update_io_ticks(bdev, now, true);
 982         part_stat_add(bdev, nsecs[sgrp], jiffies_to_nsecs(duration));
 983         part_stat_local_dec(bdev, in_flight[op_is_write(op)]);
 984         part_stat_unlock();
 985 }
 986 EXPORT_SYMBOL(bdev_end_io_acct);
 987
 988 void bio_end_io_acct_remapped(struct bio *bio, unsigned long start_time,
 989                               struct block_device *orig_bdev)
 990 {
 991         bdev_end_io_acct(orig_bdev, bio_op(bio), start_time);
 992 }
 993 EXPORT_SYMBOL_GPL(bio_end_io_acct_remapped);
 994
 995 /**
 996  * blk_lld_busy - Check if underlying low-level drivers of a device are busy
 997  * @q : the queue of the device being checked
 998  *
 999  * Description:
1000  *    Check if underlying low-level drivers of a device are busy.
1001  *    If the drivers want to export their busy state, they must set own
1002  *    exporting function using blk_queue_lld_busy() first.
1003  *
1004  *    Basically, this function is used only by request stacking drivers
1005  *    to stop dispatching requests to underlying devices when underlying
1006  *    devices are busy.  This behavior helps more I/O merging on the queue
1007  *    of the request stacking driver and prevents I/O throughput regression
1008  *    on burst I/O load.
1009  *
1010  * Return:
1011  *    0 - Not busy (The request stacking driver should dispatch request)
1012  *    1 - Busy (The request stacking driver should stop dispatching request)
1013  */
1014 int blk_lld_busy(struct request_queue *q)
1015 {
1016         if (queue_is_mq(q) && q->mq_ops->busy)
1017                 return q->mq_ops->busy(q);
1018
1019         return 0;
1020 }
1021 EXPORT_SYMBOL_GPL(blk_lld_busy);
1022
1023 int kblockd_schedule_work(struct work_struct *work)
1024 {
1025         return queue_work(kblockd_workqueue, work);
1026 }
1027 EXPORT_SYMBOL(kblockd_schedule_work);
1028
1029 int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork,
1030                                 unsigned long delay)
1031 {
1032         return mod_delayed_work_on(cpu, kblockd_workqueue, dwork, delay);
1033 }
1034 EXPORT_SYMBOL(kblockd_mod_delayed_work_on);
1035
1036 void blk_start_plug_nr_ios(struct blk_plug *plug, unsigned short nr_ios)
1037 {
1038         struct task_struct *tsk = current;
1039
1040         /*
1041          * If this is a nested plug, don't actually assign it.
1042          */
1043         if (tsk->plug)
1044                 return;
1045
1046         plug->mq_list = NULL;
1047         plug->cached_rq = NULL;
1048         plug->nr_ios = min_t(unsigned short, nr_ios, BLK_MAX_REQUEST_COUNT);
1049         plug->rq_count = 0;
1050         plug->multiple_queues = false;
1051         plug->has_elevator = false;
1052         plug->nowait = false;
1053         INIT_LIST_HEAD(&plug->cb_list);
1054
1055         /*
1056          * Store ordering should not be needed here, since a potential
1057          * preempt will imply a full memory barrier
1058          */
1059         tsk->plug = plug;
1060 }
1061
1062 /**
1063  * blk_start_plug - initialize blk_plug and track it inside the task_struct
1064  * @plug:       The &struct blk_plug that needs to be initialized
1065  *
1066  * Description:
1067  *   blk_start_plug() indicates to the block layer an intent by the caller
1068  *   to submit multiple I/O requests in a batch.  The block layer may use
1069  *   this hint to defer submitting I/Os from the caller until blk_finish_plug()
1070  *   is called.  However, the block layer may choose to submit requests
1071  *   before a call to blk_finish_plug() if the number of queued I/Os
1072  *   exceeds %BLK_MAX_REQUEST_COUNT, or if the size of the I/O is larger than
1073  *   %BLK_PLUG_FLUSH_SIZE.  The queued I/Os may also be submitted early if
1074  *   the task schedules (see below).
1075  *
1076  *   Tracking blk_plug inside the task_struct will help with auto-flushing the
1077  *   pending I/O should the task end up blocking between blk_start_plug() and
1078  *   blk_finish_plug(). This is important from a performance perspective, but
1079  *   also ensures that we don't deadlock. For instance, if the task is blocking
1080  *   for a memory allocation, memory reclaim could end up wanting to free a
1081  *   page belonging to that request that is currently residing in our private
1082  *   plug. By flushing the pending I/O when the process goes to sleep, we avoid
1083  *   this kind of deadlock.
1084  */
1085 void blk_start_plug(struct blk_plug *plug)
1086 {
1087         blk_start_plug_nr_ios(plug, 1);
1088 }
1089 EXPORT_SYMBOL(blk_start_plug);
1090
1091 static void flush_plug_callbacks(struct blk_plug *plug, bool from_schedule)
1092 {
1093         LIST_HEAD(callbacks);
1094
1095         while (!list_empty(&plug->cb_list)) {
1096                 list_splice_init(&plug->cb_list, &callbacks);
1097
1098                 while (!list_empty(&callbacks)) {
1099                         struct blk_plug_cb *cb = list_first_entry(&callbacks,
1100                                                           struct blk_plug_cb,
1101                                                           list);
1102                         list_del(&cb->list);
1103                         cb->callback(cb, from_schedule);
1104                 }
1105         }
1106 }
1107
1108 struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug, void *data,
1109                                       int size)
1110 {
1111         struct blk_plug *plug = current->plug;
1112         struct blk_plug_cb *cb;
1113
1114         if (!plug)
1115                 return NULL;
1116
1117         list_for_each_entry(cb, &plug->cb_list, list)
1118                 if (cb->callback == unplug && cb->data == data)
1119                         return cb;
1120
1121         /* Not currently on the callback list */
1122         BUG_ON(size < sizeof(*cb));
1123         cb = kzalloc(size, GFP_ATOMIC);
1124         if (cb) {
1125                 cb->data = data;
1126                 cb->callback = unplug;
1127                 list_add(&cb->list, &plug->cb_list);
1128         }
1129         return cb;
1130 }
1131 EXPORT_SYMBOL(blk_check_plugged);
1132
1133 void __blk_flush_plug(struct blk_plug *plug, bool from_schedule)
1134 {
1135         if (!list_empty(&plug->cb_list))
1136                 flush_plug_callbacks(plug, from_schedule);
1137         if (!rq_list_empty(plug->mq_list))
1138                 blk_mq_flush_plug_list(plug, from_schedule);
1139         /*
1140          * Unconditionally flush out cached requests, even if the unplug
1141          * event came from schedule. Since we know hold references to the
1142          * queue for cached requests, we don't want a blocked task holding
1143          * up a queue freeze/quiesce event.
1144          */
1145         if (unlikely(!rq_list_empty(plug->cached_rq)))
1146                 blk_mq_free_plug_rqs(plug);
1147 }
1148
1149 /**
1150  * blk_finish_plug - mark the end of a batch of submitted I/O
1151  * @plug:       The &struct blk_plug passed to blk_start_plug()
1152  *
1153  * Description:
1154  * Indicate that a batch of I/O submissions is complete.  This function
1155  * must be paired with an initial call to blk_start_plug().  The intent
1156  * is to allow the block layer to optimize I/O submission.  See the
1157  * documentation for blk_start_plug() for more information.
1158  */
1159 void blk_finish_plug(struct blk_plug *plug)
1160 {
1161         if (plug == current->plug) {
1162                 __blk_flush_plug(plug, false);
1163                 current->plug = NULL;
1164         }
1165 }
1166 EXPORT_SYMBOL(blk_finish_plug);
1167
1168 void blk_io_schedule(void)
1169 {
1170         /* Prevent hang_check timer from firing at us during very long I/O */
1171         unsigned long timeout = sysctl_hung_task_timeout_secs * HZ / 2;
1172
1173         if (timeout)
1174                 io_schedule_timeout(timeout);
1175         else
1176                 io_schedule();
1177 }
1178 EXPORT_SYMBOL_GPL(blk_io_schedule);
1179
1180 int __init blk_dev_init(void)
1181 {
1182         BUILD_BUG_ON((__force u32)REQ_OP_LAST >= (1 << REQ_OP_BITS));
1183         BUILD_BUG_ON(REQ_OP_BITS + REQ_FLAG_BITS > 8 *
1184                         sizeof_field(struct request, cmd_flags));
1185         BUILD_BUG_ON(REQ_OP_BITS + REQ_FLAG_BITS > 8 *
1186                         sizeof_field(struct bio, bi_opf));
1187         BUILD_BUG_ON(ALIGN(offsetof(struct request_queue, srcu),
1188                            __alignof__(struct request_queue)) !=
1189                      sizeof(struct request_queue));
1190
1191         /* used for unplugging and affects IO latency/throughput - HIGHPRI */
1192         kblockd_workqueue = alloc_workqueue("kblockd",
1193                                             WQ_MEM_RECLAIM | WQ_HIGHPRI, 0);
1194         if (!kblockd_workqueue)
1195                 panic("Failed to create kblockd\n");
1196
1197         blk_requestq_cachep = kmem_cache_create("request_queue",
1198                         sizeof(struct request_queue), 0, SLAB_PANIC, NULL);
1199
1200         blk_requestq_srcu_cachep = kmem_cache_create("request_queue_srcu",
1201                         sizeof(struct request_queue) +
1202                         sizeof(struct srcu_struct), 0, SLAB_PANIC, NULL);
1203
1204         blk_debugfs_root = debugfs_create_dir("block", NULL);
1205
1206         return 0;
1207 }