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