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