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