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