Merge remote-tracking branch 'stable/linux-5.10.y' into rpi-5.10.y
[platform/kernel/linux-rpi.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/backing-dev.h>
18 #include <linux/bio.h>
19 #include <linux/blkdev.h>
20 #include <linux/blk-mq.h>
21 #include <linux/blk-pm.h>
22 #include <linux/highmem.h>
23 #include <linux/mm.h>
24 #include <linux/pagemap.h>
25 #include <linux/kernel_stat.h>
26 #include <linux/string.h>
27 #include <linux/init.h>
28 #include <linux/completion.h>
29 #include <linux/slab.h>
30 #include <linux/swap.h>
31 #include <linux/writeback.h>
32 #include <linux/task_io_accounting_ops.h>
33 #include <linux/fault-inject.h>
34 #include <linux/list_sort.h>
35 #include <linux/delay.h>
36 #include <linux/ratelimit.h>
37 #include <linux/pm_runtime.h>
38 #include <linux/blk-cgroup.h>
39 #include <linux/t10-pi.h>
40 #include <linux/debugfs.h>
41 #include <linux/bpf.h>
42 #include <linux/psi.h>
43 #include <linux/sched/sysctl.h>
44 #include <linux/blk-crypto.h>
45
46 #define CREATE_TRACE_POINTS
47 #include <trace/events/block.h>
48
49 #include "blk.h"
50 #include "blk-mq.h"
51 #include "blk-mq-sched.h"
52 #include "blk-pm.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
63 DEFINE_IDA(blk_queue_ida);
64
65 /*
66  * For queue allocation
67  */
68 struct kmem_cache *blk_requestq_cachep;
69
70 /*
71  * Controlling structure to kblockd
72  */
73 static struct workqueue_struct *kblockd_workqueue;
74
75 /**
76  * blk_queue_flag_set - atomically set a queue flag
77  * @flag: flag to be set
78  * @q: request queue
79  */
80 void blk_queue_flag_set(unsigned int flag, struct request_queue *q)
81 {
82         set_bit(flag, &q->queue_flags);
83 }
84 EXPORT_SYMBOL(blk_queue_flag_set);
85
86 /**
87  * blk_queue_flag_clear - atomically clear a queue flag
88  * @flag: flag to be cleared
89  * @q: request queue
90  */
91 void blk_queue_flag_clear(unsigned int flag, struct request_queue *q)
92 {
93         clear_bit(flag, &q->queue_flags);
94 }
95 EXPORT_SYMBOL(blk_queue_flag_clear);
96
97 /**
98  * blk_queue_flag_test_and_set - atomically test and set a queue flag
99  * @flag: flag to be set
100  * @q: request queue
101  *
102  * Returns the previous value of @flag - 0 if the flag was not set and 1 if
103  * the flag was already set.
104  */
105 bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q)
106 {
107         return test_and_set_bit(flag, &q->queue_flags);
108 }
109 EXPORT_SYMBOL_GPL(blk_queue_flag_test_and_set);
110
111 void blk_rq_init(struct request_queue *q, struct request *rq)
112 {
113         memset(rq, 0, sizeof(*rq));
114
115         INIT_LIST_HEAD(&rq->queuelist);
116         rq->q = q;
117         rq->__sector = (sector_t) -1;
118         INIT_HLIST_NODE(&rq->hash);
119         RB_CLEAR_NODE(&rq->rb_node);
120         rq->tag = BLK_MQ_NO_TAG;
121         rq->internal_tag = BLK_MQ_NO_TAG;
122         rq->start_time_ns = ktime_get_ns();
123         rq->part = NULL;
124         blk_crypto_rq_set_defaults(rq);
125 }
126 EXPORT_SYMBOL(blk_rq_init);
127
128 #define REQ_OP_NAME(name) [REQ_OP_##name] = #name
129 static const char *const blk_op_name[] = {
130         REQ_OP_NAME(READ),
131         REQ_OP_NAME(WRITE),
132         REQ_OP_NAME(FLUSH),
133         REQ_OP_NAME(DISCARD),
134         REQ_OP_NAME(SECURE_ERASE),
135         REQ_OP_NAME(ZONE_RESET),
136         REQ_OP_NAME(ZONE_RESET_ALL),
137         REQ_OP_NAME(ZONE_OPEN),
138         REQ_OP_NAME(ZONE_CLOSE),
139         REQ_OP_NAME(ZONE_FINISH),
140         REQ_OP_NAME(ZONE_APPEND),
141         REQ_OP_NAME(WRITE_SAME),
142         REQ_OP_NAME(WRITE_ZEROES),
143         REQ_OP_NAME(SCSI_IN),
144         REQ_OP_NAME(SCSI_OUT),
145         REQ_OP_NAME(DRV_IN),
146         REQ_OP_NAME(DRV_OUT),
147 };
148 #undef REQ_OP_NAME
149
150 /**
151  * blk_op_str - Return string XXX in the REQ_OP_XXX.
152  * @op: REQ_OP_XXX.
153  *
154  * Description: Centralize block layer function to convert REQ_OP_XXX into
155  * string format. Useful in the debugging and tracing bio or request. For
156  * invalid REQ_OP_XXX it returns string "UNKNOWN".
157  */
158 inline const char *blk_op_str(unsigned int op)
159 {
160         const char *op_str = "UNKNOWN";
161
162         if (op < ARRAY_SIZE(blk_op_name) && blk_op_name[op])
163                 op_str = blk_op_name[op];
164
165         return op_str;
166 }
167 EXPORT_SYMBOL_GPL(blk_op_str);
168
169 static const struct {
170         int             errno;
171         const char      *name;
172 } blk_errors[] = {
173         [BLK_STS_OK]            = { 0,          "" },
174         [BLK_STS_NOTSUPP]       = { -EOPNOTSUPP, "operation not supported" },
175         [BLK_STS_TIMEOUT]       = { -ETIMEDOUT, "timeout" },
176         [BLK_STS_NOSPC]         = { -ENOSPC,    "critical space allocation" },
177         [BLK_STS_TRANSPORT]     = { -ENOLINK,   "recoverable transport" },
178         [BLK_STS_TARGET]        = { -EREMOTEIO, "critical target" },
179         [BLK_STS_NEXUS]         = { -EBADE,     "critical nexus" },
180         [BLK_STS_MEDIUM]        = { -ENODATA,   "critical medium" },
181         [BLK_STS_PROTECTION]    = { -EILSEQ,    "protection" },
182         [BLK_STS_RESOURCE]      = { -ENOMEM,    "kernel resource" },
183         [BLK_STS_DEV_RESOURCE]  = { -EBUSY,     "device resource" },
184         [BLK_STS_AGAIN]         = { -EAGAIN,    "nonblocking retry" },
185
186         /* device mapper special case, should not leak out: */
187         [BLK_STS_DM_REQUEUE]    = { -EREMCHG, "dm internal retry" },
188
189         /* zone device specific errors */
190         [BLK_STS_ZONE_OPEN_RESOURCE]    = { -ETOOMANYREFS, "open zones exceeded" },
191         [BLK_STS_ZONE_ACTIVE_RESOURCE]  = { -EOVERFLOW, "active zones exceeded" },
192
193         /* everything else not covered above: */
194         [BLK_STS_IOERR]         = { -EIO,       "I/O" },
195 };
196
197 blk_status_t errno_to_blk_status(int errno)
198 {
199         int i;
200
201         for (i = 0; i < ARRAY_SIZE(blk_errors); i++) {
202                 if (blk_errors[i].errno == errno)
203                         return (__force blk_status_t)i;
204         }
205
206         return BLK_STS_IOERR;
207 }
208 EXPORT_SYMBOL_GPL(errno_to_blk_status);
209
210 int blk_status_to_errno(blk_status_t status)
211 {
212         int idx = (__force int)status;
213
214         if (WARN_ON_ONCE(idx >= ARRAY_SIZE(blk_errors)))
215                 return -EIO;
216         return blk_errors[idx].errno;
217 }
218 EXPORT_SYMBOL_GPL(blk_status_to_errno);
219
220 static void print_req_error(struct request *req, blk_status_t status,
221                 const char *caller)
222 {
223         int idx = (__force int)status;
224
225         if (WARN_ON_ONCE(idx >= ARRAY_SIZE(blk_errors)))
226                 return;
227
228         printk_ratelimited(KERN_ERR
229                 "%s: %s error, dev %s, sector %llu op 0x%x:(%s) flags 0x%x "
230                 "phys_seg %u prio class %u\n",
231                 caller, blk_errors[idx].name,
232                 req->rq_disk ? req->rq_disk->disk_name : "?",
233                 blk_rq_pos(req), req_op(req), blk_op_str(req_op(req)),
234                 req->cmd_flags & ~REQ_OP_MASK,
235                 req->nr_phys_segments,
236                 IOPRIO_PRIO_CLASS(req->ioprio));
237 }
238
239 static void req_bio_endio(struct request *rq, struct bio *bio,
240                           unsigned int nbytes, blk_status_t error)
241 {
242         if (error)
243                 bio->bi_status = error;
244
245         if (unlikely(rq->rq_flags & RQF_QUIET))
246                 bio_set_flag(bio, BIO_QUIET);
247
248         bio_advance(bio, nbytes);
249
250         if (req_op(rq) == REQ_OP_ZONE_APPEND && error == BLK_STS_OK) {
251                 /*
252                  * Partial zone append completions cannot be supported as the
253                  * BIO fragments may end up not being written sequentially.
254                  */
255                 if (bio->bi_iter.bi_size)
256                         bio->bi_status = BLK_STS_IOERR;
257                 else
258                         bio->bi_iter.bi_sector = rq->__sector;
259         }
260
261         /* don't actually finish bio if it's part of flush sequence */
262         if (bio->bi_iter.bi_size == 0 && !(rq->rq_flags & RQF_FLUSH_SEQ))
263                 bio_endio(bio);
264 }
265
266 void blk_dump_rq_flags(struct request *rq, char *msg)
267 {
268         printk(KERN_INFO "%s: dev %s: flags=%llx\n", msg,
269                 rq->rq_disk ? rq->rq_disk->disk_name : "?",
270                 (unsigned long long) rq->cmd_flags);
271
272         printk(KERN_INFO "  sector %llu, nr/cnr %u/%u\n",
273                (unsigned long long)blk_rq_pos(rq),
274                blk_rq_sectors(rq), blk_rq_cur_sectors(rq));
275         printk(KERN_INFO "  bio %p, biotail %p, len %u\n",
276                rq->bio, rq->biotail, blk_rq_bytes(rq));
277 }
278 EXPORT_SYMBOL(blk_dump_rq_flags);
279
280 /**
281  * blk_sync_queue - cancel any pending callbacks on a queue
282  * @q: the queue
283  *
284  * Description:
285  *     The block layer may perform asynchronous callback activity
286  *     on a queue, such as calling the unplug function after a timeout.
287  *     A block device may call blk_sync_queue to ensure that any
288  *     such activity is cancelled, thus allowing it to release resources
289  *     that the callbacks might use. The caller must already have made sure
290  *     that its ->submit_bio will not re-add plugging prior to calling
291  *     this function.
292  *
293  *     This function does not cancel any asynchronous activity arising
294  *     out of elevator or throttling code. That would require elevator_exit()
295  *     and blkcg_exit_queue() to be called with queue lock initialized.
296  *
297  */
298 void blk_sync_queue(struct request_queue *q)
299 {
300         del_timer_sync(&q->timeout);
301         cancel_work_sync(&q->timeout_work);
302 }
303 EXPORT_SYMBOL(blk_sync_queue);
304
305 /**
306  * blk_set_pm_only - increment pm_only counter
307  * @q: request queue pointer
308  */
309 void blk_set_pm_only(struct request_queue *q)
310 {
311         atomic_inc(&q->pm_only);
312 }
313 EXPORT_SYMBOL_GPL(blk_set_pm_only);
314
315 void blk_clear_pm_only(struct request_queue *q)
316 {
317         int pm_only;
318
319         pm_only = atomic_dec_return(&q->pm_only);
320         WARN_ON_ONCE(pm_only < 0);
321         if (pm_only == 0)
322                 wake_up_all(&q->mq_freeze_wq);
323 }
324 EXPORT_SYMBOL_GPL(blk_clear_pm_only);
325
326 /**
327  * blk_put_queue - decrement the request_queue refcount
328  * @q: the request_queue structure to decrement the refcount for
329  *
330  * Decrements the refcount of the request_queue kobject. When this reaches 0
331  * we'll have blk_release_queue() called.
332  *
333  * Context: Any context, but the last reference must not be dropped from
334  *          atomic context.
335  */
336 void blk_put_queue(struct request_queue *q)
337 {
338         kobject_put(&q->kobj);
339 }
340 EXPORT_SYMBOL(blk_put_queue);
341
342 void blk_set_queue_dying(struct request_queue *q)
343 {
344         blk_queue_flag_set(QUEUE_FLAG_DYING, q);
345
346         /*
347          * When queue DYING flag is set, we need to block new req
348          * entering queue, so we call blk_freeze_queue_start() to
349          * prevent I/O from crossing blk_queue_enter().
350          */
351         blk_freeze_queue_start(q);
352
353         if (queue_is_mq(q))
354                 blk_mq_wake_waiters(q);
355
356         /* Make blk_queue_enter() reexamine the DYING flag. */
357         wake_up_all(&q->mq_freeze_wq);
358 }
359 EXPORT_SYMBOL_GPL(blk_set_queue_dying);
360
361 /**
362  * blk_cleanup_queue - shutdown a request queue
363  * @q: request queue to shutdown
364  *
365  * Mark @q DYING, drain all pending requests, mark @q DEAD, destroy and
366  * put it.  All future requests will be failed immediately with -ENODEV.
367  *
368  * Context: can sleep
369  */
370 void blk_cleanup_queue(struct request_queue *q)
371 {
372         /* cannot be called from atomic context */
373         might_sleep();
374
375         WARN_ON_ONCE(blk_queue_registered(q));
376
377         /* mark @q DYING, no new request or merges will be allowed afterwards */
378         blk_set_queue_dying(q);
379
380         blk_queue_flag_set(QUEUE_FLAG_NOMERGES, q);
381         blk_queue_flag_set(QUEUE_FLAG_NOXMERGES, q);
382
383         /*
384          * Drain all requests queued before DYING marking. Set DEAD flag to
385          * prevent that blk_mq_run_hw_queues() accesses the hardware queues
386          * after draining finished.
387          */
388         blk_freeze_queue(q);
389
390         rq_qos_exit(q);
391
392         blk_queue_flag_set(QUEUE_FLAG_DEAD, q);
393
394         /* for synchronous bio-based driver finish in-flight integrity i/o */
395         blk_flush_integrity();
396
397         /* @q won't process any more request, flush async actions */
398         del_timer_sync(&q->backing_dev_info->laptop_mode_wb_timer);
399         blk_sync_queue(q);
400
401         if (queue_is_mq(q))
402                 blk_mq_exit_queue(q);
403
404         /*
405          * In theory, request pool of sched_tags belongs to request queue.
406          * However, the current implementation requires tag_set for freeing
407          * requests, so free the pool now.
408          *
409          * Queue has become frozen, there can't be any in-queue requests, so
410          * it is safe to free requests now.
411          */
412         mutex_lock(&q->sysfs_lock);
413         if (q->elevator)
414                 blk_mq_sched_free_requests(q);
415         mutex_unlock(&q->sysfs_lock);
416
417         percpu_ref_exit(&q->q_usage_counter);
418
419         /* @q is and will stay empty, shutdown and put */
420         blk_put_queue(q);
421 }
422 EXPORT_SYMBOL(blk_cleanup_queue);
423
424 /**
425  * blk_queue_enter() - try to increase q->q_usage_counter
426  * @q: request queue pointer
427  * @flags: BLK_MQ_REQ_NOWAIT and/or BLK_MQ_REQ_PM
428  */
429 int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags)
430 {
431         const bool pm = flags & BLK_MQ_REQ_PM;
432
433         while (true) {
434                 bool success = false;
435
436                 rcu_read_lock();
437                 if (percpu_ref_tryget_live(&q->q_usage_counter)) {
438                         /*
439                          * The code that increments the pm_only counter is
440                          * responsible for ensuring that that counter is
441                          * globally visible before the queue is unfrozen.
442                          */
443                         if ((pm && queue_rpm_status(q) != RPM_SUSPENDED) ||
444                             !blk_queue_pm_only(q)) {
445                                 success = true;
446                         } else {
447                                 percpu_ref_put(&q->q_usage_counter);
448                         }
449                 }
450                 rcu_read_unlock();
451
452                 if (success)
453                         return 0;
454
455                 if (flags & BLK_MQ_REQ_NOWAIT)
456                         return -EBUSY;
457
458                 /*
459                  * read pair of barrier in blk_freeze_queue_start(),
460                  * we need to order reading __PERCPU_REF_DEAD flag of
461                  * .q_usage_counter and reading .mq_freeze_depth or
462                  * queue dying flag, otherwise the following wait may
463                  * never return if the two reads are reordered.
464                  */
465                 smp_rmb();
466
467                 wait_event(q->mq_freeze_wq,
468                            (!q->mq_freeze_depth &&
469                             blk_pm_resume_queue(pm, q)) ||
470                            blk_queue_dying(q));
471                 if (blk_queue_dying(q))
472                         return -ENODEV;
473         }
474 }
475
476 static inline int bio_queue_enter(struct bio *bio)
477 {
478         struct request_queue *q = bio->bi_disk->queue;
479         bool nowait = bio->bi_opf & REQ_NOWAIT;
480         int ret;
481
482         ret = blk_queue_enter(q, nowait ? BLK_MQ_REQ_NOWAIT : 0);
483         if (unlikely(ret)) {
484                 if (nowait && !blk_queue_dying(q))
485                         bio_wouldblock_error(bio);
486                 else
487                         bio_io_error(bio);
488         }
489
490         return ret;
491 }
492
493 void blk_queue_exit(struct request_queue *q)
494 {
495         percpu_ref_put(&q->q_usage_counter);
496 }
497
498 static void blk_queue_usage_counter_release(struct percpu_ref *ref)
499 {
500         struct request_queue *q =
501                 container_of(ref, struct request_queue, q_usage_counter);
502
503         wake_up_all(&q->mq_freeze_wq);
504 }
505
506 static void blk_rq_timed_out_timer(struct timer_list *t)
507 {
508         struct request_queue *q = from_timer(q, t, timeout);
509
510         kblockd_schedule_work(&q->timeout_work);
511 }
512
513 static void blk_timeout_work(struct work_struct *work)
514 {
515 }
516
517 struct request_queue *blk_alloc_queue(int node_id)
518 {
519         struct request_queue *q;
520         int ret;
521
522         q = kmem_cache_alloc_node(blk_requestq_cachep,
523                                 GFP_KERNEL | __GFP_ZERO, node_id);
524         if (!q)
525                 return NULL;
526
527         q->last_merge = NULL;
528
529         q->id = ida_simple_get(&blk_queue_ida, 0, 0, GFP_KERNEL);
530         if (q->id < 0)
531                 goto fail_q;
532
533         ret = bioset_init(&q->bio_split, BIO_POOL_SIZE, 0, BIOSET_NEED_BVECS);
534         if (ret)
535                 goto fail_id;
536
537         q->backing_dev_info = bdi_alloc(node_id);
538         if (!q->backing_dev_info)
539                 goto fail_split;
540
541         q->stats = blk_alloc_queue_stats();
542         if (!q->stats)
543                 goto fail_stats;
544
545         q->node = node_id;
546
547         atomic_set(&q->nr_active_requests_shared_sbitmap, 0);
548
549         timer_setup(&q->backing_dev_info->laptop_mode_wb_timer,
550                     laptop_mode_timer_fn, 0);
551         timer_setup(&q->timeout, blk_rq_timed_out_timer, 0);
552         INIT_WORK(&q->timeout_work, blk_timeout_work);
553         INIT_LIST_HEAD(&q->icq_list);
554 #ifdef CONFIG_BLK_CGROUP
555         INIT_LIST_HEAD(&q->blkg_list);
556 #endif
557
558         kobject_init(&q->kobj, &blk_queue_ktype);
559
560         mutex_init(&q->debugfs_mutex);
561         mutex_init(&q->sysfs_lock);
562         mutex_init(&q->sysfs_dir_lock);
563         spin_lock_init(&q->queue_lock);
564
565         init_waitqueue_head(&q->mq_freeze_wq);
566         mutex_init(&q->mq_freeze_lock);
567
568         /*
569          * Init percpu_ref in atomic mode so that it's faster to shutdown.
570          * See blk_register_queue() for details.
571          */
572         if (percpu_ref_init(&q->q_usage_counter,
573                                 blk_queue_usage_counter_release,
574                                 PERCPU_REF_INIT_ATOMIC, GFP_KERNEL))
575                 goto fail_bdi;
576
577         if (blkcg_init_queue(q))
578                 goto fail_ref;
579
580         blk_queue_dma_alignment(q, 511);
581         blk_set_default_limits(&q->limits);
582         q->nr_requests = BLKDEV_MAX_RQ;
583
584         return q;
585
586 fail_ref:
587         percpu_ref_exit(&q->q_usage_counter);
588 fail_bdi:
589         blk_free_queue_stats(q->stats);
590 fail_stats:
591         bdi_put(q->backing_dev_info);
592 fail_split:
593         bioset_exit(&q->bio_split);
594 fail_id:
595         ida_simple_remove(&blk_queue_ida, q->id);
596 fail_q:
597         kmem_cache_free(blk_requestq_cachep, q);
598         return NULL;
599 }
600 EXPORT_SYMBOL(blk_alloc_queue);
601
602 /**
603  * blk_get_queue - increment the request_queue refcount
604  * @q: the request_queue structure to increment the refcount for
605  *
606  * Increment the refcount of the request_queue kobject.
607  *
608  * Context: Any context.
609  */
610 bool blk_get_queue(struct request_queue *q)
611 {
612         if (likely(!blk_queue_dying(q))) {
613                 __blk_get_queue(q);
614                 return true;
615         }
616
617         return false;
618 }
619 EXPORT_SYMBOL(blk_get_queue);
620
621 /**
622  * blk_get_request - allocate a request
623  * @q: request queue to allocate a request for
624  * @op: operation (REQ_OP_*) and REQ_* flags, e.g. REQ_SYNC.
625  * @flags: BLK_MQ_REQ_* flags, e.g. BLK_MQ_REQ_NOWAIT.
626  */
627 struct request *blk_get_request(struct request_queue *q, unsigned int op,
628                                 blk_mq_req_flags_t flags)
629 {
630         struct request *req;
631
632         WARN_ON_ONCE(op & REQ_NOWAIT);
633         WARN_ON_ONCE(flags & ~(BLK_MQ_REQ_NOWAIT | BLK_MQ_REQ_PM));
634
635         req = blk_mq_alloc_request(q, op, flags);
636         if (!IS_ERR(req) && q->mq_ops->initialize_rq_fn)
637                 q->mq_ops->initialize_rq_fn(req);
638
639         return req;
640 }
641 EXPORT_SYMBOL(blk_get_request);
642
643 void blk_put_request(struct request *req)
644 {
645         blk_mq_free_request(req);
646 }
647 EXPORT_SYMBOL(blk_put_request);
648
649 static void handle_bad_sector(struct bio *bio, sector_t maxsector)
650 {
651         char b[BDEVNAME_SIZE];
652
653         pr_info_ratelimited("attempt to access beyond end of device\n"
654                             "%s: rw=%d, want=%llu, limit=%llu\n",
655                             bio_devname(bio, b), bio->bi_opf,
656                             bio_end_sector(bio), maxsector);
657 }
658
659 #ifdef CONFIG_FAIL_MAKE_REQUEST
660
661 static DECLARE_FAULT_ATTR(fail_make_request);
662
663 static int __init setup_fail_make_request(char *str)
664 {
665         return setup_fault_attr(&fail_make_request, str);
666 }
667 __setup("fail_make_request=", setup_fail_make_request);
668
669 static bool should_fail_request(struct hd_struct *part, unsigned int bytes)
670 {
671         return part->make_it_fail && should_fail(&fail_make_request, bytes);
672 }
673
674 static int __init fail_make_request_debugfs(void)
675 {
676         struct dentry *dir = fault_create_debugfs_attr("fail_make_request",
677                                                 NULL, &fail_make_request);
678
679         return PTR_ERR_OR_ZERO(dir);
680 }
681
682 late_initcall(fail_make_request_debugfs);
683
684 #else /* CONFIG_FAIL_MAKE_REQUEST */
685
686 static inline bool should_fail_request(struct hd_struct *part,
687                                         unsigned int bytes)
688 {
689         return false;
690 }
691
692 #endif /* CONFIG_FAIL_MAKE_REQUEST */
693
694 static inline bool bio_check_ro(struct bio *bio, struct hd_struct *part)
695 {
696         const int op = bio_op(bio);
697
698         if (part->policy && op_is_write(op)) {
699                 char b[BDEVNAME_SIZE];
700
701                 if (op_is_flush(bio->bi_opf) && !bio_sectors(bio))
702                         return false;
703
704                 WARN_ONCE(1,
705                        "Trying to write to read-only block-device %s (partno %d)\n",
706                         bio_devname(bio, b), part->partno);
707                 /* Older lvm-tools actually trigger this */
708                 return false;
709         }
710
711         return false;
712 }
713
714 static noinline int should_fail_bio(struct bio *bio)
715 {
716         if (should_fail_request(&bio->bi_disk->part0, bio->bi_iter.bi_size))
717                 return -EIO;
718         return 0;
719 }
720 ALLOW_ERROR_INJECTION(should_fail_bio, ERRNO);
721
722 /*
723  * Check whether this bio extends beyond the end of the device or partition.
724  * This may well happen - the kernel calls bread() without checking the size of
725  * the device, e.g., when mounting a file system.
726  */
727 static inline int bio_check_eod(struct bio *bio, sector_t maxsector)
728 {
729         unsigned int nr_sectors = bio_sectors(bio);
730
731         if (nr_sectors && maxsector &&
732             (nr_sectors > maxsector ||
733              bio->bi_iter.bi_sector > maxsector - nr_sectors)) {
734                 handle_bad_sector(bio, maxsector);
735                 return -EIO;
736         }
737         return 0;
738 }
739
740 /*
741  * Remap block n of partition p to block n+start(p) of the disk.
742  */
743 static inline int blk_partition_remap(struct bio *bio)
744 {
745         struct hd_struct *p;
746         int ret = -EIO;
747
748         rcu_read_lock();
749         p = __disk_get_part(bio->bi_disk, bio->bi_partno);
750         if (unlikely(!p))
751                 goto out;
752         if (unlikely(should_fail_request(p, bio->bi_iter.bi_size)))
753                 goto out;
754         if (unlikely(bio_check_ro(bio, p)))
755                 goto out;
756
757         if (bio_sectors(bio)) {
758                 if (bio_check_eod(bio, part_nr_sects_read(p)))
759                         goto out;
760                 bio->bi_iter.bi_sector += p->start_sect;
761                 trace_block_bio_remap(bio->bi_disk->queue, bio, part_devt(p),
762                                       bio->bi_iter.bi_sector - p->start_sect);
763         }
764         bio->bi_partno = 0;
765         ret = 0;
766 out:
767         rcu_read_unlock();
768         return ret;
769 }
770
771 /*
772  * Check write append to a zoned block device.
773  */
774 static inline blk_status_t blk_check_zone_append(struct request_queue *q,
775                                                  struct bio *bio)
776 {
777         sector_t pos = bio->bi_iter.bi_sector;
778         int nr_sectors = bio_sectors(bio);
779
780         /* Only applicable to zoned block devices */
781         if (!blk_queue_is_zoned(q))
782                 return BLK_STS_NOTSUPP;
783
784         /* The bio sector must point to the start of a sequential zone */
785         if (pos & (blk_queue_zone_sectors(q) - 1) ||
786             !blk_queue_zone_is_seq(q, pos))
787                 return BLK_STS_IOERR;
788
789         /*
790          * Not allowed to cross zone boundaries. Otherwise, the BIO will be
791          * split and could result in non-contiguous sectors being written in
792          * different zones.
793          */
794         if (nr_sectors > q->limits.chunk_sectors)
795                 return BLK_STS_IOERR;
796
797         /* Make sure the BIO is small enough and will not get split */
798         if (nr_sectors > q->limits.max_zone_append_sectors)
799                 return BLK_STS_IOERR;
800
801         bio->bi_opf |= REQ_NOMERGE;
802
803         return BLK_STS_OK;
804 }
805
806 static noinline_for_stack bool submit_bio_checks(struct bio *bio)
807 {
808         struct request_queue *q = bio->bi_disk->queue;
809         blk_status_t status = BLK_STS_IOERR;
810         struct blk_plug *plug;
811
812         might_sleep();
813
814         plug = blk_mq_plug(q, bio);
815         if (plug && plug->nowait)
816                 bio->bi_opf |= REQ_NOWAIT;
817
818         /*
819          * For a REQ_NOWAIT based request, return -EOPNOTSUPP
820          * if queue does not support NOWAIT.
821          */
822         if ((bio->bi_opf & REQ_NOWAIT) && !blk_queue_nowait(q))
823                 goto not_supported;
824
825         if (should_fail_bio(bio))
826                 goto end_io;
827
828         if (bio->bi_partno) {
829                 if (unlikely(blk_partition_remap(bio)))
830                         goto end_io;
831         } else {
832                 if (unlikely(bio_check_ro(bio, &bio->bi_disk->part0)))
833                         goto end_io;
834                 if (unlikely(bio_check_eod(bio, get_capacity(bio->bi_disk))))
835                         goto end_io;
836         }
837
838         /*
839          * Filter flush bio's early so that bio based drivers without flush
840          * support don't have to worry about them.
841          */
842         if (op_is_flush(bio->bi_opf) &&
843             !test_bit(QUEUE_FLAG_WC, &q->queue_flags)) {
844                 bio->bi_opf &= ~(REQ_PREFLUSH | REQ_FUA);
845                 if (!bio_sectors(bio)) {
846                         status = BLK_STS_OK;
847                         goto end_io;
848                 }
849         }
850
851         if (!test_bit(QUEUE_FLAG_POLL, &q->queue_flags))
852                 bio->bi_opf &= ~REQ_HIPRI;
853
854         switch (bio_op(bio)) {
855         case REQ_OP_DISCARD:
856                 if (!blk_queue_discard(q))
857                         goto not_supported;
858                 break;
859         case REQ_OP_SECURE_ERASE:
860                 if (!blk_queue_secure_erase(q))
861                         goto not_supported;
862                 break;
863         case REQ_OP_WRITE_SAME:
864                 if (!q->limits.max_write_same_sectors)
865                         goto not_supported;
866                 break;
867         case REQ_OP_ZONE_APPEND:
868                 status = blk_check_zone_append(q, bio);
869                 if (status != BLK_STS_OK)
870                         goto end_io;
871                 break;
872         case REQ_OP_ZONE_RESET:
873         case REQ_OP_ZONE_OPEN:
874         case REQ_OP_ZONE_CLOSE:
875         case REQ_OP_ZONE_FINISH:
876                 if (!blk_queue_is_zoned(q))
877                         goto not_supported;
878                 break;
879         case REQ_OP_ZONE_RESET_ALL:
880                 if (!blk_queue_is_zoned(q) || !blk_queue_zone_resetall(q))
881                         goto not_supported;
882                 break;
883         case REQ_OP_WRITE_ZEROES:
884                 if (!q->limits.max_write_zeroes_sectors)
885                         goto not_supported;
886                 break;
887         default:
888                 break;
889         }
890
891         /*
892          * Various block parts want %current->io_context, so allocate it up
893          * front rather than dealing with lots of pain to allocate it only
894          * where needed. This may fail and the block layer knows how to live
895          * with it.
896          */
897         if (unlikely(!current->io_context))
898                 create_task_io_context(current, GFP_ATOMIC, q->node);
899
900         if (blk_throtl_bio(bio))
901                 return false;
902
903         blk_cgroup_bio_start(bio);
904         blkcg_bio_issue_init(bio);
905
906         if (!bio_flagged(bio, BIO_TRACE_COMPLETION)) {
907                 trace_block_bio_queue(q, bio);
908                 /* Now that enqueuing has been traced, we need to trace
909                  * completion as well.
910                  */
911                 bio_set_flag(bio, BIO_TRACE_COMPLETION);
912         }
913         return true;
914
915 not_supported:
916         status = BLK_STS_NOTSUPP;
917 end_io:
918         bio->bi_status = status;
919         bio_endio(bio);
920         return false;
921 }
922
923 static blk_qc_t __submit_bio(struct bio *bio)
924 {
925         struct gendisk *disk = bio->bi_disk;
926         blk_qc_t ret = BLK_QC_T_NONE;
927
928         if (blk_crypto_bio_prep(&bio)) {
929                 if (!disk->fops->submit_bio)
930                         return blk_mq_submit_bio(bio);
931                 ret = disk->fops->submit_bio(bio);
932         }
933         blk_queue_exit(disk->queue);
934         return ret;
935 }
936
937 /*
938  * The loop in this function may be a bit non-obvious, and so deserves some
939  * explanation:
940  *
941  *  - Before entering the loop, bio->bi_next is NULL (as all callers ensure
942  *    that), so we have a list with a single bio.
943  *  - We pretend that we have just taken it off a longer list, so we assign
944  *    bio_list to a pointer to the bio_list_on_stack, thus initialising the
945  *    bio_list of new bios to be added.  ->submit_bio() may indeed add some more
946  *    bios through a recursive call to submit_bio_noacct.  If it did, we find a
947  *    non-NULL value in bio_list and re-enter the loop from the top.
948  *  - In this case we really did just take the bio of the top of the list (no
949  *    pretending) and so remove it from bio_list, and call into ->submit_bio()
950  *    again.
951  *
952  * bio_list_on_stack[0] contains bios submitted by the current ->submit_bio.
953  * bio_list_on_stack[1] contains bios that were submitted before the current
954  *      ->submit_bio_bio, but that haven't been processed yet.
955  */
956 static blk_qc_t __submit_bio_noacct(struct bio *bio)
957 {
958         struct bio_list bio_list_on_stack[2];
959         blk_qc_t ret = BLK_QC_T_NONE;
960
961         BUG_ON(bio->bi_next);
962
963         bio_list_init(&bio_list_on_stack[0]);
964         current->bio_list = bio_list_on_stack;
965
966         do {
967                 struct request_queue *q = bio->bi_disk->queue;
968                 struct bio_list lower, same;
969
970                 if (unlikely(bio_queue_enter(bio) != 0))
971                         continue;
972
973                 /*
974                  * Create a fresh bio_list for all subordinate requests.
975                  */
976                 bio_list_on_stack[1] = bio_list_on_stack[0];
977                 bio_list_init(&bio_list_on_stack[0]);
978
979                 ret = __submit_bio(bio);
980
981                 /*
982                  * Sort new bios into those for a lower level and those for the
983                  * same level.
984                  */
985                 bio_list_init(&lower);
986                 bio_list_init(&same);
987                 while ((bio = bio_list_pop(&bio_list_on_stack[0])) != NULL)
988                         if (q == bio->bi_disk->queue)
989                                 bio_list_add(&same, bio);
990                         else
991                                 bio_list_add(&lower, bio);
992
993                 /*
994                  * Now assemble so we handle the lowest level first.
995                  */
996                 bio_list_merge(&bio_list_on_stack[0], &lower);
997                 bio_list_merge(&bio_list_on_stack[0], &same);
998                 bio_list_merge(&bio_list_on_stack[0], &bio_list_on_stack[1]);
999         } while ((bio = bio_list_pop(&bio_list_on_stack[0])));
1000
1001         current->bio_list = NULL;
1002         return ret;
1003 }
1004
1005 static blk_qc_t __submit_bio_noacct_mq(struct bio *bio)
1006 {
1007         struct bio_list bio_list[2] = { };
1008         blk_qc_t ret = BLK_QC_T_NONE;
1009
1010         current->bio_list = bio_list;
1011
1012         do {
1013                 struct gendisk *disk = bio->bi_disk;
1014
1015                 if (unlikely(bio_queue_enter(bio) != 0))
1016                         continue;
1017
1018                 if (!blk_crypto_bio_prep(&bio)) {
1019                         blk_queue_exit(disk->queue);
1020                         ret = BLK_QC_T_NONE;
1021                         continue;
1022                 }
1023
1024                 ret = blk_mq_submit_bio(bio);
1025         } while ((bio = bio_list_pop(&bio_list[0])));
1026
1027         current->bio_list = NULL;
1028         return ret;
1029 }
1030
1031 /**
1032  * submit_bio_noacct - re-submit a bio to the block device layer for I/O
1033  * @bio:  The bio describing the location in memory and on the device.
1034  *
1035  * This is a version of submit_bio() that shall only be used for I/O that is
1036  * resubmitted to lower level drivers by stacking block drivers.  All file
1037  * systems and other upper level users of the block layer should use
1038  * submit_bio() instead.
1039  */
1040 blk_qc_t submit_bio_noacct(struct bio *bio)
1041 {
1042         if (!submit_bio_checks(bio))
1043                 return BLK_QC_T_NONE;
1044
1045         /*
1046          * We only want one ->submit_bio to be active at a time, else stack
1047          * usage with stacked devices could be a problem.  Use current->bio_list
1048          * to collect a list of requests submited by a ->submit_bio method while
1049          * it is active, and then process them after it returned.
1050          */
1051         if (current->bio_list) {
1052                 bio_list_add(&current->bio_list[0], bio);
1053                 return BLK_QC_T_NONE;
1054         }
1055
1056         if (!bio->bi_disk->fops->submit_bio)
1057                 return __submit_bio_noacct_mq(bio);
1058         return __submit_bio_noacct(bio);
1059 }
1060 EXPORT_SYMBOL(submit_bio_noacct);
1061
1062 /**
1063  * submit_bio - submit a bio to the block device layer for I/O
1064  * @bio: The &struct bio which describes the I/O
1065  *
1066  * submit_bio() is used to submit I/O requests to block devices.  It is passed a
1067  * fully set up &struct bio that describes the I/O that needs to be done.  The
1068  * bio will be send to the device described by the bi_disk and bi_partno fields.
1069  *
1070  * The success/failure status of the request, along with notification of
1071  * completion, is delivered asynchronously through the ->bi_end_io() callback
1072  * in @bio.  The bio must NOT be touched by thecaller until ->bi_end_io() has
1073  * been called.
1074  */
1075 blk_qc_t submit_bio(struct bio *bio)
1076 {
1077         if (blkcg_punt_bio_submit(bio))
1078                 return BLK_QC_T_NONE;
1079
1080         /*
1081          * If it's a regular read/write or a barrier with data attached,
1082          * go through the normal accounting stuff before submission.
1083          */
1084         if (bio_has_data(bio)) {
1085                 unsigned int count;
1086
1087                 if (unlikely(bio_op(bio) == REQ_OP_WRITE_SAME))
1088                         count = queue_logical_block_size(bio->bi_disk->queue) >> 9;
1089                 else
1090                         count = bio_sectors(bio);
1091
1092                 if (op_is_write(bio_op(bio))) {
1093                         count_vm_events(PGPGOUT, count);
1094                 } else {
1095                         task_io_account_read(bio->bi_iter.bi_size);
1096                         count_vm_events(PGPGIN, count);
1097                 }
1098
1099                 if (unlikely(block_dump)) {
1100                         char b[BDEVNAME_SIZE];
1101                         printk(KERN_DEBUG "%s(%d): %s block %Lu on %s (%u sectors)\n",
1102                         current->comm, task_pid_nr(current),
1103                                 op_is_write(bio_op(bio)) ? "WRITE" : "READ",
1104                                 (unsigned long long)bio->bi_iter.bi_sector,
1105                                 bio_devname(bio, b), count);
1106                 }
1107         }
1108
1109         /*
1110          * If we're reading data that is part of the userspace workingset, count
1111          * submission time as memory stall.  When the device is congested, or
1112          * the submitting cgroup IO-throttled, submission can be a significant
1113          * part of overall IO time.
1114          */
1115         if (unlikely(bio_op(bio) == REQ_OP_READ &&
1116             bio_flagged(bio, BIO_WORKINGSET))) {
1117                 unsigned long pflags;
1118                 blk_qc_t ret;
1119
1120                 psi_memstall_enter(&pflags);
1121                 ret = submit_bio_noacct(bio);
1122                 psi_memstall_leave(&pflags);
1123
1124                 return ret;
1125         }
1126
1127         return submit_bio_noacct(bio);
1128 }
1129 EXPORT_SYMBOL(submit_bio);
1130
1131 /**
1132  * blk_cloned_rq_check_limits - Helper function to check a cloned request
1133  *                              for the new queue limits
1134  * @q:  the queue
1135  * @rq: the request being checked
1136  *
1137  * Description:
1138  *    @rq may have been made based on weaker limitations of upper-level queues
1139  *    in request stacking drivers, and it may violate the limitation of @q.
1140  *    Since the block layer and the underlying device driver trust @rq
1141  *    after it is inserted to @q, it should be checked against @q before
1142  *    the insertion using this generic function.
1143  *
1144  *    Request stacking drivers like request-based dm may change the queue
1145  *    limits when retrying requests on other queues. Those requests need
1146  *    to be checked against the new queue limits again during dispatch.
1147  */
1148 static blk_status_t blk_cloned_rq_check_limits(struct request_queue *q,
1149                                       struct request *rq)
1150 {
1151         unsigned int max_sectors = blk_queue_get_max_sectors(q, req_op(rq));
1152
1153         if (blk_rq_sectors(rq) > max_sectors) {
1154                 /*
1155                  * SCSI device does not have a good way to return if
1156                  * Write Same/Zero is actually supported. If a device rejects
1157                  * a non-read/write command (discard, write same,etc.) the
1158                  * low-level device driver will set the relevant queue limit to
1159                  * 0 to prevent blk-lib from issuing more of the offending
1160                  * operations. Commands queued prior to the queue limit being
1161                  * reset need to be completed with BLK_STS_NOTSUPP to avoid I/O
1162                  * errors being propagated to upper layers.
1163                  */
1164                 if (max_sectors == 0)
1165                         return BLK_STS_NOTSUPP;
1166
1167                 printk(KERN_ERR "%s: over max size limit. (%u > %u)\n",
1168                         __func__, blk_rq_sectors(rq), max_sectors);
1169                 return BLK_STS_IOERR;
1170         }
1171
1172         /*
1173          * queue's settings related to segment counting like q->bounce_pfn
1174          * may differ from that of other stacking queues.
1175          * Recalculate it to check the request correctly on this queue's
1176          * limitation.
1177          */
1178         rq->nr_phys_segments = blk_recalc_rq_segments(rq);
1179         if (rq->nr_phys_segments > queue_max_segments(q)) {
1180                 printk(KERN_ERR "%s: over max segments limit. (%hu > %hu)\n",
1181                         __func__, rq->nr_phys_segments, queue_max_segments(q));
1182                 return BLK_STS_IOERR;
1183         }
1184
1185         return BLK_STS_OK;
1186 }
1187
1188 /**
1189  * blk_insert_cloned_request - Helper for stacking drivers to submit a request
1190  * @q:  the queue to submit the request
1191  * @rq: the request being queued
1192  */
1193 blk_status_t blk_insert_cloned_request(struct request_queue *q, struct request *rq)
1194 {
1195         blk_status_t ret;
1196
1197         ret = blk_cloned_rq_check_limits(q, rq);
1198         if (ret != BLK_STS_OK)
1199                 return ret;
1200
1201         if (rq->rq_disk &&
1202             should_fail_request(&rq->rq_disk->part0, blk_rq_bytes(rq)))
1203                 return BLK_STS_IOERR;
1204
1205         if (blk_crypto_insert_cloned_request(rq))
1206                 return BLK_STS_IOERR;
1207
1208         if (blk_queue_io_stat(q))
1209                 blk_account_io_start(rq);
1210
1211         /*
1212          * Since we have a scheduler attached on the top device,
1213          * bypass a potential scheduler on the bottom device for
1214          * insert.
1215          */
1216         return blk_mq_request_issue_directly(rq, true);
1217 }
1218 EXPORT_SYMBOL_GPL(blk_insert_cloned_request);
1219
1220 /**
1221  * blk_rq_err_bytes - determine number of bytes till the next failure boundary
1222  * @rq: request to examine
1223  *
1224  * Description:
1225  *     A request could be merge of IOs which require different failure
1226  *     handling.  This function determines the number of bytes which
1227  *     can be failed from the beginning of the request without
1228  *     crossing into area which need to be retried further.
1229  *
1230  * Return:
1231  *     The number of bytes to fail.
1232  */
1233 unsigned int blk_rq_err_bytes(const struct request *rq)
1234 {
1235         unsigned int ff = rq->cmd_flags & REQ_FAILFAST_MASK;
1236         unsigned int bytes = 0;
1237         struct bio *bio;
1238
1239         if (!(rq->rq_flags & RQF_MIXED_MERGE))
1240                 return blk_rq_bytes(rq);
1241
1242         /*
1243          * Currently the only 'mixing' which can happen is between
1244          * different fastfail types.  We can safely fail portions
1245          * which have all the failfast bits that the first one has -
1246          * the ones which are at least as eager to fail as the first
1247          * one.
1248          */
1249         for (bio = rq->bio; bio; bio = bio->bi_next) {
1250                 if ((bio->bi_opf & ff) != ff)
1251                         break;
1252                 bytes += bio->bi_iter.bi_size;
1253         }
1254
1255         /* this could lead to infinite loop */
1256         BUG_ON(blk_rq_bytes(rq) && !bytes);
1257         return bytes;
1258 }
1259 EXPORT_SYMBOL_GPL(blk_rq_err_bytes);
1260
1261 static void update_io_ticks(struct hd_struct *part, unsigned long now, bool end)
1262 {
1263         unsigned long stamp;
1264 again:
1265         stamp = READ_ONCE(part->stamp);
1266         if (unlikely(stamp != now)) {
1267                 if (likely(cmpxchg(&part->stamp, stamp, now) == stamp))
1268                         __part_stat_add(part, io_ticks, end ? now - stamp : 1);
1269         }
1270         if (part->partno) {
1271                 part = &part_to_disk(part)->part0;
1272                 goto again;
1273         }
1274 }
1275
1276 static void blk_account_io_completion(struct request *req, unsigned int bytes)
1277 {
1278         if (req->part && blk_do_io_stat(req)) {
1279                 const int sgrp = op_stat_group(req_op(req));
1280                 struct hd_struct *part;
1281
1282                 part_stat_lock();
1283                 part = req->part;
1284                 part_stat_add(part, sectors[sgrp], bytes >> 9);
1285                 part_stat_unlock();
1286         }
1287 }
1288
1289 void blk_account_io_done(struct request *req, u64 now)
1290 {
1291         /*
1292          * Account IO completion.  flush_rq isn't accounted as a
1293          * normal IO on queueing nor completion.  Accounting the
1294          * containing request is enough.
1295          */
1296         if (req->part && blk_do_io_stat(req) &&
1297             !(req->rq_flags & RQF_FLUSH_SEQ)) {
1298                 const int sgrp = op_stat_group(req_op(req));
1299                 struct hd_struct *part;
1300
1301                 part_stat_lock();
1302                 part = req->part;
1303
1304                 update_io_ticks(part, jiffies, true);
1305                 part_stat_inc(part, ios[sgrp]);
1306                 part_stat_add(part, nsecs[sgrp], now - req->start_time_ns);
1307                 part_stat_unlock();
1308
1309                 hd_struct_put(part);
1310         }
1311 }
1312
1313 void blk_account_io_start(struct request *rq)
1314 {
1315         if (!blk_do_io_stat(rq))
1316                 return;
1317
1318         rq->part = disk_map_sector_rcu(rq->rq_disk, blk_rq_pos(rq));
1319
1320         part_stat_lock();
1321         update_io_ticks(rq->part, jiffies, false);
1322         part_stat_unlock();
1323 }
1324
1325 static unsigned long __part_start_io_acct(struct hd_struct *part,
1326                                           unsigned int sectors, unsigned int op)
1327 {
1328         const int sgrp = op_stat_group(op);
1329         unsigned long now = READ_ONCE(jiffies);
1330
1331         part_stat_lock();
1332         update_io_ticks(part, now, false);
1333         part_stat_inc(part, ios[sgrp]);
1334         part_stat_add(part, sectors[sgrp], sectors);
1335         part_stat_local_inc(part, in_flight[op_is_write(op)]);
1336         part_stat_unlock();
1337
1338         return now;
1339 }
1340
1341 unsigned long part_start_io_acct(struct gendisk *disk, struct hd_struct **part,
1342                                  struct bio *bio)
1343 {
1344         *part = disk_map_sector_rcu(disk, bio->bi_iter.bi_sector);
1345
1346         return __part_start_io_acct(*part, bio_sectors(bio), bio_op(bio));
1347 }
1348 EXPORT_SYMBOL_GPL(part_start_io_acct);
1349
1350 unsigned long disk_start_io_acct(struct gendisk *disk, unsigned int sectors,
1351                                  unsigned int op)
1352 {
1353         return __part_start_io_acct(&disk->part0, sectors, op);
1354 }
1355 EXPORT_SYMBOL(disk_start_io_acct);
1356
1357 static void __part_end_io_acct(struct hd_struct *part, unsigned int op,
1358                                unsigned long start_time)
1359 {
1360         const int sgrp = op_stat_group(op);
1361         unsigned long now = READ_ONCE(jiffies);
1362         unsigned long duration = now - start_time;
1363
1364         part_stat_lock();
1365         update_io_ticks(part, now, true);
1366         part_stat_add(part, nsecs[sgrp], jiffies_to_nsecs(duration));
1367         part_stat_local_dec(part, in_flight[op_is_write(op)]);
1368         part_stat_unlock();
1369 }
1370
1371 void part_end_io_acct(struct hd_struct *part, struct bio *bio,
1372                       unsigned long start_time)
1373 {
1374         __part_end_io_acct(part, bio_op(bio), start_time);
1375         hd_struct_put(part);
1376 }
1377 EXPORT_SYMBOL_GPL(part_end_io_acct);
1378
1379 void disk_end_io_acct(struct gendisk *disk, unsigned int op,
1380                       unsigned long start_time)
1381 {
1382         __part_end_io_acct(&disk->part0, op, start_time);
1383 }
1384 EXPORT_SYMBOL(disk_end_io_acct);
1385
1386 /*
1387  * Steal bios from a request and add them to a bio list.
1388  * The request must not have been partially completed before.
1389  */
1390 void blk_steal_bios(struct bio_list *list, struct request *rq)
1391 {
1392         if (rq->bio) {
1393                 if (list->tail)
1394                         list->tail->bi_next = rq->bio;
1395                 else
1396                         list->head = rq->bio;
1397                 list->tail = rq->biotail;
1398
1399                 rq->bio = NULL;
1400                 rq->biotail = NULL;
1401         }
1402
1403         rq->__data_len = 0;
1404 }
1405 EXPORT_SYMBOL_GPL(blk_steal_bios);
1406
1407 /**
1408  * blk_update_request - Special helper function for request stacking drivers
1409  * @req:      the request being processed
1410  * @error:    block status code
1411  * @nr_bytes: number of bytes to complete @req
1412  *
1413  * Description:
1414  *     Ends I/O on a number of bytes attached to @req, but doesn't complete
1415  *     the request structure even if @req doesn't have leftover.
1416  *     If @req has leftover, sets it up for the next range of segments.
1417  *
1418  *     This special helper function is only for request stacking drivers
1419  *     (e.g. request-based dm) so that they can handle partial completion.
1420  *     Actual device drivers should use blk_mq_end_request instead.
1421  *
1422  *     Passing the result of blk_rq_bytes() as @nr_bytes guarantees
1423  *     %false return from this function.
1424  *
1425  * Note:
1426  *      The RQF_SPECIAL_PAYLOAD flag is ignored on purpose in both
1427  *      blk_rq_bytes() and in blk_update_request().
1428  *
1429  * Return:
1430  *     %false - this request doesn't have any more data
1431  *     %true  - this request has more data
1432  **/
1433 bool blk_update_request(struct request *req, blk_status_t error,
1434                 unsigned int nr_bytes)
1435 {
1436         int total_bytes;
1437
1438         trace_block_rq_complete(req, blk_status_to_errno(error), nr_bytes);
1439
1440         if (!req->bio)
1441                 return false;
1442
1443 #ifdef CONFIG_BLK_DEV_INTEGRITY
1444         if (blk_integrity_rq(req) && req_op(req) == REQ_OP_READ &&
1445             error == BLK_STS_OK)
1446                 req->q->integrity.profile->complete_fn(req, nr_bytes);
1447 #endif
1448
1449         if (unlikely(error && !blk_rq_is_passthrough(req) &&
1450                      !(req->rq_flags & RQF_QUIET)))
1451                 print_req_error(req, error, __func__);
1452
1453         blk_account_io_completion(req, nr_bytes);
1454
1455         total_bytes = 0;
1456         while (req->bio) {
1457                 struct bio *bio = req->bio;
1458                 unsigned bio_bytes = min(bio->bi_iter.bi_size, nr_bytes);
1459
1460                 if (bio_bytes == bio->bi_iter.bi_size)
1461                         req->bio = bio->bi_next;
1462
1463                 /* Completion has already been traced */
1464                 bio_clear_flag(bio, BIO_TRACE_COMPLETION);
1465                 req_bio_endio(req, bio, bio_bytes, error);
1466
1467                 total_bytes += bio_bytes;
1468                 nr_bytes -= bio_bytes;
1469
1470                 if (!nr_bytes)
1471                         break;
1472         }
1473
1474         /*
1475          * completely done
1476          */
1477         if (!req->bio) {
1478                 /*
1479                  * Reset counters so that the request stacking driver
1480                  * can find how many bytes remain in the request
1481                  * later.
1482                  */
1483                 req->__data_len = 0;
1484                 return false;
1485         }
1486
1487         req->__data_len -= total_bytes;
1488
1489         /* update sector only for requests with clear definition of sector */
1490         if (!blk_rq_is_passthrough(req))
1491                 req->__sector += total_bytes >> 9;
1492
1493         /* mixed attributes always follow the first bio */
1494         if (req->rq_flags & RQF_MIXED_MERGE) {
1495                 req->cmd_flags &= ~REQ_FAILFAST_MASK;
1496                 req->cmd_flags |= req->bio->bi_opf & REQ_FAILFAST_MASK;
1497         }
1498
1499         if (!(req->rq_flags & RQF_SPECIAL_PAYLOAD)) {
1500                 /*
1501                  * If total number of sectors is less than the first segment
1502                  * size, something has gone terribly wrong.
1503                  */
1504                 if (blk_rq_bytes(req) < blk_rq_cur_bytes(req)) {
1505                         blk_dump_rq_flags(req, "request botched");
1506                         req->__data_len = blk_rq_cur_bytes(req);
1507                 }
1508
1509                 /* recalculate the number of segments */
1510                 req->nr_phys_segments = blk_recalc_rq_segments(req);
1511         }
1512
1513         return true;
1514 }
1515 EXPORT_SYMBOL_GPL(blk_update_request);
1516
1517 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
1518 /**
1519  * rq_flush_dcache_pages - Helper function to flush all pages in a request
1520  * @rq: the request to be flushed
1521  *
1522  * Description:
1523  *     Flush all pages in @rq.
1524  */
1525 void rq_flush_dcache_pages(struct request *rq)
1526 {
1527         struct req_iterator iter;
1528         struct bio_vec bvec;
1529
1530         rq_for_each_segment(bvec, rq, iter)
1531                 flush_dcache_page(bvec.bv_page);
1532 }
1533 EXPORT_SYMBOL_GPL(rq_flush_dcache_pages);
1534 #endif
1535
1536 /**
1537  * blk_lld_busy - Check if underlying low-level drivers of a device are busy
1538  * @q : the queue of the device being checked
1539  *
1540  * Description:
1541  *    Check if underlying low-level drivers of a device are busy.
1542  *    If the drivers want to export their busy state, they must set own
1543  *    exporting function using blk_queue_lld_busy() first.
1544  *
1545  *    Basically, this function is used only by request stacking drivers
1546  *    to stop dispatching requests to underlying devices when underlying
1547  *    devices are busy.  This behavior helps more I/O merging on the queue
1548  *    of the request stacking driver and prevents I/O throughput regression
1549  *    on burst I/O load.
1550  *
1551  * Return:
1552  *    0 - Not busy (The request stacking driver should dispatch request)
1553  *    1 - Busy (The request stacking driver should stop dispatching request)
1554  */
1555 int blk_lld_busy(struct request_queue *q)
1556 {
1557         if (queue_is_mq(q) && q->mq_ops->busy)
1558                 return q->mq_ops->busy(q);
1559
1560         return 0;
1561 }
1562 EXPORT_SYMBOL_GPL(blk_lld_busy);
1563
1564 /**
1565  * blk_rq_unprep_clone - Helper function to free all bios in a cloned request
1566  * @rq: the clone request to be cleaned up
1567  *
1568  * Description:
1569  *     Free all bios in @rq for a cloned request.
1570  */
1571 void blk_rq_unprep_clone(struct request *rq)
1572 {
1573         struct bio *bio;
1574
1575         while ((bio = rq->bio) != NULL) {
1576                 rq->bio = bio->bi_next;
1577
1578                 bio_put(bio);
1579         }
1580 }
1581 EXPORT_SYMBOL_GPL(blk_rq_unprep_clone);
1582
1583 /**
1584  * blk_rq_prep_clone - Helper function to setup clone request
1585  * @rq: the request to be setup
1586  * @rq_src: original request to be cloned
1587  * @bs: bio_set that bios for clone are allocated from
1588  * @gfp_mask: memory allocation mask for bio
1589  * @bio_ctr: setup function to be called for each clone bio.
1590  *           Returns %0 for success, non %0 for failure.
1591  * @data: private data to be passed to @bio_ctr
1592  *
1593  * Description:
1594  *     Clones bios in @rq_src to @rq, and copies attributes of @rq_src to @rq.
1595  *     Also, pages which the original bios are pointing to are not copied
1596  *     and the cloned bios just point same pages.
1597  *     So cloned bios must be completed before original bios, which means
1598  *     the caller must complete @rq before @rq_src.
1599  */
1600 int blk_rq_prep_clone(struct request *rq, struct request *rq_src,
1601                       struct bio_set *bs, gfp_t gfp_mask,
1602                       int (*bio_ctr)(struct bio *, struct bio *, void *),
1603                       void *data)
1604 {
1605         struct bio *bio, *bio_src;
1606
1607         if (!bs)
1608                 bs = &fs_bio_set;
1609
1610         __rq_for_each_bio(bio_src, rq_src) {
1611                 bio = bio_clone_fast(bio_src, gfp_mask, bs);
1612                 if (!bio)
1613                         goto free_and_out;
1614
1615                 if (bio_ctr && bio_ctr(bio, bio_src, data))
1616                         goto free_and_out;
1617
1618                 if (rq->bio) {
1619                         rq->biotail->bi_next = bio;
1620                         rq->biotail = bio;
1621                 } else {
1622                         rq->bio = rq->biotail = bio;
1623                 }
1624                 bio = NULL;
1625         }
1626
1627         /* Copy attributes of the original request to the clone request. */
1628         rq->__sector = blk_rq_pos(rq_src);
1629         rq->__data_len = blk_rq_bytes(rq_src);
1630         if (rq_src->rq_flags & RQF_SPECIAL_PAYLOAD) {
1631                 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
1632                 rq->special_vec = rq_src->special_vec;
1633         }
1634         rq->nr_phys_segments = rq_src->nr_phys_segments;
1635         rq->ioprio = rq_src->ioprio;
1636
1637         if (rq->bio && blk_crypto_rq_bio_prep(rq, rq->bio, gfp_mask) < 0)
1638                 goto free_and_out;
1639
1640         return 0;
1641
1642 free_and_out:
1643         if (bio)
1644                 bio_put(bio);
1645         blk_rq_unprep_clone(rq);
1646
1647         return -ENOMEM;
1648 }
1649 EXPORT_SYMBOL_GPL(blk_rq_prep_clone);
1650
1651 int kblockd_schedule_work(struct work_struct *work)
1652 {
1653         return queue_work(kblockd_workqueue, work);
1654 }
1655 EXPORT_SYMBOL(kblockd_schedule_work);
1656
1657 int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork,
1658                                 unsigned long delay)
1659 {
1660         return mod_delayed_work_on(cpu, kblockd_workqueue, dwork, delay);
1661 }
1662 EXPORT_SYMBOL(kblockd_mod_delayed_work_on);
1663
1664 /**
1665  * blk_start_plug - initialize blk_plug and track it inside the task_struct
1666  * @plug:       The &struct blk_plug that needs to be initialized
1667  *
1668  * Description:
1669  *   blk_start_plug() indicates to the block layer an intent by the caller
1670  *   to submit multiple I/O requests in a batch.  The block layer may use
1671  *   this hint to defer submitting I/Os from the caller until blk_finish_plug()
1672  *   is called.  However, the block layer may choose to submit requests
1673  *   before a call to blk_finish_plug() if the number of queued I/Os
1674  *   exceeds %BLK_MAX_REQUEST_COUNT, or if the size of the I/O is larger than
1675  *   %BLK_PLUG_FLUSH_SIZE.  The queued I/Os may also be submitted early if
1676  *   the task schedules (see below).
1677  *
1678  *   Tracking blk_plug inside the task_struct will help with auto-flushing the
1679  *   pending I/O should the task end up blocking between blk_start_plug() and
1680  *   blk_finish_plug(). This is important from a performance perspective, but
1681  *   also ensures that we don't deadlock. For instance, if the task is blocking
1682  *   for a memory allocation, memory reclaim could end up wanting to free a
1683  *   page belonging to that request that is currently residing in our private
1684  *   plug. By flushing the pending I/O when the process goes to sleep, we avoid
1685  *   this kind of deadlock.
1686  */
1687 void blk_start_plug(struct blk_plug *plug)
1688 {
1689         struct task_struct *tsk = current;
1690
1691         /*
1692          * If this is a nested plug, don't actually assign it.
1693          */
1694         if (tsk->plug)
1695                 return;
1696
1697         INIT_LIST_HEAD(&plug->mq_list);
1698         INIT_LIST_HEAD(&plug->cb_list);
1699         plug->rq_count = 0;
1700         plug->multiple_queues = false;
1701         plug->nowait = false;
1702
1703         /*
1704          * Store ordering should not be needed here, since a potential
1705          * preempt will imply a full memory barrier
1706          */
1707         tsk->plug = plug;
1708 }
1709 EXPORT_SYMBOL(blk_start_plug);
1710
1711 static void flush_plug_callbacks(struct blk_plug *plug, bool from_schedule)
1712 {
1713         LIST_HEAD(callbacks);
1714
1715         while (!list_empty(&plug->cb_list)) {
1716                 list_splice_init(&plug->cb_list, &callbacks);
1717
1718                 while (!list_empty(&callbacks)) {
1719                         struct blk_plug_cb *cb = list_first_entry(&callbacks,
1720                                                           struct blk_plug_cb,
1721                                                           list);
1722                         list_del(&cb->list);
1723                         cb->callback(cb, from_schedule);
1724                 }
1725         }
1726 }
1727
1728 struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug, void *data,
1729                                       int size)
1730 {
1731         struct blk_plug *plug = current->plug;
1732         struct blk_plug_cb *cb;
1733
1734         if (!plug)
1735                 return NULL;
1736
1737         list_for_each_entry(cb, &plug->cb_list, list)
1738                 if (cb->callback == unplug && cb->data == data)
1739                         return cb;
1740
1741         /* Not currently on the callback list */
1742         BUG_ON(size < sizeof(*cb));
1743         cb = kzalloc(size, GFP_ATOMIC);
1744         if (cb) {
1745                 cb->data = data;
1746                 cb->callback = unplug;
1747                 list_add(&cb->list, &plug->cb_list);
1748         }
1749         return cb;
1750 }
1751 EXPORT_SYMBOL(blk_check_plugged);
1752
1753 void blk_flush_plug_list(struct blk_plug *plug, bool from_schedule)
1754 {
1755         flush_plug_callbacks(plug, from_schedule);
1756
1757         if (!list_empty(&plug->mq_list))
1758                 blk_mq_flush_plug_list(plug, from_schedule);
1759 }
1760
1761 /**
1762  * blk_finish_plug - mark the end of a batch of submitted I/O
1763  * @plug:       The &struct blk_plug passed to blk_start_plug()
1764  *
1765  * Description:
1766  * Indicate that a batch of I/O submissions is complete.  This function
1767  * must be paired with an initial call to blk_start_plug().  The intent
1768  * is to allow the block layer to optimize I/O submission.  See the
1769  * documentation for blk_start_plug() for more information.
1770  */
1771 void blk_finish_plug(struct blk_plug *plug)
1772 {
1773         if (plug != current->plug)
1774                 return;
1775         blk_flush_plug_list(plug, false);
1776
1777         current->plug = NULL;
1778 }
1779 EXPORT_SYMBOL(blk_finish_plug);
1780
1781 void blk_io_schedule(void)
1782 {
1783         /* Prevent hang_check timer from firing at us during very long I/O */
1784         unsigned long timeout = sysctl_hung_task_timeout_secs * HZ / 2;
1785
1786         if (timeout)
1787                 io_schedule_timeout(timeout);
1788         else
1789                 io_schedule();
1790 }
1791 EXPORT_SYMBOL_GPL(blk_io_schedule);
1792
1793 int __init blk_dev_init(void)
1794 {
1795         BUILD_BUG_ON(REQ_OP_LAST >= (1 << REQ_OP_BITS));
1796         BUILD_BUG_ON(REQ_OP_BITS + REQ_FLAG_BITS > 8 *
1797                         sizeof_field(struct request, cmd_flags));
1798         BUILD_BUG_ON(REQ_OP_BITS + REQ_FLAG_BITS > 8 *
1799                         sizeof_field(struct bio, bi_opf));
1800
1801         /* used for unplugging and affects IO latency/throughput - HIGHPRI */
1802         kblockd_workqueue = alloc_workqueue("kblockd",
1803                                             WQ_MEM_RECLAIM | WQ_HIGHPRI, 0);
1804         if (!kblockd_workqueue)
1805                 panic("Failed to create kblockd\n");
1806
1807         blk_requestq_cachep = kmem_cache_create("request_queue",
1808                         sizeof(struct request_queue), 0, SLAB_PANIC, NULL);
1809
1810         blk_debugfs_root = debugfs_create_dir("block", NULL);
1811
1812         return 0;
1813 }