block: don't include <linux/idr.h> in blk.h
[linux-block.git] / block / blk-core.c
CommitLineData
3dcf60bc 1// SPDX-License-Identifier: GPL-2.0
1da177e4 2/*
1da177e4
LT
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>
6728cb0e
JA
7 * kernel-doc documentation started by NeilBrown <neilb@cse.unsw.edu.au>
8 * - July2000
1da177e4
LT
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 */
1da177e4
LT
15#include <linux/kernel.h>
16#include <linux/module.h>
1da177e4
LT
17#include <linux/bio.h>
18#include <linux/blkdev.h>
52abca64 19#include <linux/blk-pm.h>
fe45e630 20#include <linux/blk-integrity.h>
1da177e4
LT
21#include <linux/highmem.h>
22#include <linux/mm.h>
cee9a0c4 23#include <linux/pagemap.h>
1da177e4
LT
24#include <linux/kernel_stat.h>
25#include <linux/string.h>
26#include <linux/init.h>
1da177e4
LT
27#include <linux/completion.h>
28#include <linux/slab.h>
29#include <linux/swap.h>
30#include <linux/writeback.h>
faccbd4b 31#include <linux/task_io_accounting_ops.h>
c17bb495 32#include <linux/fault-inject.h>
73c10101 33#include <linux/list_sort.h>
e3c78ca5 34#include <linux/delay.h>
aaf7c680 35#include <linux/ratelimit.h>
6c954667 36#include <linux/pm_runtime.h>
eea8f41c 37#include <linux/blk-cgroup.h>
54d4e6ab 38#include <linux/t10-pi.h>
18fbda91 39#include <linux/debugfs.h>
30abb3a6 40#include <linux/bpf.h>
b8e24a93 41#include <linux/psi.h>
71ac860a 42#include <linux/sched/sysctl.h>
a892c8d5 43#include <linux/blk-crypto.h>
55782138
LZ
44
45#define CREATE_TRACE_POINTS
46#include <trace/events/block.h>
1da177e4 47
8324aa91 48#include "blk.h"
2aa7745b 49#include "blk-mq-sched.h"
bca6b067 50#include "blk-pm.h"
a7b36ee6 51#include "blk-throttle.h"
8324aa91 52
18fbda91 53struct dentry *blk_debugfs_root;
18fbda91 54
d07335e5 55EXPORT_TRACEPOINT_SYMBOL_GPL(block_bio_remap);
b0da3f0d 56EXPORT_TRACEPOINT_SYMBOL_GPL(block_rq_remap);
0a82a8d1 57EXPORT_TRACEPOINT_SYMBOL_GPL(block_bio_complete);
3291fa57 58EXPORT_TRACEPOINT_SYMBOL_GPL(block_split);
cbae8d45 59EXPORT_TRACEPOINT_SYMBOL_GPL(block_unplug);
b357e4a6 60EXPORT_TRACEPOINT_SYMBOL_GPL(block_rq_insert);
0bfc2455 61
a73f730d
TH
62DEFINE_IDA(blk_queue_ida);
63
1da177e4
LT
64/*
65 * For queue allocation
66 */
6728cb0e 67struct kmem_cache *blk_requestq_cachep;
1da177e4 68
1da177e4
LT
69/*
70 * Controlling structure to kblockd
71 */
ff856bad 72static struct workqueue_struct *kblockd_workqueue;
1da177e4 73
8814ce8a
BVA
74/**
75 * blk_queue_flag_set - atomically set a queue flag
76 * @flag: flag to be set
77 * @q: request queue
78 */
79void blk_queue_flag_set(unsigned int flag, struct request_queue *q)
80{
57d74df9 81 set_bit(flag, &q->queue_flags);
8814ce8a
BVA
82}
83EXPORT_SYMBOL(blk_queue_flag_set);
84
85/**
86 * blk_queue_flag_clear - atomically clear a queue flag
87 * @flag: flag to be cleared
88 * @q: request queue
89 */
90void blk_queue_flag_clear(unsigned int flag, struct request_queue *q)
91{
57d74df9 92 clear_bit(flag, &q->queue_flags);
8814ce8a
BVA
93}
94EXPORT_SYMBOL(blk_queue_flag_clear);
95
96/**
97 * blk_queue_flag_test_and_set - atomically test and set a queue flag
98 * @flag: flag to be set
99 * @q: request queue
100 *
101 * Returns the previous value of @flag - 0 if the flag was not set and 1 if
102 * the flag was already set.
103 */
104bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q)
105{
57d74df9 106 return test_and_set_bit(flag, &q->queue_flags);
8814ce8a
BVA
107}
108EXPORT_SYMBOL_GPL(blk_queue_flag_test_and_set);
109
e47bc4ed
CK
110#define REQ_OP_NAME(name) [REQ_OP_##name] = #name
111static const char *const blk_op_name[] = {
112 REQ_OP_NAME(READ),
113 REQ_OP_NAME(WRITE),
114 REQ_OP_NAME(FLUSH),
115 REQ_OP_NAME(DISCARD),
116 REQ_OP_NAME(SECURE_ERASE),
117 REQ_OP_NAME(ZONE_RESET),
6e33dbf2 118 REQ_OP_NAME(ZONE_RESET_ALL),
6c1b1da5
AJ
119 REQ_OP_NAME(ZONE_OPEN),
120 REQ_OP_NAME(ZONE_CLOSE),
121 REQ_OP_NAME(ZONE_FINISH),
0512a75b 122 REQ_OP_NAME(ZONE_APPEND),
e47bc4ed
CK
123 REQ_OP_NAME(WRITE_SAME),
124 REQ_OP_NAME(WRITE_ZEROES),
e47bc4ed
CK
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 */
138inline const char *blk_op_str(unsigned int 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}
147EXPORT_SYMBOL_GPL(blk_op_str);
148
2a842aca
CH
149static 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" },
86ff7c2a 163 [BLK_STS_DEV_RESOURCE] = { -EBUSY, "device resource" },
03a07c92 164 [BLK_STS_AGAIN] = { -EAGAIN, "nonblocking retry" },
2a842aca 165
4e4cbee9
CH
166 /* device mapper special case, should not leak out: */
167 [BLK_STS_DM_REQUEUE] = { -EREMCHG, "dm internal retry" },
168
3b481d91
KB
169 /* zone device specific errors */
170 [BLK_STS_ZONE_OPEN_RESOURCE] = { -ETOOMANYREFS, "open zones exceeded" },
171 [BLK_STS_ZONE_ACTIVE_RESOURCE] = { -EOVERFLOW, "active zones exceeded" },
172
2a842aca
CH
173 /* everything else not covered above: */
174 [BLK_STS_IOERR] = { -EIO, "I/O" },
175};
176
177blk_status_t errno_to_blk_status(int errno)
178{
179 int i;
180
181 for (i = 0; i < ARRAY_SIZE(blk_errors); i++) {
182 if (blk_errors[i].errno == errno)
183 return (__force blk_status_t)i;
184 }
185
186 return BLK_STS_IOERR;
187}
188EXPORT_SYMBOL_GPL(errno_to_blk_status);
189
190int blk_status_to_errno(blk_status_t status)
191{
192 int idx = (__force int)status;
193
34bd9c1c 194 if (WARN_ON_ONCE(idx >= ARRAY_SIZE(blk_errors)))
2a842aca
CH
195 return -EIO;
196 return blk_errors[idx].errno;
197}
198EXPORT_SYMBOL_GPL(blk_status_to_errno);
199
0d7a29a2 200const char *blk_status_to_str(blk_status_t status)
2a842aca
CH
201{
202 int idx = (__force int)status;
203
34bd9c1c 204 if (WARN_ON_ONCE(idx >= ARRAY_SIZE(blk_errors)))
0d7a29a2
CH
205 return "<null>";
206 return blk_errors[idx].name;
2a842aca
CH
207}
208
1da177e4
LT
209/**
210 * blk_sync_queue - cancel any pending callbacks on a queue
211 * @q: the queue
212 *
213 * Description:
214 * The block layer may perform asynchronous callback activity
215 * on a queue, such as calling the unplug function after a timeout.
216 * A block device may call blk_sync_queue to ensure that any
217 * such activity is cancelled, thus allowing it to release resources
59c51591 218 * that the callbacks might use. The caller must already have made sure
c62b37d9 219 * that its ->submit_bio will not re-add plugging prior to calling
1da177e4
LT
220 * this function.
221 *
da527770 222 * This function does not cancel any asynchronous activity arising
da3dae54 223 * out of elevator or throttling code. That would require elevator_exit()
5efd6113 224 * and blkcg_exit_queue() to be called with queue lock initialized.
da527770 225 *
1da177e4
LT
226 */
227void blk_sync_queue(struct request_queue *q)
228{
70ed28b9 229 del_timer_sync(&q->timeout);
4e9b6f20 230 cancel_work_sync(&q->timeout_work);
1da177e4
LT
231}
232EXPORT_SYMBOL(blk_sync_queue);
233
c9254f2d 234/**
cd84a62e 235 * blk_set_pm_only - increment pm_only counter
c9254f2d 236 * @q: request queue pointer
c9254f2d 237 */
cd84a62e 238void blk_set_pm_only(struct request_queue *q)
c9254f2d 239{
cd84a62e 240 atomic_inc(&q->pm_only);
c9254f2d 241}
cd84a62e 242EXPORT_SYMBOL_GPL(blk_set_pm_only);
c9254f2d 243
cd84a62e 244void blk_clear_pm_only(struct request_queue *q)
c9254f2d 245{
cd84a62e
BVA
246 int pm_only;
247
248 pm_only = atomic_dec_return(&q->pm_only);
249 WARN_ON_ONCE(pm_only < 0);
250 if (pm_only == 0)
251 wake_up_all(&q->mq_freeze_wq);
c9254f2d 252}
cd84a62e 253EXPORT_SYMBOL_GPL(blk_clear_pm_only);
c9254f2d 254
b5bd357c
LC
255/**
256 * blk_put_queue - decrement the request_queue refcount
257 * @q: the request_queue structure to decrement the refcount for
258 *
259 * Decrements the refcount of the request_queue kobject. When this reaches 0
260 * we'll have blk_release_queue() called.
e8c7d14a
LC
261 *
262 * Context: Any context, but the last reference must not be dropped from
263 * atomic context.
b5bd357c 264 */
165125e1 265void blk_put_queue(struct request_queue *q)
483f4afc
AV
266{
267 kobject_put(&q->kobj);
268}
d86e0e83 269EXPORT_SYMBOL(blk_put_queue);
483f4afc 270
8e141f9e 271void blk_queue_start_drain(struct request_queue *q)
aed3ea94 272{
d3cfb2a0
ML
273 /*
274 * When queue DYING flag is set, we need to block new req
275 * entering queue, so we call blk_freeze_queue_start() to
276 * prevent I/O from crossing blk_queue_enter().
277 */
278 blk_freeze_queue_start(q);
344e9ffc 279 if (queue_is_mq(q))
aed3ea94 280 blk_mq_wake_waiters(q);
055f6e18
ML
281 /* Make blk_queue_enter() reexamine the DYING flag. */
282 wake_up_all(&q->mq_freeze_wq);
aed3ea94 283}
8e141f9e
CH
284
285void blk_set_queue_dying(struct request_queue *q)
286{
287 blk_queue_flag_set(QUEUE_FLAG_DYING, q);
288 blk_queue_start_drain(q);
289}
aed3ea94
JA
290EXPORT_SYMBOL_GPL(blk_set_queue_dying);
291
c9a929dd
TH
292/**
293 * blk_cleanup_queue - shutdown a request queue
294 * @q: request queue to shutdown
295 *
c246e80d
BVA
296 * Mark @q DYING, drain all pending requests, mark @q DEAD, destroy and
297 * put it. All future requests will be failed immediately with -ENODEV.
e8c7d14a
LC
298 *
299 * Context: can sleep
c94a96ac 300 */
6728cb0e 301void blk_cleanup_queue(struct request_queue *q)
483f4afc 302{
e8c7d14a
LC
303 /* cannot be called from atomic context */
304 might_sleep();
305
bae85c15
BVA
306 WARN_ON_ONCE(blk_queue_registered(q));
307
3f3299d5 308 /* mark @q DYING, no new request or merges will be allowed afterwards */
aed3ea94 309 blk_set_queue_dying(q);
6ecf23af 310
57d74df9
CH
311 blk_queue_flag_set(QUEUE_FLAG_NOMERGES, q);
312 blk_queue_flag_set(QUEUE_FLAG_NOXMERGES, q);
c9a929dd 313
c246e80d
BVA
314 /*
315 * Drain all requests queued before DYING marking. Set DEAD flag to
67ed8b73
BVA
316 * prevent that blk_mq_run_hw_queues() accesses the hardware queues
317 * after draining finished.
c246e80d 318 */
3ef28e83 319 blk_freeze_queue(q);
c57cdf7a 320
57d74df9 321 blk_queue_flag_set(QUEUE_FLAG_DEAD, q);
c9a929dd 322
c9a929dd 323 blk_sync_queue(q);
2a19b28f
ML
324 if (queue_is_mq(q)) {
325 blk_mq_cancel_work_sync(q);
c7e2d94b 326 blk_mq_exit_queue(q);
2a19b28f 327 }
a1ce35fa 328
c3e22192
ML
329 /*
330 * In theory, request pool of sched_tags belongs to request queue.
331 * However, the current implementation requires tag_set for freeing
332 * requests, so free the pool now.
333 *
334 * Queue has become frozen, there can't be any in-queue requests, so
335 * it is safe to free requests now.
336 */
337 mutex_lock(&q->sysfs_lock);
338 if (q->elevator)
1820f4f0 339 blk_mq_sched_free_rqs(q);
c3e22192
ML
340 mutex_unlock(&q->sysfs_lock);
341
3ef28e83 342 percpu_ref_exit(&q->q_usage_counter);
45a9c9d9 343
c9a929dd 344 /* @q is and will stay empty, shutdown and put */
483f4afc
AV
345 blk_put_queue(q);
346}
1da177e4
LT
347EXPORT_SYMBOL(blk_cleanup_queue);
348
3a0a5299
BVA
349/**
350 * blk_queue_enter() - try to increase q->q_usage_counter
351 * @q: request queue pointer
a4d34da7 352 * @flags: BLK_MQ_REQ_NOWAIT and/or BLK_MQ_REQ_PM
3a0a5299 353 */
9a95e4ef 354int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags)
3ef28e83 355{
a4d34da7 356 const bool pm = flags & BLK_MQ_REQ_PM;
3a0a5299 357
1f14a098 358 while (!blk_try_enter_queue(q, pm)) {
3a0a5299 359 if (flags & BLK_MQ_REQ_NOWAIT)
3ef28e83
DW
360 return -EBUSY;
361
5ed61d3f 362 /*
1f14a098
CH
363 * read pair of barrier in blk_freeze_queue_start(), we need to
364 * order reading __PERCPU_REF_DEAD flag of .q_usage_counter and
365 * reading .mq_freeze_depth or queue dying flag, otherwise the
366 * following wait may never return if the two reads are
367 * reordered.
5ed61d3f
ML
368 */
369 smp_rmb();
1dc3039b 370 wait_event(q->mq_freeze_wq,
7996a8b5 371 (!q->mq_freeze_depth &&
52abca64 372 blk_pm_resume_queue(pm, q)) ||
1dc3039b 373 blk_queue_dying(q));
3ef28e83
DW
374 if (blk_queue_dying(q))
375 return -ENODEV;
3ef28e83 376 }
1f14a098
CH
377
378 return 0;
3ef28e83
DW
379}
380
c98cb5bb 381int __bio_queue_enter(struct request_queue *q, struct bio *bio)
accea322 382{
a6741536 383 while (!blk_try_enter_queue(q, false)) {
eab4e027
PB
384 struct gendisk *disk = bio->bi_bdev->bd_disk;
385
a6741536 386 if (bio->bi_opf & REQ_NOWAIT) {
8e141f9e 387 if (test_bit(GD_DEAD, &disk->state))
a6741536 388 goto dead;
accea322 389 bio_wouldblock_error(bio);
a6741536
CH
390 return -EBUSY;
391 }
392
393 /*
394 * read pair of barrier in blk_freeze_queue_start(), we need to
395 * order reading __PERCPU_REF_DEAD flag of .q_usage_counter and
396 * reading .mq_freeze_depth or queue dying flag, otherwise the
397 * following wait may never return if the two reads are
398 * reordered.
399 */
400 smp_rmb();
401 wait_event(q->mq_freeze_wq,
402 (!q->mq_freeze_depth &&
403 blk_pm_resume_queue(false, q)) ||
8e141f9e
CH
404 test_bit(GD_DEAD, &disk->state));
405 if (test_bit(GD_DEAD, &disk->state))
a6741536 406 goto dead;
accea322
CH
407 }
408
a6741536
CH
409 return 0;
410dead:
411 bio_io_error(bio);
412 return -ENODEV;
accea322
CH
413}
414
3ef28e83
DW
415void blk_queue_exit(struct request_queue *q)
416{
417 percpu_ref_put(&q->q_usage_counter);
418}
419
420static void blk_queue_usage_counter_release(struct percpu_ref *ref)
421{
422 struct request_queue *q =
423 container_of(ref, struct request_queue, q_usage_counter);
424
425 wake_up_all(&q->mq_freeze_wq);
426}
427
bca237a5 428static void blk_rq_timed_out_timer(struct timer_list *t)
287922eb 429{
bca237a5 430 struct request_queue *q = from_timer(q, t, timeout);
287922eb
CH
431
432 kblockd_schedule_work(&q->timeout_work);
433}
434
2e3c18d0
TH
435static void blk_timeout_work(struct work_struct *work)
436{
437}
438
c62b37d9 439struct request_queue *blk_alloc_queue(int node_id)
1946089a 440{
165125e1 441 struct request_queue *q;
338aa96d 442 int ret;
1946089a 443
8324aa91 444 q = kmem_cache_alloc_node(blk_requestq_cachep,
3d745ea5 445 GFP_KERNEL | __GFP_ZERO, node_id);
1da177e4
LT
446 if (!q)
447 return NULL;
448
cbf62af3 449 q->last_merge = NULL;
cbf62af3 450
3d745ea5 451 q->id = ida_simple_get(&blk_queue_ida, 0, 0, GFP_KERNEL);
a73f730d 452 if (q->id < 0)
3d2936f4 453 goto fail_q;
a73f730d 454
c495a176 455 ret = bioset_init(&q->bio_split, BIO_POOL_SIZE, 0, 0);
338aa96d 456 if (ret)
54efd50b
KO
457 goto fail_id;
458
a83b576c
JA
459 q->stats = blk_alloc_queue_stats();
460 if (!q->stats)
edb0872f 461 goto fail_split;
a83b576c 462
5151412d 463 q->node = node_id;
0989a025 464
079a2e3e 465 atomic_set(&q->nr_active_requests_shared_tags, 0);
bccf5e26 466
bca237a5 467 timer_setup(&q->timeout, blk_rq_timed_out_timer, 0);
2e3c18d0 468 INIT_WORK(&q->timeout_work, blk_timeout_work);
a612fddf 469 INIT_LIST_HEAD(&q->icq_list);
4eef3049 470#ifdef CONFIG_BLK_CGROUP
e8989fae 471 INIT_LIST_HEAD(&q->blkg_list);
4eef3049 472#endif
483f4afc 473
8324aa91 474 kobject_init(&q->kobj, &blk_queue_ktype);
1da177e4 475
85e0cbbb 476 mutex_init(&q->debugfs_mutex);
483f4afc 477 mutex_init(&q->sysfs_lock);
cecf5d87 478 mutex_init(&q->sysfs_dir_lock);
0d945c1f 479 spin_lock_init(&q->queue_lock);
c94a96ac 480
320ae51f 481 init_waitqueue_head(&q->mq_freeze_wq);
7996a8b5 482 mutex_init(&q->mq_freeze_lock);
320ae51f 483
3ef28e83
DW
484 /*
485 * Init percpu_ref in atomic mode so that it's faster to shutdown.
486 * See blk_register_queue() for details.
487 */
488 if (percpu_ref_init(&q->q_usage_counter,
489 blk_queue_usage_counter_release,
490 PERCPU_REF_INIT_ATOMIC, GFP_KERNEL))
edb0872f 491 goto fail_stats;
f51b802c 492
3ef28e83
DW
493 if (blkcg_init_queue(q))
494 goto fail_ref;
495
3d745ea5
CH
496 blk_queue_dma_alignment(q, 511);
497 blk_set_default_limits(&q->limits);
d2a27964 498 q->nr_requests = BLKDEV_DEFAULT_RQ;
3d745ea5 499
1da177e4 500 return q;
a73f730d 501
3ef28e83
DW
502fail_ref:
503 percpu_ref_exit(&q->q_usage_counter);
a83b576c 504fail_stats:
edb0872f 505 blk_free_queue_stats(q->stats);
54efd50b 506fail_split:
338aa96d 507 bioset_exit(&q->bio_split);
a73f730d
TH
508fail_id:
509 ida_simple_remove(&blk_queue_ida, q->id);
510fail_q:
511 kmem_cache_free(blk_requestq_cachep, q);
512 return NULL;
1da177e4 513}
1da177e4 514
b5bd357c
LC
515/**
516 * blk_get_queue - increment the request_queue refcount
517 * @q: the request_queue structure to increment the refcount for
518 *
519 * Increment the refcount of the request_queue kobject.
763b5892
LC
520 *
521 * Context: Any context.
b5bd357c 522 */
09ac46c4 523bool blk_get_queue(struct request_queue *q)
1da177e4 524{
3f3299d5 525 if (likely(!blk_queue_dying(q))) {
09ac46c4
TH
526 __blk_get_queue(q);
527 return true;
1da177e4
LT
528 }
529
09ac46c4 530 return false;
1da177e4 531}
d86e0e83 532EXPORT_SYMBOL(blk_get_queue);
1da177e4 533
52c5e62d 534static void handle_bad_sector(struct bio *bio, sector_t maxsector)
1da177e4
LT
535{
536 char b[BDEVNAME_SIZE];
537
8a3ee677 538 pr_info_ratelimited("%s: attempt to access beyond end of device\n"
f4ac712e 539 "%s: rw=%d, want=%llu, limit=%llu\n",
8a3ee677 540 current->comm,
f4ac712e
TH
541 bio_devname(bio, b), bio->bi_opf,
542 bio_end_sector(bio), maxsector);
1da177e4
LT
543}
544
c17bb495
AM
545#ifdef CONFIG_FAIL_MAKE_REQUEST
546
547static DECLARE_FAULT_ATTR(fail_make_request);
548
549static int __init setup_fail_make_request(char *str)
550{
551 return setup_fault_attr(&fail_make_request, str);
552}
553__setup("fail_make_request=", setup_fail_make_request);
554
06c8c691 555bool should_fail_request(struct block_device *part, unsigned int bytes)
c17bb495 556{
8446fe92 557 return part->bd_make_it_fail && should_fail(&fail_make_request, bytes);
c17bb495
AM
558}
559
560static int __init fail_make_request_debugfs(void)
561{
dd48c085
AM
562 struct dentry *dir = fault_create_debugfs_attr("fail_make_request",
563 NULL, &fail_make_request);
564
21f9fcd8 565 return PTR_ERR_OR_ZERO(dir);
c17bb495
AM
566}
567
568late_initcall(fail_make_request_debugfs);
c17bb495
AM
569#endif /* CONFIG_FAIL_MAKE_REQUEST */
570
2f9f6221 571static inline bool bio_check_ro(struct bio *bio)
721c7fc7 572{
2f9f6221 573 if (op_is_write(bio_op(bio)) && bdev_read_only(bio->bi_bdev)) {
721c7fc7
ID
574 char b[BDEVNAME_SIZE];
575
8b2ded1c
MP
576 if (op_is_flush(bio->bi_opf) && !bio_sectors(bio))
577 return false;
578
a32e236e 579 WARN_ONCE(1,
c8178674 580 "Trying to write to read-only block-device %s (partno %d)\n",
2f9f6221 581 bio_devname(bio, b), bio->bi_bdev->bd_partno);
a32e236e
LT
582 /* Older lvm-tools actually trigger this */
583 return false;
721c7fc7
ID
584 }
585
586 return false;
587}
588
30abb3a6
HM
589static noinline int should_fail_bio(struct bio *bio)
590{
309dca30 591 if (should_fail_request(bdev_whole(bio->bi_bdev), bio->bi_iter.bi_size))
30abb3a6
HM
592 return -EIO;
593 return 0;
594}
595ALLOW_ERROR_INJECTION(should_fail_bio, ERRNO);
596
52c5e62d
CH
597/*
598 * Check whether this bio extends beyond the end of the device or partition.
599 * This may well happen - the kernel calls bread() without checking the size of
600 * the device, e.g., when mounting a file system.
601 */
2f9f6221 602static inline int bio_check_eod(struct bio *bio)
52c5e62d 603{
2f9f6221 604 sector_t maxsector = bdev_nr_sectors(bio->bi_bdev);
52c5e62d
CH
605 unsigned int nr_sectors = bio_sectors(bio);
606
607 if (nr_sectors && maxsector &&
608 (nr_sectors > maxsector ||
609 bio->bi_iter.bi_sector > maxsector - nr_sectors)) {
610 handle_bad_sector(bio, maxsector);
611 return -EIO;
612 }
613 return 0;
614}
615
74d46992
CH
616/*
617 * Remap block n of partition p to block n+start(p) of the disk.
618 */
2f9f6221 619static int blk_partition_remap(struct bio *bio)
74d46992 620{
309dca30 621 struct block_device *p = bio->bi_bdev;
74d46992 622
52c5e62d 623 if (unlikely(should_fail_request(p, bio->bi_iter.bi_size)))
2f9f6221 624 return -EIO;
5eac3eb3 625 if (bio_sectors(bio)) {
8446fe92 626 bio->bi_iter.bi_sector += p->bd_start_sect;
1c02fca6 627 trace_block_bio_remap(bio, p->bd_dev,
29ff57c6 628 bio->bi_iter.bi_sector -
8446fe92 629 p->bd_start_sect);
52c5e62d 630 }
30c5d345 631 bio_set_flag(bio, BIO_REMAPPED);
2f9f6221 632 return 0;
74d46992
CH
633}
634
0512a75b
KB
635/*
636 * Check write append to a zoned block device.
637 */
638static inline blk_status_t blk_check_zone_append(struct request_queue *q,
639 struct bio *bio)
640{
641 sector_t pos = bio->bi_iter.bi_sector;
642 int nr_sectors = bio_sectors(bio);
643
644 /* Only applicable to zoned block devices */
645 if (!blk_queue_is_zoned(q))
646 return BLK_STS_NOTSUPP;
647
648 /* The bio sector must point to the start of a sequential zone */
649 if (pos & (blk_queue_zone_sectors(q) - 1) ||
650 !blk_queue_zone_is_seq(q, pos))
651 return BLK_STS_IOERR;
652
653 /*
654 * Not allowed to cross zone boundaries. Otherwise, the BIO will be
655 * split and could result in non-contiguous sectors being written in
656 * different zones.
657 */
658 if (nr_sectors > q->limits.chunk_sectors)
659 return BLK_STS_IOERR;
660
661 /* Make sure the BIO is small enough and will not get split */
662 if (nr_sectors > q->limits.max_zone_append_sectors)
663 return BLK_STS_IOERR;
664
665 bio->bi_opf |= REQ_NOMERGE;
666
667 return BLK_STS_OK;
668}
669
900e0807 670noinline_for_stack bool submit_bio_checks(struct bio *bio)
1da177e4 671{
309dca30 672 struct block_device *bdev = bio->bi_bdev;
eab4e027 673 struct request_queue *q = bdev_get_queue(bdev);
4e4cbee9 674 blk_status_t status = BLK_STS_IOERR;
5a473e83 675 struct blk_plug *plug;
1da177e4
LT
676
677 might_sleep();
1da177e4 678
5a473e83
JA
679 plug = blk_mq_plug(q, bio);
680 if (plug && plug->nowait)
681 bio->bi_opf |= REQ_NOWAIT;
682
03a07c92 683 /*
b0beb280 684 * For a REQ_NOWAIT based request, return -EOPNOTSUPP
021a2446 685 * if queue does not support NOWAIT.
03a07c92 686 */
021a2446 687 if ((bio->bi_opf & REQ_NOWAIT) && !blk_queue_nowait(q))
b0beb280 688 goto not_supported;
03a07c92 689
30abb3a6 690 if (should_fail_bio(bio))
5a7bbad2 691 goto end_io;
2f9f6221
CH
692 if (unlikely(bio_check_ro(bio)))
693 goto end_io;
3a905c37
CH
694 if (!bio_flagged(bio, BIO_REMAPPED)) {
695 if (unlikely(bio_check_eod(bio)))
696 goto end_io;
697 if (bdev->bd_partno && unlikely(blk_partition_remap(bio)))
698 goto end_io;
699 }
2056a782 700
5a7bbad2 701 /*
ed00aabd
CH
702 * Filter flush bio's early so that bio based drivers without flush
703 * support don't have to worry about them.
5a7bbad2 704 */
f3a8ab7d 705 if (op_is_flush(bio->bi_opf) &&
c888a8f9 706 !test_bit(QUEUE_FLAG_WC, &q->queue_flags)) {
1eff9d32 707 bio->bi_opf &= ~(REQ_PREFLUSH | REQ_FUA);
e439ab71 708 if (!bio_sectors(bio)) {
4e4cbee9 709 status = BLK_STS_OK;
51fd77bd
JA
710 goto end_io;
711 }
5a7bbad2 712 }
5ddfe969 713
d04c406f 714 if (!test_bit(QUEUE_FLAG_POLL, &q->queue_flags))
6ce913fe 715 bio_clear_polled(bio);
d04c406f 716
288dab8a
CH
717 switch (bio_op(bio)) {
718 case REQ_OP_DISCARD:
719 if (!blk_queue_discard(q))
720 goto not_supported;
721 break;
722 case REQ_OP_SECURE_ERASE:
723 if (!blk_queue_secure_erase(q))
724 goto not_supported;
725 break;
726 case REQ_OP_WRITE_SAME:
74d46992 727 if (!q->limits.max_write_same_sectors)
288dab8a 728 goto not_supported;
58886785 729 break;
0512a75b
KB
730 case REQ_OP_ZONE_APPEND:
731 status = blk_check_zone_append(q, bio);
732 if (status != BLK_STS_OK)
733 goto end_io;
734 break;
2d253440 735 case REQ_OP_ZONE_RESET:
6c1b1da5
AJ
736 case REQ_OP_ZONE_OPEN:
737 case REQ_OP_ZONE_CLOSE:
738 case REQ_OP_ZONE_FINISH:
74d46992 739 if (!blk_queue_is_zoned(q))
2d253440 740 goto not_supported;
288dab8a 741 break;
6e33dbf2
CK
742 case REQ_OP_ZONE_RESET_ALL:
743 if (!blk_queue_is_zoned(q) || !blk_queue_zone_resetall(q))
744 goto not_supported;
745 break;
a6f0788e 746 case REQ_OP_WRITE_ZEROES:
74d46992 747 if (!q->limits.max_write_zeroes_sectors)
a6f0788e
CK
748 goto not_supported;
749 break;
288dab8a
CH
750 default:
751 break;
5a7bbad2 752 }
01edede4 753
b781d8db 754 if (blk_throtl_bio(bio))
ae118896 755 return false;
db18a53e
CH
756
757 blk_cgroup_bio_start(bio);
758 blkcg_bio_issue_init(bio);
27a84d54 759
fbbaf700 760 if (!bio_flagged(bio, BIO_TRACE_COMPLETION)) {
e8a676d6 761 trace_block_bio_queue(bio);
fbbaf700
N
762 /* Now that enqueuing has been traced, we need to trace
763 * completion as well.
764 */
765 bio_set_flag(bio, BIO_TRACE_COMPLETION);
766 }
27a84d54 767 return true;
a7384677 768
288dab8a 769not_supported:
4e4cbee9 770 status = BLK_STS_NOTSUPP;
a7384677 771end_io:
4e4cbee9 772 bio->bi_status = status;
4246a0b6 773 bio_endio(bio);
27a84d54 774 return false;
1da177e4
LT
775}
776
900e0807 777static void __submit_bio_fops(struct gendisk *disk, struct bio *bio)
ac7c5675 778{
cc9c884d 779 if (unlikely(bio_queue_enter(bio) != 0))
3e08773c 780 return;
900e0807
JA
781 if (submit_bio_checks(bio) && blk_crypto_bio_prep(&bio))
782 disk->fops->submit_bio(bio);
783 blk_queue_exit(disk->queue);
784}
cc9c884d 785
900e0807
JA
786static void __submit_bio(struct bio *bio)
787{
788 struct gendisk *disk = bio->bi_bdev->bd_disk;
cc9c884d 789
900e0807 790 if (!disk->fops->submit_bio)
3e08773c 791 blk_mq_submit_bio(bio);
900e0807
JA
792 else
793 __submit_bio_fops(disk, bio);
ac7c5675
CH
794}
795
566acf2d
CH
796/*
797 * The loop in this function may be a bit non-obvious, and so deserves some
798 * explanation:
799 *
800 * - Before entering the loop, bio->bi_next is NULL (as all callers ensure
801 * that), so we have a list with a single bio.
802 * - We pretend that we have just taken it off a longer list, so we assign
803 * bio_list to a pointer to the bio_list_on_stack, thus initialising the
804 * bio_list of new bios to be added. ->submit_bio() may indeed add some more
805 * bios through a recursive call to submit_bio_noacct. If it did, we find a
806 * non-NULL value in bio_list and re-enter the loop from the top.
807 * - In this case we really did just take the bio of the top of the list (no
808 * pretending) and so remove it from bio_list, and call into ->submit_bio()
809 * again.
810 *
811 * bio_list_on_stack[0] contains bios submitted by the current ->submit_bio.
812 * bio_list_on_stack[1] contains bios that were submitted before the current
813 * ->submit_bio_bio, but that haven't been processed yet.
814 */
3e08773c 815static void __submit_bio_noacct(struct bio *bio)
566acf2d
CH
816{
817 struct bio_list bio_list_on_stack[2];
566acf2d
CH
818
819 BUG_ON(bio->bi_next);
820
821 bio_list_init(&bio_list_on_stack[0]);
822 current->bio_list = bio_list_on_stack;
823
824 do {
eab4e027 825 struct request_queue *q = bdev_get_queue(bio->bi_bdev);
566acf2d
CH
826 struct bio_list lower, same;
827
566acf2d
CH
828 /*
829 * Create a fresh bio_list for all subordinate requests.
830 */
831 bio_list_on_stack[1] = bio_list_on_stack[0];
832 bio_list_init(&bio_list_on_stack[0]);
833
3e08773c 834 __submit_bio(bio);
566acf2d
CH
835
836 /*
837 * Sort new bios into those for a lower level and those for the
838 * same level.
839 */
840 bio_list_init(&lower);
841 bio_list_init(&same);
842 while ((bio = bio_list_pop(&bio_list_on_stack[0])) != NULL)
eab4e027 843 if (q == bdev_get_queue(bio->bi_bdev))
566acf2d
CH
844 bio_list_add(&same, bio);
845 else
846 bio_list_add(&lower, bio);
847
848 /*
849 * Now assemble so we handle the lowest level first.
850 */
851 bio_list_merge(&bio_list_on_stack[0], &lower);
852 bio_list_merge(&bio_list_on_stack[0], &same);
853 bio_list_merge(&bio_list_on_stack[0], &bio_list_on_stack[1]);
854 } while ((bio = bio_list_pop(&bio_list_on_stack[0])));
855
856 current->bio_list = NULL;
566acf2d
CH
857}
858
3e08773c 859static void __submit_bio_noacct_mq(struct bio *bio)
ff93ea0c 860{
7c792f33 861 struct bio_list bio_list[2] = { };
ff93ea0c 862
7c792f33 863 current->bio_list = bio_list;
ff93ea0c
CH
864
865 do {
3e08773c 866 __submit_bio(bio);
7c792f33 867 } while ((bio = bio_list_pop(&bio_list[0])));
ff93ea0c
CH
868
869 current->bio_list = NULL;
ff93ea0c
CH
870}
871
27a84d54 872/**
ed00aabd 873 * submit_bio_noacct - re-submit a bio to the block device layer for I/O
27a84d54
CH
874 * @bio: The bio describing the location in memory and on the device.
875 *
3fdd4086
CH
876 * This is a version of submit_bio() that shall only be used for I/O that is
877 * resubmitted to lower level drivers by stacking block drivers. All file
878 * systems and other upper level users of the block layer should use
879 * submit_bio() instead.
d89d8796 880 */
3e08773c 881void submit_bio_noacct(struct bio *bio)
d89d8796 882{
27a84d54 883 /*
566acf2d
CH
884 * We only want one ->submit_bio to be active at a time, else stack
885 * usage with stacked devices could be a problem. Use current->bio_list
886 * to collect a list of requests submited by a ->submit_bio method while
887 * it is active, and then process them after it returned.
27a84d54 888 */
3e08773c 889 if (current->bio_list)
f5fe1b51 890 bio_list_add(&current->bio_list[0], bio);
3e08773c
CH
891 else if (!bio->bi_bdev->bd_disk->fops->submit_bio)
892 __submit_bio_noacct_mq(bio);
893 else
894 __submit_bio_noacct(bio);
d89d8796 895}
ed00aabd 896EXPORT_SYMBOL(submit_bio_noacct);
1da177e4
LT
897
898/**
710027a4 899 * submit_bio - submit a bio to the block device layer for I/O
1da177e4
LT
900 * @bio: The &struct bio which describes the I/O
901 *
3fdd4086
CH
902 * submit_bio() is used to submit I/O requests to block devices. It is passed a
903 * fully set up &struct bio that describes the I/O that needs to be done. The
309dca30 904 * bio will be send to the device described by the bi_bdev field.
1da177e4 905 *
3fdd4086
CH
906 * The success/failure status of the request, along with notification of
907 * completion, is delivered asynchronously through the ->bi_end_io() callback
908 * in @bio. The bio must NOT be touched by thecaller until ->bi_end_io() has
909 * been called.
1da177e4 910 */
3e08773c 911void submit_bio(struct bio *bio)
1da177e4 912{
d3f77dfd 913 if (blkcg_punt_bio_submit(bio))
3e08773c 914 return;
d3f77dfd 915
bf2de6f5
JA
916 /*
917 * If it's a regular read/write or a barrier with data attached,
918 * go through the normal accounting stuff before submission.
919 */
e2a60da7 920 if (bio_has_data(bio)) {
4363ac7c
MP
921 unsigned int count;
922
95fe6c1a 923 if (unlikely(bio_op(bio) == REQ_OP_WRITE_SAME))
309dca30 924 count = queue_logical_block_size(
eab4e027 925 bdev_get_queue(bio->bi_bdev)) >> 9;
4363ac7c
MP
926 else
927 count = bio_sectors(bio);
928
a8ebb056 929 if (op_is_write(bio_op(bio))) {
bf2de6f5
JA
930 count_vm_events(PGPGOUT, count);
931 } else {
4f024f37 932 task_io_account_read(bio->bi_iter.bi_size);
bf2de6f5
JA
933 count_vm_events(PGPGIN, count);
934 }
1da177e4
LT
935 }
936
b8e24a93 937 /*
760f83ea
CH
938 * If we're reading data that is part of the userspace workingset, count
939 * submission time as memory stall. When the device is congested, or
940 * the submitting cgroup IO-throttled, submission can be a significant
941 * part of overall IO time.
b8e24a93 942 */
760f83ea
CH
943 if (unlikely(bio_op(bio) == REQ_OP_READ &&
944 bio_flagged(bio, BIO_WORKINGSET))) {
945 unsigned long pflags;
b8e24a93 946
760f83ea 947 psi_memstall_enter(&pflags);
3e08773c 948 submit_bio_noacct(bio);
b8e24a93 949 psi_memstall_leave(&pflags);
3e08773c 950 return;
760f83ea
CH
951 }
952
3e08773c 953 submit_bio_noacct(bio);
1da177e4 954}
1da177e4
LT
955EXPORT_SYMBOL(submit_bio);
956
3e08773c
CH
957/**
958 * bio_poll - poll for BIO completions
959 * @bio: bio to poll for
e30028ac 960 * @iob: batches of IO
3e08773c
CH
961 * @flags: BLK_POLL_* flags that control the behavior
962 *
963 * Poll for completions on queue associated with the bio. Returns number of
964 * completed entries found.
965 *
966 * Note: the caller must either be the context that submitted @bio, or
967 * be in a RCU critical section to prevent freeing of @bio.
968 */
5a72e899 969int bio_poll(struct bio *bio, struct io_comp_batch *iob, unsigned int flags)
3e08773c 970{
859897c3 971 struct request_queue *q = bdev_get_queue(bio->bi_bdev);
3e08773c
CH
972 blk_qc_t cookie = READ_ONCE(bio->bi_cookie);
973 int ret;
974
975 if (cookie == BLK_QC_T_NONE ||
976 !test_bit(QUEUE_FLAG_POLL, &q->queue_flags))
977 return 0;
978
979 if (current->plug)
008f75a2 980 blk_flush_plug(current->plug, false);
3e08773c
CH
981
982 if (blk_queue_enter(q, BLK_MQ_REQ_NOWAIT))
983 return 0;
984 if (WARN_ON_ONCE(!queue_is_mq(q)))
985 ret = 0; /* not yet implemented, should not happen */
986 else
5a72e899 987 ret = blk_mq_poll(q, cookie, iob, flags);
3e08773c
CH
988 blk_queue_exit(q);
989 return ret;
990}
991EXPORT_SYMBOL_GPL(bio_poll);
992
993/*
994 * Helper to implement file_operations.iopoll. Requires the bio to be stored
995 * in iocb->private, and cleared before freeing the bio.
996 */
5a72e899
JA
997int iocb_bio_iopoll(struct kiocb *kiocb, struct io_comp_batch *iob,
998 unsigned int flags)
3e08773c
CH
999{
1000 struct bio *bio;
1001 int ret = 0;
1002
1003 /*
1004 * Note: the bio cache only uses SLAB_TYPESAFE_BY_RCU, so bio can
1005 * point to a freshly allocated bio at this point. If that happens
1006 * we have a few cases to consider:
1007 *
1008 * 1) the bio is beeing initialized and bi_bdev is NULL. We can just
1009 * simply nothing in this case
1010 * 2) the bio points to a not poll enabled device. bio_poll will catch
1011 * this and return 0
1012 * 3) the bio points to a poll capable device, including but not
1013 * limited to the one that the original bio pointed to. In this
1014 * case we will call into the actual poll method and poll for I/O,
1015 * even if we don't need to, but it won't cause harm either.
1016 *
1017 * For cases 2) and 3) above the RCU grace period ensures that bi_bdev
1018 * is still allocated. Because partitions hold a reference to the whole
1019 * device bdev and thus disk, the disk is also still valid. Grabbing
1020 * a reference to the queue in bio_poll() ensures the hctxs and requests
1021 * are still valid as well.
1022 */
1023 rcu_read_lock();
1024 bio = READ_ONCE(kiocb->private);
1025 if (bio && bio->bi_bdev)
5a72e899 1026 ret = bio_poll(bio, iob, flags);
3e08773c
CH
1027 rcu_read_unlock();
1028
1029 return ret;
1030}
1031EXPORT_SYMBOL_GPL(iocb_bio_iopoll);
1032
450b7879 1033void update_io_ticks(struct block_device *part, unsigned long now, bool end)
9123bf6f
CH
1034{
1035 unsigned long stamp;
1036again:
8446fe92 1037 stamp = READ_ONCE(part->bd_stamp);
d80c228d 1038 if (unlikely(time_after(now, stamp))) {
8446fe92 1039 if (likely(cmpxchg(&part->bd_stamp, stamp, now) == stamp))
9123bf6f
CH
1040 __part_stat_add(part, io_ticks, end ? now - stamp : 1);
1041 }
8446fe92
CH
1042 if (part->bd_partno) {
1043 part = bdev_whole(part);
9123bf6f
CH
1044 goto again;
1045 }
1046}
1047
8446fe92 1048static unsigned long __part_start_io_acct(struct block_device *part,
7b26410b 1049 unsigned int sectors, unsigned int op)
956d510e 1050{
956d510e
CH
1051 const int sgrp = op_stat_group(op);
1052 unsigned long now = READ_ONCE(jiffies);
1053
1054 part_stat_lock();
1055 update_io_ticks(part, now, false);
1056 part_stat_inc(part, ios[sgrp]);
1057 part_stat_add(part, sectors[sgrp], sectors);
1058 part_stat_local_inc(part, in_flight[op_is_write(op)]);
1059 part_stat_unlock();
320ae51f 1060
956d510e
CH
1061 return now;
1062}
7b26410b 1063
99dfc43e
CH
1064/**
1065 * bio_start_io_acct - start I/O accounting for bio based drivers
1066 * @bio: bio to start account for
1067 *
1068 * Returns the start time that should be passed back to bio_end_io_acct().
1069 */
1070unsigned long bio_start_io_acct(struct bio *bio)
7b26410b 1071{
99dfc43e 1072 return __part_start_io_acct(bio->bi_bdev, bio_sectors(bio), bio_op(bio));
7b26410b 1073}
99dfc43e 1074EXPORT_SYMBOL_GPL(bio_start_io_acct);
7b26410b
SL
1075
1076unsigned long disk_start_io_acct(struct gendisk *disk, unsigned int sectors,
1077 unsigned int op)
1078{
8446fe92 1079 return __part_start_io_acct(disk->part0, sectors, op);
7b26410b 1080}
956d510e
CH
1081EXPORT_SYMBOL(disk_start_io_acct);
1082
8446fe92 1083static void __part_end_io_acct(struct block_device *part, unsigned int op,
7b26410b 1084 unsigned long start_time)
956d510e 1085{
956d510e
CH
1086 const int sgrp = op_stat_group(op);
1087 unsigned long now = READ_ONCE(jiffies);
1088 unsigned long duration = now - start_time;
5b18b5a7 1089
956d510e
CH
1090 part_stat_lock();
1091 update_io_ticks(part, now, true);
1092 part_stat_add(part, nsecs[sgrp], jiffies_to_nsecs(duration));
1093 part_stat_local_dec(part, in_flight[op_is_write(op)]);
320ae51f
JA
1094 part_stat_unlock();
1095}
7b26410b 1096
99dfc43e
CH
1097void bio_end_io_acct_remapped(struct bio *bio, unsigned long start_time,
1098 struct block_device *orig_bdev)
7b26410b 1099{
99dfc43e 1100 __part_end_io_acct(orig_bdev, bio_op(bio), start_time);
7b26410b 1101}
99dfc43e 1102EXPORT_SYMBOL_GPL(bio_end_io_acct_remapped);
7b26410b
SL
1103
1104void disk_end_io_acct(struct gendisk *disk, unsigned int op,
1105 unsigned long start_time)
1106{
8446fe92 1107 __part_end_io_acct(disk->part0, op, start_time);
7b26410b 1108}
956d510e 1109EXPORT_SYMBOL(disk_end_io_acct);
320ae51f 1110
ef9e3fac
KU
1111/**
1112 * blk_lld_busy - Check if underlying low-level drivers of a device are busy
1113 * @q : the queue of the device being checked
1114 *
1115 * Description:
1116 * Check if underlying low-level drivers of a device are busy.
1117 * If the drivers want to export their busy state, they must set own
1118 * exporting function using blk_queue_lld_busy() first.
1119 *
1120 * Basically, this function is used only by request stacking drivers
1121 * to stop dispatching requests to underlying devices when underlying
1122 * devices are busy. This behavior helps more I/O merging on the queue
1123 * of the request stacking driver and prevents I/O throughput regression
1124 * on burst I/O load.
1125 *
1126 * Return:
1127 * 0 - Not busy (The request stacking driver should dispatch request)
1128 * 1 - Busy (The request stacking driver should stop dispatching request)
1129 */
1130int blk_lld_busy(struct request_queue *q)
1131{
344e9ffc 1132 if (queue_is_mq(q) && q->mq_ops->busy)
9ba20527 1133 return q->mq_ops->busy(q);
ef9e3fac
KU
1134
1135 return 0;
1136}
1137EXPORT_SYMBOL_GPL(blk_lld_busy);
1138
59c3d45e 1139int kblockd_schedule_work(struct work_struct *work)
1da177e4
LT
1140{
1141 return queue_work(kblockd_workqueue, work);
1142}
1da177e4
LT
1143EXPORT_SYMBOL(kblockd_schedule_work);
1144
818cd1cb
JA
1145int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork,
1146 unsigned long delay)
1147{
1148 return mod_delayed_work_on(cpu, kblockd_workqueue, dwork, delay);
1149}
1150EXPORT_SYMBOL(kblockd_mod_delayed_work_on);
1151
47c122e3
JA
1152void blk_start_plug_nr_ios(struct blk_plug *plug, unsigned short nr_ios)
1153{
1154 struct task_struct *tsk = current;
1155
1156 /*
1157 * If this is a nested plug, don't actually assign it.
1158 */
1159 if (tsk->plug)
1160 return;
1161
bc490f81 1162 plug->mq_list = NULL;
47c122e3
JA
1163 plug->cached_rq = NULL;
1164 plug->nr_ios = min_t(unsigned short, nr_ios, BLK_MAX_REQUEST_COUNT);
1165 plug->rq_count = 0;
1166 plug->multiple_queues = false;
dc5fc361 1167 plug->has_elevator = false;
47c122e3
JA
1168 plug->nowait = false;
1169 INIT_LIST_HEAD(&plug->cb_list);
1170
1171 /*
1172 * Store ordering should not be needed here, since a potential
1173 * preempt will imply a full memory barrier
1174 */
1175 tsk->plug = plug;
1176}
1177
75df7136
SJ
1178/**
1179 * blk_start_plug - initialize blk_plug and track it inside the task_struct
1180 * @plug: The &struct blk_plug that needs to be initialized
1181 *
1182 * Description:
40405851
JM
1183 * blk_start_plug() indicates to the block layer an intent by the caller
1184 * to submit multiple I/O requests in a batch. The block layer may use
1185 * this hint to defer submitting I/Os from the caller until blk_finish_plug()
1186 * is called. However, the block layer may choose to submit requests
1187 * before a call to blk_finish_plug() if the number of queued I/Os
1188 * exceeds %BLK_MAX_REQUEST_COUNT, or if the size of the I/O is larger than
1189 * %BLK_PLUG_FLUSH_SIZE. The queued I/Os may also be submitted early if
1190 * the task schedules (see below).
1191 *
75df7136
SJ
1192 * Tracking blk_plug inside the task_struct will help with auto-flushing the
1193 * pending I/O should the task end up blocking between blk_start_plug() and
1194 * blk_finish_plug(). This is important from a performance perspective, but
1195 * also ensures that we don't deadlock. For instance, if the task is blocking
1196 * for a memory allocation, memory reclaim could end up wanting to free a
1197 * page belonging to that request that is currently residing in our private
1198 * plug. By flushing the pending I/O when the process goes to sleep, we avoid
1199 * this kind of deadlock.
1200 */
73c10101
JA
1201void blk_start_plug(struct blk_plug *plug)
1202{
47c122e3 1203 blk_start_plug_nr_ios(plug, 1);
73c10101
JA
1204}
1205EXPORT_SYMBOL(blk_start_plug);
1206
74018dc3 1207static void flush_plug_callbacks(struct blk_plug *plug, bool from_schedule)
048c9374
N
1208{
1209 LIST_HEAD(callbacks);
1210
2a7d5559
SL
1211 while (!list_empty(&plug->cb_list)) {
1212 list_splice_init(&plug->cb_list, &callbacks);
048c9374 1213
2a7d5559
SL
1214 while (!list_empty(&callbacks)) {
1215 struct blk_plug_cb *cb = list_first_entry(&callbacks,
048c9374
N
1216 struct blk_plug_cb,
1217 list);
2a7d5559 1218 list_del(&cb->list);
74018dc3 1219 cb->callback(cb, from_schedule);
2a7d5559 1220 }
048c9374
N
1221 }
1222}
1223
9cbb1750
N
1224struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug, void *data,
1225 int size)
1226{
1227 struct blk_plug *plug = current->plug;
1228 struct blk_plug_cb *cb;
1229
1230 if (!plug)
1231 return NULL;
1232
1233 list_for_each_entry(cb, &plug->cb_list, list)
1234 if (cb->callback == unplug && cb->data == data)
1235 return cb;
1236
1237 /* Not currently on the callback list */
1238 BUG_ON(size < sizeof(*cb));
1239 cb = kzalloc(size, GFP_ATOMIC);
1240 if (cb) {
1241 cb->data = data;
1242 cb->callback = unplug;
1243 list_add(&cb->list, &plug->cb_list);
1244 }
1245 return cb;
1246}
1247EXPORT_SYMBOL(blk_check_plugged);
1248
008f75a2 1249void blk_flush_plug(struct blk_plug *plug, bool from_schedule)
73c10101 1250{
b600455d
PB
1251 if (!list_empty(&plug->cb_list))
1252 flush_plug_callbacks(plug, from_schedule);
bc490f81 1253 if (!rq_list_empty(plug->mq_list))
320ae51f 1254 blk_mq_flush_plug_list(plug, from_schedule);
c5fc7b93
JA
1255 /*
1256 * Unconditionally flush out cached requests, even if the unplug
1257 * event came from schedule. Since we know hold references to the
1258 * queue for cached requests, we don't want a blocked task holding
1259 * up a queue freeze/quiesce event.
1260 */
1261 if (unlikely(!rq_list_empty(plug->cached_rq)))
47c122e3 1262 blk_mq_free_plug_rqs(plug);
73c10101 1263}
73c10101 1264
40405851
JM
1265/**
1266 * blk_finish_plug - mark the end of a batch of submitted I/O
1267 * @plug: The &struct blk_plug passed to blk_start_plug()
1268 *
1269 * Description:
1270 * Indicate that a batch of I/O submissions is complete. This function
1271 * must be paired with an initial call to blk_start_plug(). The intent
1272 * is to allow the block layer to optimize I/O submission. See the
1273 * documentation for blk_start_plug() for more information.
1274 */
73c10101
JA
1275void blk_finish_plug(struct blk_plug *plug)
1276{
008f75a2
CH
1277 if (plug == current->plug) {
1278 blk_flush_plug(plug, false);
1279 current->plug = NULL;
1280 }
73c10101 1281}
88b996cd 1282EXPORT_SYMBOL(blk_finish_plug);
73c10101 1283
71ac860a
ML
1284void blk_io_schedule(void)
1285{
1286 /* Prevent hang_check timer from firing at us during very long I/O */
1287 unsigned long timeout = sysctl_hung_task_timeout_secs * HZ / 2;
1288
1289 if (timeout)
1290 io_schedule_timeout(timeout);
1291 else
1292 io_schedule();
1293}
1294EXPORT_SYMBOL_GPL(blk_io_schedule);
1295
1da177e4
LT
1296int __init blk_dev_init(void)
1297{
ef295ecf
CH
1298 BUILD_BUG_ON(REQ_OP_LAST >= (1 << REQ_OP_BITS));
1299 BUILD_BUG_ON(REQ_OP_BITS + REQ_FLAG_BITS > 8 *
c593642c 1300 sizeof_field(struct request, cmd_flags));
ef295ecf 1301 BUILD_BUG_ON(REQ_OP_BITS + REQ_FLAG_BITS > 8 *
c593642c 1302 sizeof_field(struct bio, bi_opf));
9eb55b03 1303
89b90be2
TH
1304 /* used for unplugging and affects IO latency/throughput - HIGHPRI */
1305 kblockd_workqueue = alloc_workqueue("kblockd",
28747fcd 1306 WQ_MEM_RECLAIM | WQ_HIGHPRI, 0);
1da177e4
LT
1307 if (!kblockd_workqueue)
1308 panic("Failed to create kblockd\n");
1309
c2789bd4 1310 blk_requestq_cachep = kmem_cache_create("request_queue",
165125e1 1311 sizeof(struct request_queue), 0, SLAB_PANIC, NULL);
1da177e4 1312
18fbda91 1313 blk_debugfs_root = debugfs_create_dir("block", NULL);
18fbda91 1314
d38ecf93 1315 return 0;
1da177e4 1316}