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