block: pass no-op callback to INIT_WORK().
[platform/kernel/linux-rpi.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-rq-qos.h"
46
47 #ifdef CONFIG_DEBUG_FS
48 struct dentry *blk_debugfs_root;
49 #endif
50
51 EXPORT_TRACEPOINT_SYMBOL_GPL(block_bio_remap);
52 EXPORT_TRACEPOINT_SYMBOL_GPL(block_rq_remap);
53 EXPORT_TRACEPOINT_SYMBOL_GPL(block_bio_complete);
54 EXPORT_TRACEPOINT_SYMBOL_GPL(block_split);
55 EXPORT_TRACEPOINT_SYMBOL_GPL(block_unplug);
56
57 DEFINE_IDA(blk_queue_ida);
58
59 /*
60  * For the allocated request tables
61  */
62 struct kmem_cache *request_cachep;
63
64 /*
65  * For queue allocation
66  */
67 struct kmem_cache *blk_requestq_cachep;
68
69 /*
70  * Controlling structure to kblockd
71  */
72 static struct workqueue_struct *kblockd_workqueue;
73
74 /**
75  * blk_queue_flag_set - atomically set a queue flag
76  * @flag: flag to be set
77  * @q: request queue
78  */
79 void blk_queue_flag_set(unsigned int flag, struct request_queue *q)
80 {
81         unsigned long flags;
82
83         spin_lock_irqsave(q->queue_lock, flags);
84         queue_flag_set(flag, q);
85         spin_unlock_irqrestore(q->queue_lock, flags);
86 }
87 EXPORT_SYMBOL(blk_queue_flag_set);
88
89 /**
90  * blk_queue_flag_clear - atomically clear a queue flag
91  * @flag: flag to be cleared
92  * @q: request queue
93  */
94 void blk_queue_flag_clear(unsigned int flag, struct request_queue *q)
95 {
96         unsigned long flags;
97
98         spin_lock_irqsave(q->queue_lock, flags);
99         queue_flag_clear(flag, q);
100         spin_unlock_irqrestore(q->queue_lock, flags);
101 }
102 EXPORT_SYMBOL(blk_queue_flag_clear);
103
104 /**
105  * blk_queue_flag_test_and_set - atomically test and set a queue flag
106  * @flag: flag to be set
107  * @q: request queue
108  *
109  * Returns the previous value of @flag - 0 if the flag was not set and 1 if
110  * the flag was already set.
111  */
112 bool blk_queue_flag_test_and_set(unsigned int flag, struct request_queue *q)
113 {
114         unsigned long flags;
115         bool res;
116
117         spin_lock_irqsave(q->queue_lock, flags);
118         res = queue_flag_test_and_set(flag, q);
119         spin_unlock_irqrestore(q->queue_lock, flags);
120
121         return res;
122 }
123 EXPORT_SYMBOL_GPL(blk_queue_flag_test_and_set);
124
125 /**
126  * blk_queue_flag_test_and_clear - atomically test and clear a queue flag
127  * @flag: flag to be cleared
128  * @q: request queue
129  *
130  * Returns the previous value of @flag - 0 if the flag was not set and 1 if
131  * the flag was set.
132  */
133 bool blk_queue_flag_test_and_clear(unsigned int flag, struct request_queue *q)
134 {
135         unsigned long flags;
136         bool res;
137
138         spin_lock_irqsave(q->queue_lock, flags);
139         res = queue_flag_test_and_clear(flag, q);
140         spin_unlock_irqrestore(q->queue_lock, flags);
141
142         return res;
143 }
144 EXPORT_SYMBOL_GPL(blk_queue_flag_test_and_clear);
145
146 static void blk_clear_congested(struct request_list *rl, int sync)
147 {
148 #ifdef CONFIG_CGROUP_WRITEBACK
149         clear_wb_congested(rl->blkg->wb_congested, sync);
150 #else
151         /*
152          * If !CGROUP_WRITEBACK, all blkg's map to bdi->wb and we shouldn't
153          * flip its congestion state for events on other blkcgs.
154          */
155         if (rl == &rl->q->root_rl)
156                 clear_wb_congested(rl->q->backing_dev_info->wb.congested, sync);
157 #endif
158 }
159
160 static void blk_set_congested(struct request_list *rl, int sync)
161 {
162 #ifdef CONFIG_CGROUP_WRITEBACK
163         set_wb_congested(rl->blkg->wb_congested, sync);
164 #else
165         /* see blk_clear_congested() */
166         if (rl == &rl->q->root_rl)
167                 set_wb_congested(rl->q->backing_dev_info->wb.congested, sync);
168 #endif
169 }
170
171 void blk_queue_congestion_threshold(struct request_queue *q)
172 {
173         int nr;
174
175         nr = q->nr_requests - (q->nr_requests / 8) + 1;
176         if (nr > q->nr_requests)
177                 nr = q->nr_requests;
178         q->nr_congestion_on = nr;
179
180         nr = q->nr_requests - (q->nr_requests / 8) - (q->nr_requests / 16) - 1;
181         if (nr < 1)
182                 nr = 1;
183         q->nr_congestion_off = nr;
184 }
185
186 void blk_rq_init(struct request_queue *q, struct request *rq)
187 {
188         memset(rq, 0, sizeof(*rq));
189
190         INIT_LIST_HEAD(&rq->queuelist);
191         INIT_LIST_HEAD(&rq->timeout_list);
192         rq->cpu = -1;
193         rq->q = q;
194         rq->__sector = (sector_t) -1;
195         INIT_HLIST_NODE(&rq->hash);
196         RB_CLEAR_NODE(&rq->rb_node);
197         rq->tag = -1;
198         rq->internal_tag = -1;
199         rq->start_time_ns = ktime_get_ns();
200         rq->part = NULL;
201 }
202 EXPORT_SYMBOL(blk_rq_init);
203
204 static const struct {
205         int             errno;
206         const char      *name;
207 } blk_errors[] = {
208         [BLK_STS_OK]            = { 0,          "" },
209         [BLK_STS_NOTSUPP]       = { -EOPNOTSUPP, "operation not supported" },
210         [BLK_STS_TIMEOUT]       = { -ETIMEDOUT, "timeout" },
211         [BLK_STS_NOSPC]         = { -ENOSPC,    "critical space allocation" },
212         [BLK_STS_TRANSPORT]     = { -ENOLINK,   "recoverable transport" },
213         [BLK_STS_TARGET]        = { -EREMOTEIO, "critical target" },
214         [BLK_STS_NEXUS]         = { -EBADE,     "critical nexus" },
215         [BLK_STS_MEDIUM]        = { -ENODATA,   "critical medium" },
216         [BLK_STS_PROTECTION]    = { -EILSEQ,    "protection" },
217         [BLK_STS_RESOURCE]      = { -ENOMEM,    "kernel resource" },
218         [BLK_STS_DEV_RESOURCE]  = { -EBUSY,     "device resource" },
219         [BLK_STS_AGAIN]         = { -EAGAIN,    "nonblocking retry" },
220
221         /* device mapper special case, should not leak out: */
222         [BLK_STS_DM_REQUEUE]    = { -EREMCHG, "dm internal retry" },
223
224         /* everything else not covered above: */
225         [BLK_STS_IOERR]         = { -EIO,       "I/O" },
226 };
227
228 blk_status_t errno_to_blk_status(int errno)
229 {
230         int i;
231
232         for (i = 0; i < ARRAY_SIZE(blk_errors); i++) {
233                 if (blk_errors[i].errno == errno)
234                         return (__force blk_status_t)i;
235         }
236
237         return BLK_STS_IOERR;
238 }
239 EXPORT_SYMBOL_GPL(errno_to_blk_status);
240
241 int blk_status_to_errno(blk_status_t status)
242 {
243         int idx = (__force int)status;
244
245         if (WARN_ON_ONCE(idx >= ARRAY_SIZE(blk_errors)))
246                 return -EIO;
247         return blk_errors[idx].errno;
248 }
249 EXPORT_SYMBOL_GPL(blk_status_to_errno);
250
251 static void print_req_error(struct request *req, blk_status_t status)
252 {
253         int idx = (__force int)status;
254
255         if (WARN_ON_ONCE(idx >= ARRAY_SIZE(blk_errors)))
256                 return;
257
258         printk_ratelimited(KERN_ERR "%s: %s error, dev %s, sector %llu\n",
259                            __func__, blk_errors[idx].name, req->rq_disk ?
260                            req->rq_disk->disk_name : "?",
261                            (unsigned long long)blk_rq_pos(req));
262 }
263
264 static void req_bio_endio(struct request *rq, struct bio *bio,
265                           unsigned int nbytes, blk_status_t error)
266 {
267         if (error)
268                 bio->bi_status = error;
269
270         if (unlikely(rq->rq_flags & RQF_QUIET))
271                 bio_set_flag(bio, BIO_QUIET);
272
273         bio_advance(bio, nbytes);
274
275         /* don't actually finish bio if it's part of flush sequence */
276         if (bio->bi_iter.bi_size == 0 && !(rq->rq_flags & RQF_FLUSH_SEQ))
277                 bio_endio(bio);
278 }
279
280 void blk_dump_rq_flags(struct request *rq, char *msg)
281 {
282         printk(KERN_INFO "%s: dev %s: flags=%llx\n", msg,
283                 rq->rq_disk ? rq->rq_disk->disk_name : "?",
284                 (unsigned long long) rq->cmd_flags);
285
286         printk(KERN_INFO "  sector %llu, nr/cnr %u/%u\n",
287                (unsigned long long)blk_rq_pos(rq),
288                blk_rq_sectors(rq), blk_rq_cur_sectors(rq));
289         printk(KERN_INFO "  bio %p, biotail %p, len %u\n",
290                rq->bio, rq->biotail, blk_rq_bytes(rq));
291 }
292 EXPORT_SYMBOL(blk_dump_rq_flags);
293
294 static void blk_delay_work(struct work_struct *work)
295 {
296         struct request_queue *q;
297
298         q = container_of(work, struct request_queue, delay_work.work);
299         spin_lock_irq(q->queue_lock);
300         __blk_run_queue(q);
301         spin_unlock_irq(q->queue_lock);
302 }
303
304 /**
305  * blk_delay_queue - restart queueing after defined interval
306  * @q:          The &struct request_queue in question
307  * @msecs:      Delay in msecs
308  *
309  * Description:
310  *   Sometimes queueing needs to be postponed for a little while, to allow
311  *   resources to come back. This function will make sure that queueing is
312  *   restarted around the specified time.
313  */
314 void blk_delay_queue(struct request_queue *q, unsigned long msecs)
315 {
316         lockdep_assert_held(q->queue_lock);
317         WARN_ON_ONCE(q->mq_ops);
318
319         if (likely(!blk_queue_dead(q)))
320                 queue_delayed_work(kblockd_workqueue, &q->delay_work,
321                                    msecs_to_jiffies(msecs));
322 }
323 EXPORT_SYMBOL(blk_delay_queue);
324
325 /**
326  * blk_start_queue_async - asynchronously restart a previously stopped queue
327  * @q:    The &struct request_queue in question
328  *
329  * Description:
330  *   blk_start_queue_async() will clear the stop flag on the queue, and
331  *   ensure that the request_fn for the queue is run from an async
332  *   context.
333  **/
334 void blk_start_queue_async(struct request_queue *q)
335 {
336         lockdep_assert_held(q->queue_lock);
337         WARN_ON_ONCE(q->mq_ops);
338
339         queue_flag_clear(QUEUE_FLAG_STOPPED, q);
340         blk_run_queue_async(q);
341 }
342 EXPORT_SYMBOL(blk_start_queue_async);
343
344 /**
345  * blk_start_queue - restart a previously stopped queue
346  * @q:    The &struct request_queue in question
347  *
348  * Description:
349  *   blk_start_queue() will clear the stop flag on the queue, and call
350  *   the request_fn for the queue if it was in a stopped state when
351  *   entered. Also see blk_stop_queue().
352  **/
353 void blk_start_queue(struct request_queue *q)
354 {
355         lockdep_assert_held(q->queue_lock);
356         WARN_ON_ONCE(q->mq_ops);
357
358         queue_flag_clear(QUEUE_FLAG_STOPPED, q);
359         __blk_run_queue(q);
360 }
361 EXPORT_SYMBOL(blk_start_queue);
362
363 /**
364  * blk_stop_queue - stop a queue
365  * @q:    The &struct request_queue in question
366  *
367  * Description:
368  *   The Linux block layer assumes that a block driver will consume all
369  *   entries on the request queue when the request_fn strategy is called.
370  *   Often this will not happen, because of hardware limitations (queue
371  *   depth settings). If a device driver gets a 'queue full' response,
372  *   or if it simply chooses not to queue more I/O at one point, it can
373  *   call this function to prevent the request_fn from being called until
374  *   the driver has signalled it's ready to go again. This happens by calling
375  *   blk_start_queue() to restart queue operations.
376  **/
377 void blk_stop_queue(struct request_queue *q)
378 {
379         lockdep_assert_held(q->queue_lock);
380         WARN_ON_ONCE(q->mq_ops);
381
382         cancel_delayed_work(&q->delay_work);
383         queue_flag_set(QUEUE_FLAG_STOPPED, q);
384 }
385 EXPORT_SYMBOL(blk_stop_queue);
386
387 /**
388  * blk_sync_queue - cancel any pending callbacks on a queue
389  * @q: the queue
390  *
391  * Description:
392  *     The block layer may perform asynchronous callback activity
393  *     on a queue, such as calling the unplug function after a timeout.
394  *     A block device may call blk_sync_queue to ensure that any
395  *     such activity is cancelled, thus allowing it to release resources
396  *     that the callbacks might use. The caller must already have made sure
397  *     that its ->make_request_fn will not re-add plugging prior to calling
398  *     this function.
399  *
400  *     This function does not cancel any asynchronous activity arising
401  *     out of elevator or throttling code. That would require elevator_exit()
402  *     and blkcg_exit_queue() to be called with queue lock initialized.
403  *
404  */
405 void blk_sync_queue(struct request_queue *q)
406 {
407         del_timer_sync(&q->timeout);
408         cancel_work_sync(&q->timeout_work);
409
410         if (q->mq_ops) {
411                 struct blk_mq_hw_ctx *hctx;
412                 int i;
413
414                 cancel_delayed_work_sync(&q->requeue_work);
415                 queue_for_each_hw_ctx(q, hctx, i)
416                         cancel_delayed_work_sync(&hctx->run_work);
417         } else {
418                 cancel_delayed_work_sync(&q->delay_work);
419         }
420 }
421 EXPORT_SYMBOL(blk_sync_queue);
422
423 /**
424  * blk_set_preempt_only - set QUEUE_FLAG_PREEMPT_ONLY
425  * @q: request queue pointer
426  *
427  * Returns the previous value of the PREEMPT_ONLY flag - 0 if the flag was not
428  * set and 1 if the flag was already set.
429  */
430 int blk_set_preempt_only(struct request_queue *q)
431 {
432         return blk_queue_flag_test_and_set(QUEUE_FLAG_PREEMPT_ONLY, q);
433 }
434 EXPORT_SYMBOL_GPL(blk_set_preempt_only);
435
436 void blk_clear_preempt_only(struct request_queue *q)
437 {
438         blk_queue_flag_clear(QUEUE_FLAG_PREEMPT_ONLY, q);
439         wake_up_all(&q->mq_freeze_wq);
440 }
441 EXPORT_SYMBOL_GPL(blk_clear_preempt_only);
442
443 /**
444  * __blk_run_queue_uncond - run a queue whether or not it has been stopped
445  * @q:  The queue to run
446  *
447  * Description:
448  *    Invoke request handling on a queue if there are any pending requests.
449  *    May be used to restart request handling after a request has completed.
450  *    This variant runs the queue whether or not the queue has been
451  *    stopped. Must be called with the queue lock held and interrupts
452  *    disabled. See also @blk_run_queue.
453  */
454 inline void __blk_run_queue_uncond(struct request_queue *q)
455 {
456         lockdep_assert_held(q->queue_lock);
457         WARN_ON_ONCE(q->mq_ops);
458
459         if (unlikely(blk_queue_dead(q)))
460                 return;
461
462         /*
463          * Some request_fn implementations, e.g. scsi_request_fn(), unlock
464          * the queue lock internally. As a result multiple threads may be
465          * running such a request function concurrently. Keep track of the
466          * number of active request_fn invocations such that blk_drain_queue()
467          * can wait until all these request_fn calls have finished.
468          */
469         q->request_fn_active++;
470         q->request_fn(q);
471         q->request_fn_active--;
472 }
473 EXPORT_SYMBOL_GPL(__blk_run_queue_uncond);
474
475 /**
476  * __blk_run_queue - run a single device queue
477  * @q:  The queue to run
478  *
479  * Description:
480  *    See @blk_run_queue.
481  */
482 void __blk_run_queue(struct request_queue *q)
483 {
484         lockdep_assert_held(q->queue_lock);
485         WARN_ON_ONCE(q->mq_ops);
486
487         if (unlikely(blk_queue_stopped(q)))
488                 return;
489
490         __blk_run_queue_uncond(q);
491 }
492 EXPORT_SYMBOL(__blk_run_queue);
493
494 /**
495  * blk_run_queue_async - run a single device queue in workqueue context
496  * @q:  The queue to run
497  *
498  * Description:
499  *    Tells kblockd to perform the equivalent of @blk_run_queue on behalf
500  *    of us.
501  *
502  * Note:
503  *    Since it is not allowed to run q->delay_work after blk_cleanup_queue()
504  *    has canceled q->delay_work, callers must hold the queue lock to avoid
505  *    race conditions between blk_cleanup_queue() and blk_run_queue_async().
506  */
507 void blk_run_queue_async(struct request_queue *q)
508 {
509         lockdep_assert_held(q->queue_lock);
510         WARN_ON_ONCE(q->mq_ops);
511
512         if (likely(!blk_queue_stopped(q) && !blk_queue_dead(q)))
513                 mod_delayed_work(kblockd_workqueue, &q->delay_work, 0);
514 }
515 EXPORT_SYMBOL(blk_run_queue_async);
516
517 /**
518  * blk_run_queue - run a single device queue
519  * @q: The queue to run
520  *
521  * Description:
522  *    Invoke request handling on this queue, if it has pending work to do.
523  *    May be used to restart queueing when a request has completed.
524  */
525 void blk_run_queue(struct request_queue *q)
526 {
527         unsigned long flags;
528
529         WARN_ON_ONCE(q->mq_ops);
530
531         spin_lock_irqsave(q->queue_lock, flags);
532         __blk_run_queue(q);
533         spin_unlock_irqrestore(q->queue_lock, flags);
534 }
535 EXPORT_SYMBOL(blk_run_queue);
536
537 void blk_put_queue(struct request_queue *q)
538 {
539         kobject_put(&q->kobj);
540 }
541 EXPORT_SYMBOL(blk_put_queue);
542
543 /**
544  * __blk_drain_queue - drain requests from request_queue
545  * @q: queue to drain
546  * @drain_all: whether to drain all requests or only the ones w/ ELVPRIV
547  *
548  * Drain requests from @q.  If @drain_all is set, all requests are drained.
549  * If not, only ELVPRIV requests are drained.  The caller is responsible
550  * for ensuring that no new requests which need to be drained are queued.
551  */
552 static void __blk_drain_queue(struct request_queue *q, bool drain_all)
553         __releases(q->queue_lock)
554         __acquires(q->queue_lock)
555 {
556         int i;
557
558         lockdep_assert_held(q->queue_lock);
559         WARN_ON_ONCE(q->mq_ops);
560
561         while (true) {
562                 bool drain = false;
563
564                 /*
565                  * The caller might be trying to drain @q before its
566                  * elevator is initialized.
567                  */
568                 if (q->elevator)
569                         elv_drain_elevator(q);
570
571                 blkcg_drain_queue(q);
572
573                 /*
574                  * This function might be called on a queue which failed
575                  * driver init after queue creation or is not yet fully
576                  * active yet.  Some drivers (e.g. fd and loop) get unhappy
577                  * in such cases.  Kick queue iff dispatch queue has
578                  * something on it and @q has request_fn set.
579                  */
580                 if (!list_empty(&q->queue_head) && q->request_fn)
581                         __blk_run_queue(q);
582
583                 drain |= q->nr_rqs_elvpriv;
584                 drain |= q->request_fn_active;
585
586                 /*
587                  * Unfortunately, requests are queued at and tracked from
588                  * multiple places and there's no single counter which can
589                  * be drained.  Check all the queues and counters.
590                  */
591                 if (drain_all) {
592                         struct blk_flush_queue *fq = blk_get_flush_queue(q, NULL);
593                         drain |= !list_empty(&q->queue_head);
594                         for (i = 0; i < 2; i++) {
595                                 drain |= q->nr_rqs[i];
596                                 drain |= q->in_flight[i];
597                                 if (fq)
598                                     drain |= !list_empty(&fq->flush_queue[i]);
599                         }
600                 }
601
602                 if (!drain)
603                         break;
604
605                 spin_unlock_irq(q->queue_lock);
606
607                 msleep(10);
608
609                 spin_lock_irq(q->queue_lock);
610         }
611
612         /*
613          * With queue marked dead, any woken up waiter will fail the
614          * allocation path, so the wakeup chaining is lost and we're
615          * left with hung waiters. We need to wake up those waiters.
616          */
617         if (q->request_fn) {
618                 struct request_list *rl;
619
620                 blk_queue_for_each_rl(rl, q)
621                         for (i = 0; i < ARRAY_SIZE(rl->wait); i++)
622                                 wake_up_all(&rl->wait[i]);
623         }
624 }
625
626 void blk_drain_queue(struct request_queue *q)
627 {
628         spin_lock_irq(q->queue_lock);
629         __blk_drain_queue(q, true);
630         spin_unlock_irq(q->queue_lock);
631 }
632
633 /**
634  * blk_queue_bypass_start - enter queue bypass mode
635  * @q: queue of interest
636  *
637  * In bypass mode, only the dispatch FIFO queue of @q is used.  This
638  * function makes @q enter bypass mode and drains all requests which were
639  * throttled or issued before.  On return, it's guaranteed that no request
640  * is being throttled or has ELVPRIV set and blk_queue_bypass() %true
641  * inside queue or RCU read lock.
642  */
643 void blk_queue_bypass_start(struct request_queue *q)
644 {
645         WARN_ON_ONCE(q->mq_ops);
646
647         spin_lock_irq(q->queue_lock);
648         q->bypass_depth++;
649         queue_flag_set(QUEUE_FLAG_BYPASS, q);
650         spin_unlock_irq(q->queue_lock);
651
652         /*
653          * Queues start drained.  Skip actual draining till init is
654          * complete.  This avoids lenghty delays during queue init which
655          * can happen many times during boot.
656          */
657         if (blk_queue_init_done(q)) {
658                 spin_lock_irq(q->queue_lock);
659                 __blk_drain_queue(q, false);
660                 spin_unlock_irq(q->queue_lock);
661
662                 /* ensure blk_queue_bypass() is %true inside RCU read lock */
663                 synchronize_rcu();
664         }
665 }
666 EXPORT_SYMBOL_GPL(blk_queue_bypass_start);
667
668 /**
669  * blk_queue_bypass_end - leave queue bypass mode
670  * @q: queue of interest
671  *
672  * Leave bypass mode and restore the normal queueing behavior.
673  *
674  * Note: although blk_queue_bypass_start() is only called for blk-sq queues,
675  * this function is called for both blk-sq and blk-mq queues.
676  */
677 void blk_queue_bypass_end(struct request_queue *q)
678 {
679         spin_lock_irq(q->queue_lock);
680         if (!--q->bypass_depth)
681                 queue_flag_clear(QUEUE_FLAG_BYPASS, q);
682         WARN_ON_ONCE(q->bypass_depth < 0);
683         spin_unlock_irq(q->queue_lock);
684 }
685 EXPORT_SYMBOL_GPL(blk_queue_bypass_end);
686
687 void blk_set_queue_dying(struct request_queue *q)
688 {
689         blk_queue_flag_set(QUEUE_FLAG_DYING, q);
690
691         /*
692          * When queue DYING flag is set, we need to block new req
693          * entering queue, so we call blk_freeze_queue_start() to
694          * prevent I/O from crossing blk_queue_enter().
695          */
696         blk_freeze_queue_start(q);
697
698         if (q->mq_ops)
699                 blk_mq_wake_waiters(q);
700         else {
701                 struct request_list *rl;
702
703                 spin_lock_irq(q->queue_lock);
704                 blk_queue_for_each_rl(rl, q) {
705                         if (rl->rq_pool) {
706                                 wake_up_all(&rl->wait[BLK_RW_SYNC]);
707                                 wake_up_all(&rl->wait[BLK_RW_ASYNC]);
708                         }
709                 }
710                 spin_unlock_irq(q->queue_lock);
711         }
712
713         /* Make blk_queue_enter() reexamine the DYING flag. */
714         wake_up_all(&q->mq_freeze_wq);
715 }
716 EXPORT_SYMBOL_GPL(blk_set_queue_dying);
717
718 /* Unconfigure the I/O scheduler and dissociate from the cgroup controller. */
719 void blk_exit_queue(struct request_queue *q)
720 {
721         /*
722          * Since the I/O scheduler exit code may access cgroup information,
723          * perform I/O scheduler exit before disassociating from the block
724          * cgroup controller.
725          */
726         if (q->elevator) {
727                 ioc_clear_queue(q);
728                 elevator_exit(q, q->elevator);
729                 q->elevator = NULL;
730         }
731
732         /*
733          * Remove all references to @q from the block cgroup controller before
734          * restoring @q->queue_lock to avoid that restoring this pointer causes
735          * e.g. blkcg_print_blkgs() to crash.
736          */
737         blkcg_exit_queue(q);
738
739         /*
740          * Since the cgroup code may dereference the @q->backing_dev_info
741          * pointer, only decrease its reference count after having removed the
742          * association with the block cgroup controller.
743          */
744         bdi_put(q->backing_dev_info);
745 }
746
747 /**
748  * blk_cleanup_queue - shutdown a request queue
749  * @q: request queue to shutdown
750  *
751  * Mark @q DYING, drain all pending requests, mark @q DEAD, destroy and
752  * put it.  All future requests will be failed immediately with -ENODEV.
753  */
754 void blk_cleanup_queue(struct request_queue *q)
755 {
756         spinlock_t *lock = q->queue_lock;
757
758         /* mark @q DYING, no new request or merges will be allowed afterwards */
759         mutex_lock(&q->sysfs_lock);
760         blk_set_queue_dying(q);
761         spin_lock_irq(lock);
762
763         /*
764          * A dying queue is permanently in bypass mode till released.  Note
765          * that, unlike blk_queue_bypass_start(), we aren't performing
766          * synchronize_rcu() after entering bypass mode to avoid the delay
767          * as some drivers create and destroy a lot of queues while
768          * probing.  This is still safe because blk_release_queue() will be
769          * called only after the queue refcnt drops to zero and nothing,
770          * RCU or not, would be traversing the queue by then.
771          */
772         q->bypass_depth++;
773         queue_flag_set(QUEUE_FLAG_BYPASS, q);
774
775         queue_flag_set(QUEUE_FLAG_NOMERGES, q);
776         queue_flag_set(QUEUE_FLAG_NOXMERGES, q);
777         queue_flag_set(QUEUE_FLAG_DYING, q);
778         spin_unlock_irq(lock);
779         mutex_unlock(&q->sysfs_lock);
780
781         /*
782          * Drain all requests queued before DYING marking. Set DEAD flag to
783          * prevent that q->request_fn() gets invoked after draining finished.
784          */
785         blk_freeze_queue(q);
786         spin_lock_irq(lock);
787         queue_flag_set(QUEUE_FLAG_DEAD, q);
788         spin_unlock_irq(lock);
789
790         /*
791          * make sure all in-progress dispatch are completed because
792          * blk_freeze_queue() can only complete all requests, and
793          * dispatch may still be in-progress since we dispatch requests
794          * from more than one contexts.
795          *
796          * We rely on driver to deal with the race in case that queue
797          * initialization isn't done.
798          */
799         if (q->mq_ops && blk_queue_init_done(q))
800                 blk_mq_quiesce_queue(q);
801
802         /* for synchronous bio-based driver finish in-flight integrity i/o */
803         blk_flush_integrity();
804
805         /* @q won't process any more request, flush async actions */
806         del_timer_sync(&q->backing_dev_info->laptop_mode_wb_timer);
807         blk_sync_queue(q);
808
809         /*
810          * I/O scheduler exit is only safe after the sysfs scheduler attribute
811          * has been removed.
812          */
813         WARN_ON_ONCE(q->kobj.state_in_sysfs);
814
815         blk_exit_queue(q);
816
817         if (q->mq_ops)
818                 blk_mq_free_queue(q);
819         percpu_ref_exit(&q->q_usage_counter);
820
821         spin_lock_irq(lock);
822         if (q->queue_lock != &q->__queue_lock)
823                 q->queue_lock = &q->__queue_lock;
824         spin_unlock_irq(lock);
825
826         /* @q is and will stay empty, shutdown and put */
827         blk_put_queue(q);
828 }
829 EXPORT_SYMBOL(blk_cleanup_queue);
830
831 /* Allocate memory local to the request queue */
832 static void *alloc_request_simple(gfp_t gfp_mask, void *data)
833 {
834         struct request_queue *q = data;
835
836         return kmem_cache_alloc_node(request_cachep, gfp_mask, q->node);
837 }
838
839 static void free_request_simple(void *element, void *data)
840 {
841         kmem_cache_free(request_cachep, element);
842 }
843
844 static void *alloc_request_size(gfp_t gfp_mask, void *data)
845 {
846         struct request_queue *q = data;
847         struct request *rq;
848
849         rq = kmalloc_node(sizeof(struct request) + q->cmd_size, gfp_mask,
850                         q->node);
851         if (rq && q->init_rq_fn && q->init_rq_fn(q, rq, gfp_mask) < 0) {
852                 kfree(rq);
853                 rq = NULL;
854         }
855         return rq;
856 }
857
858 static void free_request_size(void *element, void *data)
859 {
860         struct request_queue *q = data;
861
862         if (q->exit_rq_fn)
863                 q->exit_rq_fn(q, element);
864         kfree(element);
865 }
866
867 int blk_init_rl(struct request_list *rl, struct request_queue *q,
868                 gfp_t gfp_mask)
869 {
870         if (unlikely(rl->rq_pool) || q->mq_ops)
871                 return 0;
872
873         rl->q = q;
874         rl->count[BLK_RW_SYNC] = rl->count[BLK_RW_ASYNC] = 0;
875         rl->starved[BLK_RW_SYNC] = rl->starved[BLK_RW_ASYNC] = 0;
876         init_waitqueue_head(&rl->wait[BLK_RW_SYNC]);
877         init_waitqueue_head(&rl->wait[BLK_RW_ASYNC]);
878
879         if (q->cmd_size) {
880                 rl->rq_pool = mempool_create_node(BLKDEV_MIN_RQ,
881                                 alloc_request_size, free_request_size,
882                                 q, gfp_mask, q->node);
883         } else {
884                 rl->rq_pool = mempool_create_node(BLKDEV_MIN_RQ,
885                                 alloc_request_simple, free_request_simple,
886                                 q, gfp_mask, q->node);
887         }
888         if (!rl->rq_pool)
889                 return -ENOMEM;
890
891         if (rl != &q->root_rl)
892                 WARN_ON_ONCE(!blk_get_queue(q));
893
894         return 0;
895 }
896
897 void blk_exit_rl(struct request_queue *q, struct request_list *rl)
898 {
899         if (rl->rq_pool) {
900                 mempool_destroy(rl->rq_pool);
901                 if (rl != &q->root_rl)
902                         blk_put_queue(q);
903         }
904 }
905
906 struct request_queue *blk_alloc_queue(gfp_t gfp_mask)
907 {
908         return blk_alloc_queue_node(gfp_mask, NUMA_NO_NODE, NULL);
909 }
910 EXPORT_SYMBOL(blk_alloc_queue);
911
912 /**
913  * blk_queue_enter() - try to increase q->q_usage_counter
914  * @q: request queue pointer
915  * @flags: BLK_MQ_REQ_NOWAIT and/or BLK_MQ_REQ_PREEMPT
916  */
917 int blk_queue_enter(struct request_queue *q, blk_mq_req_flags_t flags)
918 {
919         const bool preempt = flags & BLK_MQ_REQ_PREEMPT;
920
921         while (true) {
922                 bool success = false;
923
924                 rcu_read_lock();
925                 if (percpu_ref_tryget_live(&q->q_usage_counter)) {
926                         /*
927                          * The code that sets the PREEMPT_ONLY flag is
928                          * responsible for ensuring that that flag is globally
929                          * visible before the queue is unfrozen.
930                          */
931                         if (preempt || !blk_queue_preempt_only(q)) {
932                                 success = true;
933                         } else {
934                                 percpu_ref_put(&q->q_usage_counter);
935                         }
936                 }
937                 rcu_read_unlock();
938
939                 if (success)
940                         return 0;
941
942                 if (flags & BLK_MQ_REQ_NOWAIT)
943                         return -EBUSY;
944
945                 /*
946                  * read pair of barrier in blk_freeze_queue_start(),
947                  * we need to order reading __PERCPU_REF_DEAD flag of
948                  * .q_usage_counter and reading .mq_freeze_depth or
949                  * queue dying flag, otherwise the following wait may
950                  * never return if the two reads are reordered.
951                  */
952                 smp_rmb();
953
954                 wait_event(q->mq_freeze_wq,
955                            (atomic_read(&q->mq_freeze_depth) == 0 &&
956                             (preempt || !blk_queue_preempt_only(q))) ||
957                            blk_queue_dying(q));
958                 if (blk_queue_dying(q))
959                         return -ENODEV;
960         }
961 }
962
963 void blk_queue_exit(struct request_queue *q)
964 {
965         percpu_ref_put(&q->q_usage_counter);
966 }
967
968 static void blk_queue_usage_counter_release(struct percpu_ref *ref)
969 {
970         struct request_queue *q =
971                 container_of(ref, struct request_queue, q_usage_counter);
972
973         wake_up_all(&q->mq_freeze_wq);
974 }
975
976 static void blk_rq_timed_out_timer(struct timer_list *t)
977 {
978         struct request_queue *q = from_timer(q, t, timeout);
979
980         kblockd_schedule_work(&q->timeout_work);
981 }
982
983 static void blk_timeout_work_dummy(struct work_struct *work)
984 {
985 }
986
987 /**
988  * blk_alloc_queue_node - allocate a request queue
989  * @gfp_mask: memory allocation flags
990  * @node_id: NUMA node to allocate memory from
991  * @lock: For legacy queues, pointer to a spinlock that will be used to e.g.
992  *        serialize calls to the legacy .request_fn() callback. Ignored for
993  *        blk-mq request queues.
994  *
995  * Note: pass the queue lock as the third argument to this function instead of
996  * setting the queue lock pointer explicitly to avoid triggering a sporadic
997  * crash in the blkcg code. This function namely calls blkcg_init_queue() and
998  * the queue lock pointer must be set before blkcg_init_queue() is called.
999  */
1000 struct request_queue *blk_alloc_queue_node(gfp_t gfp_mask, int node_id,
1001                                            spinlock_t *lock)
1002 {
1003         struct request_queue *q;
1004         int ret;
1005
1006         q = kmem_cache_alloc_node(blk_requestq_cachep,
1007                                 gfp_mask | __GFP_ZERO, node_id);
1008         if (!q)
1009                 return NULL;
1010
1011         INIT_LIST_HEAD(&q->queue_head);
1012         q->last_merge = NULL;
1013         q->end_sector = 0;
1014         q->boundary_rq = NULL;
1015
1016         q->id = ida_simple_get(&blk_queue_ida, 0, 0, gfp_mask);
1017         if (q->id < 0)
1018                 goto fail_q;
1019
1020         ret = bioset_init(&q->bio_split, BIO_POOL_SIZE, 0, BIOSET_NEED_BVECS);
1021         if (ret)
1022                 goto fail_id;
1023
1024         q->backing_dev_info = bdi_alloc_node(gfp_mask, node_id);
1025         if (!q->backing_dev_info)
1026                 goto fail_split;
1027
1028         q->stats = blk_alloc_queue_stats();
1029         if (!q->stats)
1030                 goto fail_stats;
1031
1032         q->backing_dev_info->ra_pages =
1033                         (VM_MAX_READAHEAD * 1024) / PAGE_SIZE;
1034         q->backing_dev_info->capabilities = BDI_CAP_CGROUP_WRITEBACK;
1035         q->backing_dev_info->name = "block";
1036         q->node = node_id;
1037
1038         timer_setup(&q->backing_dev_info->laptop_mode_wb_timer,
1039                     laptop_mode_timer_fn, 0);
1040         timer_setup(&q->timeout, blk_rq_timed_out_timer, 0);
1041         INIT_WORK(&q->timeout_work, blk_timeout_work_dummy);
1042         INIT_LIST_HEAD(&q->timeout_list);
1043         INIT_LIST_HEAD(&q->icq_list);
1044 #ifdef CONFIG_BLK_CGROUP
1045         INIT_LIST_HEAD(&q->blkg_list);
1046 #endif
1047         INIT_DELAYED_WORK(&q->delay_work, blk_delay_work);
1048
1049         kobject_init(&q->kobj, &blk_queue_ktype);
1050
1051 #ifdef CONFIG_BLK_DEV_IO_TRACE
1052         mutex_init(&q->blk_trace_mutex);
1053 #endif
1054         mutex_init(&q->sysfs_lock);
1055         spin_lock_init(&q->__queue_lock);
1056
1057         if (!q->mq_ops)
1058                 q->queue_lock = lock ? : &q->__queue_lock;
1059
1060         /*
1061          * A queue starts its life with bypass turned on to avoid
1062          * unnecessary bypass on/off overhead and nasty surprises during
1063          * init.  The initial bypass will be finished when the queue is
1064          * registered by blk_register_queue().
1065          */
1066         q->bypass_depth = 1;
1067         queue_flag_set_unlocked(QUEUE_FLAG_BYPASS, q);
1068
1069         init_waitqueue_head(&q->mq_freeze_wq);
1070
1071         /*
1072          * Init percpu_ref in atomic mode so that it's faster to shutdown.
1073          * See blk_register_queue() for details.
1074          */
1075         if (percpu_ref_init(&q->q_usage_counter,
1076                                 blk_queue_usage_counter_release,
1077                                 PERCPU_REF_INIT_ATOMIC, GFP_KERNEL))
1078                 goto fail_bdi;
1079
1080         if (blkcg_init_queue(q))
1081                 goto fail_ref;
1082
1083         return q;
1084
1085 fail_ref:
1086         percpu_ref_exit(&q->q_usage_counter);
1087 fail_bdi:
1088         blk_free_queue_stats(q->stats);
1089 fail_stats:
1090         bdi_put(q->backing_dev_info);
1091 fail_split:
1092         bioset_exit(&q->bio_split);
1093 fail_id:
1094         ida_simple_remove(&blk_queue_ida, q->id);
1095 fail_q:
1096         kmem_cache_free(blk_requestq_cachep, q);
1097         return NULL;
1098 }
1099 EXPORT_SYMBOL(blk_alloc_queue_node);
1100
1101 /**
1102  * blk_init_queue  - prepare a request queue for use with a block device
1103  * @rfn:  The function to be called to process requests that have been
1104  *        placed on the queue.
1105  * @lock: Request queue spin lock
1106  *
1107  * Description:
1108  *    If a block device wishes to use the standard request handling procedures,
1109  *    which sorts requests and coalesces adjacent requests, then it must
1110  *    call blk_init_queue().  The function @rfn will be called when there
1111  *    are requests on the queue that need to be processed.  If the device
1112  *    supports plugging, then @rfn may not be called immediately when requests
1113  *    are available on the queue, but may be called at some time later instead.
1114  *    Plugged queues are generally unplugged when a buffer belonging to one
1115  *    of the requests on the queue is needed, or due to memory pressure.
1116  *
1117  *    @rfn is not required, or even expected, to remove all requests off the
1118  *    queue, but only as many as it can handle at a time.  If it does leave
1119  *    requests on the queue, it is responsible for arranging that the requests
1120  *    get dealt with eventually.
1121  *
1122  *    The queue spin lock must be held while manipulating the requests on the
1123  *    request queue; this lock will be taken also from interrupt context, so irq
1124  *    disabling is needed for it.
1125  *
1126  *    Function returns a pointer to the initialized request queue, or %NULL if
1127  *    it didn't succeed.
1128  *
1129  * Note:
1130  *    blk_init_queue() must be paired with a blk_cleanup_queue() call
1131  *    when the block device is deactivated (such as at module unload).
1132  **/
1133
1134 struct request_queue *blk_init_queue(request_fn_proc *rfn, spinlock_t *lock)
1135 {
1136         return blk_init_queue_node(rfn, lock, NUMA_NO_NODE);
1137 }
1138 EXPORT_SYMBOL(blk_init_queue);
1139
1140 struct request_queue *
1141 blk_init_queue_node(request_fn_proc *rfn, spinlock_t *lock, int node_id)
1142 {
1143         struct request_queue *q;
1144
1145         q = blk_alloc_queue_node(GFP_KERNEL, node_id, lock);
1146         if (!q)
1147                 return NULL;
1148
1149         q->request_fn = rfn;
1150         if (blk_init_allocated_queue(q) < 0) {
1151                 blk_cleanup_queue(q);
1152                 return NULL;
1153         }
1154
1155         return q;
1156 }
1157 EXPORT_SYMBOL(blk_init_queue_node);
1158
1159 static blk_qc_t blk_queue_bio(struct request_queue *q, struct bio *bio);
1160
1161
1162 int blk_init_allocated_queue(struct request_queue *q)
1163 {
1164         WARN_ON_ONCE(q->mq_ops);
1165
1166         q->fq = blk_alloc_flush_queue(q, NUMA_NO_NODE, q->cmd_size);
1167         if (!q->fq)
1168                 return -ENOMEM;
1169
1170         if (q->init_rq_fn && q->init_rq_fn(q, q->fq->flush_rq, GFP_KERNEL))
1171                 goto out_free_flush_queue;
1172
1173         if (blk_init_rl(&q->root_rl, q, GFP_KERNEL))
1174                 goto out_exit_flush_rq;
1175
1176         INIT_WORK(&q->timeout_work, blk_timeout_work);
1177         q->queue_flags          |= QUEUE_FLAG_DEFAULT;
1178
1179         /*
1180          * This also sets hw/phys segments, boundary and size
1181          */
1182         blk_queue_make_request(q, blk_queue_bio);
1183
1184         q->sg_reserved_size = INT_MAX;
1185
1186         if (elevator_init(q))
1187                 goto out_exit_flush_rq;
1188         return 0;
1189
1190 out_exit_flush_rq:
1191         if (q->exit_rq_fn)
1192                 q->exit_rq_fn(q, q->fq->flush_rq);
1193 out_free_flush_queue:
1194         blk_free_flush_queue(q->fq);
1195         q->fq = NULL;
1196         return -ENOMEM;
1197 }
1198 EXPORT_SYMBOL(blk_init_allocated_queue);
1199
1200 bool blk_get_queue(struct request_queue *q)
1201 {
1202         if (likely(!blk_queue_dying(q))) {
1203                 __blk_get_queue(q);
1204                 return true;
1205         }
1206
1207         return false;
1208 }
1209 EXPORT_SYMBOL(blk_get_queue);
1210
1211 static inline void blk_free_request(struct request_list *rl, struct request *rq)
1212 {
1213         if (rq->rq_flags & RQF_ELVPRIV) {
1214                 elv_put_request(rl->q, rq);
1215                 if (rq->elv.icq)
1216                         put_io_context(rq->elv.icq->ioc);
1217         }
1218
1219         mempool_free(rq, rl->rq_pool);
1220 }
1221
1222 /*
1223  * ioc_batching returns true if the ioc is a valid batching request and
1224  * should be given priority access to a request.
1225  */
1226 static inline int ioc_batching(struct request_queue *q, struct io_context *ioc)
1227 {
1228         if (!ioc)
1229                 return 0;
1230
1231         /*
1232          * Make sure the process is able to allocate at least 1 request
1233          * even if the batch times out, otherwise we could theoretically
1234          * lose wakeups.
1235          */
1236         return ioc->nr_batch_requests == q->nr_batching ||
1237                 (ioc->nr_batch_requests > 0
1238                 && time_before(jiffies, ioc->last_waited + BLK_BATCH_TIME));
1239 }
1240
1241 /*
1242  * ioc_set_batching sets ioc to be a new "batcher" if it is not one. This
1243  * will cause the process to be a "batcher" on all queues in the system. This
1244  * is the behaviour we want though - once it gets a wakeup it should be given
1245  * a nice run.
1246  */
1247 static void ioc_set_batching(struct request_queue *q, struct io_context *ioc)
1248 {
1249         if (!ioc || ioc_batching(q, ioc))
1250                 return;
1251
1252         ioc->nr_batch_requests = q->nr_batching;
1253         ioc->last_waited = jiffies;
1254 }
1255
1256 static void __freed_request(struct request_list *rl, int sync)
1257 {
1258         struct request_queue *q = rl->q;
1259
1260         if (rl->count[sync] < queue_congestion_off_threshold(q))
1261                 blk_clear_congested(rl, sync);
1262
1263         if (rl->count[sync] + 1 <= q->nr_requests) {
1264                 if (waitqueue_active(&rl->wait[sync]))
1265                         wake_up(&rl->wait[sync]);
1266
1267                 blk_clear_rl_full(rl, sync);
1268         }
1269 }
1270
1271 /*
1272  * A request has just been released.  Account for it, update the full and
1273  * congestion status, wake up any waiters.   Called under q->queue_lock.
1274  */
1275 static void freed_request(struct request_list *rl, bool sync,
1276                 req_flags_t rq_flags)
1277 {
1278         struct request_queue *q = rl->q;
1279
1280         q->nr_rqs[sync]--;
1281         rl->count[sync]--;
1282         if (rq_flags & RQF_ELVPRIV)
1283                 q->nr_rqs_elvpriv--;
1284
1285         __freed_request(rl, sync);
1286
1287         if (unlikely(rl->starved[sync ^ 1]))
1288                 __freed_request(rl, sync ^ 1);
1289 }
1290
1291 int blk_update_nr_requests(struct request_queue *q, unsigned int nr)
1292 {
1293         struct request_list *rl;
1294         int on_thresh, off_thresh;
1295
1296         WARN_ON_ONCE(q->mq_ops);
1297
1298         spin_lock_irq(q->queue_lock);
1299         q->nr_requests = nr;
1300         blk_queue_congestion_threshold(q);
1301         on_thresh = queue_congestion_on_threshold(q);
1302         off_thresh = queue_congestion_off_threshold(q);
1303
1304         blk_queue_for_each_rl(rl, q) {
1305                 if (rl->count[BLK_RW_SYNC] >= on_thresh)
1306                         blk_set_congested(rl, BLK_RW_SYNC);
1307                 else if (rl->count[BLK_RW_SYNC] < off_thresh)
1308                         blk_clear_congested(rl, BLK_RW_SYNC);
1309
1310                 if (rl->count[BLK_RW_ASYNC] >= on_thresh)
1311                         blk_set_congested(rl, BLK_RW_ASYNC);
1312                 else if (rl->count[BLK_RW_ASYNC] < off_thresh)
1313                         blk_clear_congested(rl, BLK_RW_ASYNC);
1314
1315                 if (rl->count[BLK_RW_SYNC] >= q->nr_requests) {
1316                         blk_set_rl_full(rl, BLK_RW_SYNC);
1317                 } else {
1318                         blk_clear_rl_full(rl, BLK_RW_SYNC);
1319                         wake_up(&rl->wait[BLK_RW_SYNC]);
1320                 }
1321
1322                 if (rl->count[BLK_RW_ASYNC] >= q->nr_requests) {
1323                         blk_set_rl_full(rl, BLK_RW_ASYNC);
1324                 } else {
1325                         blk_clear_rl_full(rl, BLK_RW_ASYNC);
1326                         wake_up(&rl->wait[BLK_RW_ASYNC]);
1327                 }
1328         }
1329
1330         spin_unlock_irq(q->queue_lock);
1331         return 0;
1332 }
1333
1334 /**
1335  * __get_request - get a free request
1336  * @rl: request list to allocate from
1337  * @op: operation and flags
1338  * @bio: bio to allocate request for (can be %NULL)
1339  * @flags: BLQ_MQ_REQ_* flags
1340  * @gfp_mask: allocator flags
1341  *
1342  * Get a free request from @q.  This function may fail under memory
1343  * pressure or if @q is dead.
1344  *
1345  * Must be called with @q->queue_lock held and,
1346  * Returns ERR_PTR on failure, with @q->queue_lock held.
1347  * Returns request pointer on success, with @q->queue_lock *not held*.
1348  */
1349 static struct request *__get_request(struct request_list *rl, unsigned int op,
1350                 struct bio *bio, blk_mq_req_flags_t flags, gfp_t gfp_mask)
1351 {
1352         struct request_queue *q = rl->q;
1353         struct request *rq;
1354         struct elevator_type *et = q->elevator->type;
1355         struct io_context *ioc = rq_ioc(bio);
1356         struct io_cq *icq = NULL;
1357         const bool is_sync = op_is_sync(op);
1358         int may_queue;
1359         req_flags_t rq_flags = RQF_ALLOCED;
1360
1361         lockdep_assert_held(q->queue_lock);
1362
1363         if (unlikely(blk_queue_dying(q)))
1364                 return ERR_PTR(-ENODEV);
1365
1366         may_queue = elv_may_queue(q, op);
1367         if (may_queue == ELV_MQUEUE_NO)
1368                 goto rq_starved;
1369
1370         if (rl->count[is_sync]+1 >= queue_congestion_on_threshold(q)) {
1371                 if (rl->count[is_sync]+1 >= q->nr_requests) {
1372                         /*
1373                          * The queue will fill after this allocation, so set
1374                          * it as full, and mark this process as "batching".
1375                          * This process will be allowed to complete a batch of
1376                          * requests, others will be blocked.
1377                          */
1378                         if (!blk_rl_full(rl, is_sync)) {
1379                                 ioc_set_batching(q, ioc);
1380                                 blk_set_rl_full(rl, is_sync);
1381                         } else {
1382                                 if (may_queue != ELV_MQUEUE_MUST
1383                                                 && !ioc_batching(q, ioc)) {
1384                                         /*
1385                                          * The queue is full and the allocating
1386                                          * process is not a "batcher", and not
1387                                          * exempted by the IO scheduler
1388                                          */
1389                                         return ERR_PTR(-ENOMEM);
1390                                 }
1391                         }
1392                 }
1393                 blk_set_congested(rl, is_sync);
1394         }
1395
1396         /*
1397          * Only allow batching queuers to allocate up to 50% over the defined
1398          * limit of requests, otherwise we could have thousands of requests
1399          * allocated with any setting of ->nr_requests
1400          */
1401         if (rl->count[is_sync] >= (3 * q->nr_requests / 2))
1402                 return ERR_PTR(-ENOMEM);
1403
1404         q->nr_rqs[is_sync]++;
1405         rl->count[is_sync]++;
1406         rl->starved[is_sync] = 0;
1407
1408         /*
1409          * Decide whether the new request will be managed by elevator.  If
1410          * so, mark @rq_flags and increment elvpriv.  Non-zero elvpriv will
1411          * prevent the current elevator from being destroyed until the new
1412          * request is freed.  This guarantees icq's won't be destroyed and
1413          * makes creating new ones safe.
1414          *
1415          * Flush requests do not use the elevator so skip initialization.
1416          * This allows a request to share the flush and elevator data.
1417          *
1418          * Also, lookup icq while holding queue_lock.  If it doesn't exist,
1419          * it will be created after releasing queue_lock.
1420          */
1421         if (!op_is_flush(op) && !blk_queue_bypass(q)) {
1422                 rq_flags |= RQF_ELVPRIV;
1423                 q->nr_rqs_elvpriv++;
1424                 if (et->icq_cache && ioc)
1425                         icq = ioc_lookup_icq(ioc, q);
1426         }
1427
1428         if (blk_queue_io_stat(q))
1429                 rq_flags |= RQF_IO_STAT;
1430         spin_unlock_irq(q->queue_lock);
1431
1432         /* allocate and init request */
1433         rq = mempool_alloc(rl->rq_pool, gfp_mask);
1434         if (!rq)
1435                 goto fail_alloc;
1436
1437         blk_rq_init(q, rq);
1438         blk_rq_set_rl(rq, rl);
1439         rq->cmd_flags = op;
1440         rq->rq_flags = rq_flags;
1441         if (flags & BLK_MQ_REQ_PREEMPT)
1442                 rq->rq_flags |= RQF_PREEMPT;
1443
1444         /* init elvpriv */
1445         if (rq_flags & RQF_ELVPRIV) {
1446                 if (unlikely(et->icq_cache && !icq)) {
1447                         if (ioc)
1448                                 icq = ioc_create_icq(ioc, q, gfp_mask);
1449                         if (!icq)
1450                                 goto fail_elvpriv;
1451                 }
1452
1453                 rq->elv.icq = icq;
1454                 if (unlikely(elv_set_request(q, rq, bio, gfp_mask)))
1455                         goto fail_elvpriv;
1456
1457                 /* @rq->elv.icq holds io_context until @rq is freed */
1458                 if (icq)
1459                         get_io_context(icq->ioc);
1460         }
1461 out:
1462         /*
1463          * ioc may be NULL here, and ioc_batching will be false. That's
1464          * OK, if the queue is under the request limit then requests need
1465          * not count toward the nr_batch_requests limit. There will always
1466          * be some limit enforced by BLK_BATCH_TIME.
1467          */
1468         if (ioc_batching(q, ioc))
1469                 ioc->nr_batch_requests--;
1470
1471         trace_block_getrq(q, bio, op);
1472         return rq;
1473
1474 fail_elvpriv:
1475         /*
1476          * elvpriv init failed.  ioc, icq and elvpriv aren't mempool backed
1477          * and may fail indefinitely under memory pressure and thus
1478          * shouldn't stall IO.  Treat this request as !elvpriv.  This will
1479          * disturb iosched and blkcg but weird is bettern than dead.
1480          */
1481         printk_ratelimited(KERN_WARNING "%s: dev %s: request aux data allocation failed, iosched may be disturbed\n",
1482                            __func__, dev_name(q->backing_dev_info->dev));
1483
1484         rq->rq_flags &= ~RQF_ELVPRIV;
1485         rq->elv.icq = NULL;
1486
1487         spin_lock_irq(q->queue_lock);
1488         q->nr_rqs_elvpriv--;
1489         spin_unlock_irq(q->queue_lock);
1490         goto out;
1491
1492 fail_alloc:
1493         /*
1494          * Allocation failed presumably due to memory. Undo anything we
1495          * might have messed up.
1496          *
1497          * Allocating task should really be put onto the front of the wait
1498          * queue, but this is pretty rare.
1499          */
1500         spin_lock_irq(q->queue_lock);
1501         freed_request(rl, is_sync, rq_flags);
1502
1503         /*
1504          * in the very unlikely event that allocation failed and no
1505          * requests for this direction was pending, mark us starved so that
1506          * freeing of a request in the other direction will notice
1507          * us. another possible fix would be to split the rq mempool into
1508          * READ and WRITE
1509          */
1510 rq_starved:
1511         if (unlikely(rl->count[is_sync] == 0))
1512                 rl->starved[is_sync] = 1;
1513         return ERR_PTR(-ENOMEM);
1514 }
1515
1516 /**
1517  * get_request - get a free request
1518  * @q: request_queue to allocate request from
1519  * @op: operation and flags
1520  * @bio: bio to allocate request for (can be %NULL)
1521  * @flags: BLK_MQ_REQ_* flags.
1522  * @gfp: allocator flags
1523  *
1524  * Get a free request from @q.  If %BLK_MQ_REQ_NOWAIT is set in @flags,
1525  * this function keeps retrying under memory pressure and fails iff @q is dead.
1526  *
1527  * Must be called with @q->queue_lock held and,
1528  * Returns ERR_PTR on failure, with @q->queue_lock held.
1529  * Returns request pointer on success, with @q->queue_lock *not held*.
1530  */
1531 static struct request *get_request(struct request_queue *q, unsigned int op,
1532                 struct bio *bio, blk_mq_req_flags_t flags, gfp_t gfp)
1533 {
1534         const bool is_sync = op_is_sync(op);
1535         DEFINE_WAIT(wait);
1536         struct request_list *rl;
1537         struct request *rq;
1538
1539         lockdep_assert_held(q->queue_lock);
1540         WARN_ON_ONCE(q->mq_ops);
1541
1542         rl = blk_get_rl(q, bio);        /* transferred to @rq on success */
1543 retry:
1544         rq = __get_request(rl, op, bio, flags, gfp);
1545         if (!IS_ERR(rq))
1546                 return rq;
1547
1548         if (op & REQ_NOWAIT) {
1549                 blk_put_rl(rl);
1550                 return ERR_PTR(-EAGAIN);
1551         }
1552
1553         if ((flags & BLK_MQ_REQ_NOWAIT) || unlikely(blk_queue_dying(q))) {
1554                 blk_put_rl(rl);
1555                 return rq;
1556         }
1557
1558         /* wait on @rl and retry */
1559         prepare_to_wait_exclusive(&rl->wait[is_sync], &wait,
1560                                   TASK_UNINTERRUPTIBLE);
1561
1562         trace_block_sleeprq(q, bio, op);
1563
1564         spin_unlock_irq(q->queue_lock);
1565         io_schedule();
1566
1567         /*
1568          * After sleeping, we become a "batching" process and will be able
1569          * to allocate at least one request, and up to a big batch of them
1570          * for a small period time.  See ioc_batching, ioc_set_batching
1571          */
1572         ioc_set_batching(q, current->io_context);
1573
1574         spin_lock_irq(q->queue_lock);
1575         finish_wait(&rl->wait[is_sync], &wait);
1576
1577         goto retry;
1578 }
1579
1580 /* flags: BLK_MQ_REQ_PREEMPT and/or BLK_MQ_REQ_NOWAIT. */
1581 static struct request *blk_old_get_request(struct request_queue *q,
1582                                 unsigned int op, blk_mq_req_flags_t flags)
1583 {
1584         struct request *rq;
1585         gfp_t gfp_mask = flags & BLK_MQ_REQ_NOWAIT ? GFP_ATOMIC : GFP_NOIO;
1586         int ret = 0;
1587
1588         WARN_ON_ONCE(q->mq_ops);
1589
1590         /* create ioc upfront */
1591         create_io_context(gfp_mask, q->node);
1592
1593         ret = blk_queue_enter(q, flags);
1594         if (ret)
1595                 return ERR_PTR(ret);
1596         spin_lock_irq(q->queue_lock);
1597         rq = get_request(q, op, NULL, flags, gfp_mask);
1598         if (IS_ERR(rq)) {
1599                 spin_unlock_irq(q->queue_lock);
1600                 blk_queue_exit(q);
1601                 return rq;
1602         }
1603
1604         /* q->queue_lock is unlocked at this point */
1605         rq->__data_len = 0;
1606         rq->__sector = (sector_t) -1;
1607         rq->bio = rq->biotail = NULL;
1608         return rq;
1609 }
1610
1611 /**
1612  * blk_get_request - allocate a request
1613  * @q: request queue to allocate a request for
1614  * @op: operation (REQ_OP_*) and REQ_* flags, e.g. REQ_SYNC.
1615  * @flags: BLK_MQ_REQ_* flags, e.g. BLK_MQ_REQ_NOWAIT.
1616  */
1617 struct request *blk_get_request(struct request_queue *q, unsigned int op,
1618                                 blk_mq_req_flags_t flags)
1619 {
1620         struct request *req;
1621
1622         WARN_ON_ONCE(op & REQ_NOWAIT);
1623         WARN_ON_ONCE(flags & ~(BLK_MQ_REQ_NOWAIT | BLK_MQ_REQ_PREEMPT));
1624
1625         if (q->mq_ops) {
1626                 req = blk_mq_alloc_request(q, op, flags);
1627                 if (!IS_ERR(req) && q->mq_ops->initialize_rq_fn)
1628                         q->mq_ops->initialize_rq_fn(req);
1629         } else {
1630                 req = blk_old_get_request(q, op, flags);
1631                 if (!IS_ERR(req) && q->initialize_rq_fn)
1632                         q->initialize_rq_fn(req);
1633         }
1634
1635         return req;
1636 }
1637 EXPORT_SYMBOL(blk_get_request);
1638
1639 /**
1640  * blk_requeue_request - put a request back on queue
1641  * @q:          request queue where request should be inserted
1642  * @rq:         request to be inserted
1643  *
1644  * Description:
1645  *    Drivers often keep queueing requests until the hardware cannot accept
1646  *    more, when that condition happens we need to put the request back
1647  *    on the queue. Must be called with queue lock held.
1648  */
1649 void blk_requeue_request(struct request_queue *q, struct request *rq)
1650 {
1651         lockdep_assert_held(q->queue_lock);
1652         WARN_ON_ONCE(q->mq_ops);
1653
1654         blk_delete_timer(rq);
1655         blk_clear_rq_complete(rq);
1656         trace_block_rq_requeue(q, rq);
1657         rq_qos_requeue(q, rq);
1658
1659         if (rq->rq_flags & RQF_QUEUED)
1660                 blk_queue_end_tag(q, rq);
1661
1662         BUG_ON(blk_queued_rq(rq));
1663
1664         elv_requeue_request(q, rq);
1665 }
1666 EXPORT_SYMBOL(blk_requeue_request);
1667
1668 static void add_acct_request(struct request_queue *q, struct request *rq,
1669                              int where)
1670 {
1671         blk_account_io_start(rq, true);
1672         __elv_add_request(q, rq, where);
1673 }
1674
1675 static void part_round_stats_single(struct request_queue *q, int cpu,
1676                                     struct hd_struct *part, unsigned long now,
1677                                     unsigned int inflight)
1678 {
1679         if (inflight) {
1680                 __part_stat_add(cpu, part, time_in_queue,
1681                                 inflight * (now - part->stamp));
1682                 __part_stat_add(cpu, part, io_ticks, (now - part->stamp));
1683         }
1684         part->stamp = now;
1685 }
1686
1687 /**
1688  * part_round_stats() - Round off the performance stats on a struct disk_stats.
1689  * @q: target block queue
1690  * @cpu: cpu number for stats access
1691  * @part: target partition
1692  *
1693  * The average IO queue length and utilisation statistics are maintained
1694  * by observing the current state of the queue length and the amount of
1695  * time it has been in this state for.
1696  *
1697  * Normally, that accounting is done on IO completion, but that can result
1698  * in more than a second's worth of IO being accounted for within any one
1699  * second, leading to >100% utilisation.  To deal with that, we call this
1700  * function to do a round-off before returning the results when reading
1701  * /proc/diskstats.  This accounts immediately for all queue usage up to
1702  * the current jiffies and restarts the counters again.
1703  */
1704 void part_round_stats(struct request_queue *q, int cpu, struct hd_struct *part)
1705 {
1706         struct hd_struct *part2 = NULL;
1707         unsigned long now = jiffies;
1708         unsigned int inflight[2];
1709         int stats = 0;
1710
1711         if (part->stamp != now)
1712                 stats |= 1;
1713
1714         if (part->partno) {
1715                 part2 = &part_to_disk(part)->part0;
1716                 if (part2->stamp != now)
1717                         stats |= 2;
1718         }
1719
1720         if (!stats)
1721                 return;
1722
1723         part_in_flight(q, part, inflight);
1724
1725         if (stats & 2)
1726                 part_round_stats_single(q, cpu, part2, now, inflight[1]);
1727         if (stats & 1)
1728                 part_round_stats_single(q, cpu, part, now, inflight[0]);
1729 }
1730 EXPORT_SYMBOL_GPL(part_round_stats);
1731
1732 #ifdef CONFIG_PM
1733 static void blk_pm_put_request(struct request *rq)
1734 {
1735         if (rq->q->dev && !(rq->rq_flags & RQF_PM) && !--rq->q->nr_pending)
1736                 pm_runtime_mark_last_busy(rq->q->dev);
1737 }
1738 #else
1739 static inline void blk_pm_put_request(struct request *rq) {}
1740 #endif
1741
1742 void __blk_put_request(struct request_queue *q, struct request *req)
1743 {
1744         req_flags_t rq_flags = req->rq_flags;
1745
1746         if (unlikely(!q))
1747                 return;
1748
1749         if (q->mq_ops) {
1750                 blk_mq_free_request(req);
1751                 return;
1752         }
1753
1754         lockdep_assert_held(q->queue_lock);
1755
1756         blk_req_zone_write_unlock(req);
1757         blk_pm_put_request(req);
1758
1759         elv_completed_request(q, req);
1760
1761         /* this is a bio leak */
1762         WARN_ON(req->bio != NULL);
1763
1764         rq_qos_done(q, req);
1765
1766         /*
1767          * Request may not have originated from ll_rw_blk. if not,
1768          * it didn't come out of our reserved rq pools
1769          */
1770         if (rq_flags & RQF_ALLOCED) {
1771                 struct request_list *rl = blk_rq_rl(req);
1772                 bool sync = op_is_sync(req->cmd_flags);
1773
1774                 BUG_ON(!list_empty(&req->queuelist));
1775                 BUG_ON(ELV_ON_HASH(req));
1776
1777                 blk_free_request(rl, req);
1778                 freed_request(rl, sync, rq_flags);
1779                 blk_put_rl(rl);
1780                 blk_queue_exit(q);
1781         }
1782 }
1783 EXPORT_SYMBOL_GPL(__blk_put_request);
1784
1785 void blk_put_request(struct request *req)
1786 {
1787         struct request_queue *q = req->q;
1788
1789         if (q->mq_ops)
1790                 blk_mq_free_request(req);
1791         else {
1792                 unsigned long flags;
1793
1794                 spin_lock_irqsave(q->queue_lock, flags);
1795                 __blk_put_request(q, req);
1796                 spin_unlock_irqrestore(q->queue_lock, flags);
1797         }
1798 }
1799 EXPORT_SYMBOL(blk_put_request);
1800
1801 bool bio_attempt_back_merge(struct request_queue *q, struct request *req,
1802                             struct bio *bio)
1803 {
1804         const int ff = bio->bi_opf & REQ_FAILFAST_MASK;
1805
1806         if (!ll_back_merge_fn(q, req, bio))
1807                 return false;
1808
1809         trace_block_bio_backmerge(q, req, bio);
1810
1811         if ((req->cmd_flags & REQ_FAILFAST_MASK) != ff)
1812                 blk_rq_set_mixed_merge(req);
1813
1814         req->biotail->bi_next = bio;
1815         req->biotail = bio;
1816         req->__data_len += bio->bi_iter.bi_size;
1817         req->ioprio = ioprio_best(req->ioprio, bio_prio(bio));
1818
1819         blk_account_io_start(req, false);
1820         return true;
1821 }
1822
1823 bool bio_attempt_front_merge(struct request_queue *q, struct request *req,
1824                              struct bio *bio)
1825 {
1826         const int ff = bio->bi_opf & REQ_FAILFAST_MASK;
1827
1828         if (!ll_front_merge_fn(q, req, bio))
1829                 return false;
1830
1831         trace_block_bio_frontmerge(q, req, bio);
1832
1833         if ((req->cmd_flags & REQ_FAILFAST_MASK) != ff)
1834                 blk_rq_set_mixed_merge(req);
1835
1836         bio->bi_next = req->bio;
1837         req->bio = bio;
1838
1839         req->__sector = bio->bi_iter.bi_sector;
1840         req->__data_len += bio->bi_iter.bi_size;
1841         req->ioprio = ioprio_best(req->ioprio, bio_prio(bio));
1842
1843         blk_account_io_start(req, false);
1844         return true;
1845 }
1846
1847 bool bio_attempt_discard_merge(struct request_queue *q, struct request *req,
1848                 struct bio *bio)
1849 {
1850         unsigned short segments = blk_rq_nr_discard_segments(req);
1851
1852         if (segments >= queue_max_discard_segments(q))
1853                 goto no_merge;
1854         if (blk_rq_sectors(req) + bio_sectors(bio) >
1855             blk_rq_get_max_sectors(req, blk_rq_pos(req)))
1856                 goto no_merge;
1857
1858         req->biotail->bi_next = bio;
1859         req->biotail = bio;
1860         req->__data_len += bio->bi_iter.bi_size;
1861         req->ioprio = ioprio_best(req->ioprio, bio_prio(bio));
1862         req->nr_phys_segments = segments + 1;
1863
1864         blk_account_io_start(req, false);
1865         return true;
1866 no_merge:
1867         req_set_nomerge(q, req);
1868         return false;
1869 }
1870
1871 /**
1872  * blk_attempt_plug_merge - try to merge with %current's plugged list
1873  * @q: request_queue new bio is being queued at
1874  * @bio: new bio being queued
1875  * @request_count: out parameter for number of traversed plugged requests
1876  * @same_queue_rq: pointer to &struct request that gets filled in when
1877  * another request associated with @q is found on the plug list
1878  * (optional, may be %NULL)
1879  *
1880  * Determine whether @bio being queued on @q can be merged with a request
1881  * on %current's plugged list.  Returns %true if merge was successful,
1882  * otherwise %false.
1883  *
1884  * Plugging coalesces IOs from the same issuer for the same purpose without
1885  * going through @q->queue_lock.  As such it's more of an issuing mechanism
1886  * than scheduling, and the request, while may have elvpriv data, is not
1887  * added on the elevator at this point.  In addition, we don't have
1888  * reliable access to the elevator outside queue lock.  Only check basic
1889  * merging parameters without querying the elevator.
1890  *
1891  * Caller must ensure !blk_queue_nomerges(q) beforehand.
1892  */
1893 bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
1894                             unsigned int *request_count,
1895                             struct request **same_queue_rq)
1896 {
1897         struct blk_plug *plug;
1898         struct request *rq;
1899         struct list_head *plug_list;
1900
1901         plug = current->plug;
1902         if (!plug)
1903                 return false;
1904         *request_count = 0;
1905
1906         if (q->mq_ops)
1907                 plug_list = &plug->mq_list;
1908         else
1909                 plug_list = &plug->list;
1910
1911         list_for_each_entry_reverse(rq, plug_list, queuelist) {
1912                 bool merged = false;
1913
1914                 if (rq->q == q) {
1915                         (*request_count)++;
1916                         /*
1917                          * Only blk-mq multiple hardware queues case checks the
1918                          * rq in the same queue, there should be only one such
1919                          * rq in a queue
1920                          **/
1921                         if (same_queue_rq)
1922                                 *same_queue_rq = rq;
1923                 }
1924
1925                 if (rq->q != q || !blk_rq_merge_ok(rq, bio))
1926                         continue;
1927
1928                 switch (blk_try_merge(rq, bio)) {
1929                 case ELEVATOR_BACK_MERGE:
1930                         merged = bio_attempt_back_merge(q, rq, bio);
1931                         break;
1932                 case ELEVATOR_FRONT_MERGE:
1933                         merged = bio_attempt_front_merge(q, rq, bio);
1934                         break;
1935                 case ELEVATOR_DISCARD_MERGE:
1936                         merged = bio_attempt_discard_merge(q, rq, bio);
1937                         break;
1938                 default:
1939                         break;
1940                 }
1941
1942                 if (merged)
1943                         return true;
1944         }
1945
1946         return false;
1947 }
1948
1949 unsigned int blk_plug_queued_count(struct request_queue *q)
1950 {
1951         struct blk_plug *plug;
1952         struct request *rq;
1953         struct list_head *plug_list;
1954         unsigned int ret = 0;
1955
1956         plug = current->plug;
1957         if (!plug)
1958                 goto out;
1959
1960         if (q->mq_ops)
1961                 plug_list = &plug->mq_list;
1962         else
1963                 plug_list = &plug->list;
1964
1965         list_for_each_entry(rq, plug_list, queuelist) {
1966                 if (rq->q == q)
1967                         ret++;
1968         }
1969 out:
1970         return ret;
1971 }
1972
1973 void blk_init_request_from_bio(struct request *req, struct bio *bio)
1974 {
1975         struct io_context *ioc = rq_ioc(bio);
1976
1977         if (bio->bi_opf & REQ_RAHEAD)
1978                 req->cmd_flags |= REQ_FAILFAST_MASK;
1979
1980         req->__sector = bio->bi_iter.bi_sector;
1981         if (ioprio_valid(bio_prio(bio)))
1982                 req->ioprio = bio_prio(bio);
1983         else if (ioc)
1984                 req->ioprio = ioc->ioprio;
1985         else
1986                 req->ioprio = IOPRIO_PRIO_VALUE(IOPRIO_CLASS_NONE, 0);
1987         req->write_hint = bio->bi_write_hint;
1988         blk_rq_bio_prep(req->q, req, bio);
1989 }
1990 EXPORT_SYMBOL_GPL(blk_init_request_from_bio);
1991
1992 static blk_qc_t blk_queue_bio(struct request_queue *q, struct bio *bio)
1993 {
1994         struct blk_plug *plug;
1995         int where = ELEVATOR_INSERT_SORT;
1996         struct request *req, *free;
1997         unsigned int request_count = 0;
1998
1999         /*
2000          * low level driver can indicate that it wants pages above a
2001          * certain limit bounced to low memory (ie for highmem, or even
2002          * ISA dma in theory)
2003          */
2004         blk_queue_bounce(q, &bio);
2005
2006         blk_queue_split(q, &bio);
2007
2008         if (!bio_integrity_prep(bio))
2009                 return BLK_QC_T_NONE;
2010
2011         if (op_is_flush(bio->bi_opf)) {
2012                 spin_lock_irq(q->queue_lock);
2013                 where = ELEVATOR_INSERT_FLUSH;
2014                 goto get_rq;
2015         }
2016
2017         /*
2018          * Check if we can merge with the plugged list before grabbing
2019          * any locks.
2020          */
2021         if (!blk_queue_nomerges(q)) {
2022                 if (blk_attempt_plug_merge(q, bio, &request_count, NULL))
2023                         return BLK_QC_T_NONE;
2024         } else
2025                 request_count = blk_plug_queued_count(q);
2026
2027         spin_lock_irq(q->queue_lock);
2028
2029         switch (elv_merge(q, &req, bio)) {
2030         case ELEVATOR_BACK_MERGE:
2031                 if (!bio_attempt_back_merge(q, req, bio))
2032                         break;
2033                 elv_bio_merged(q, req, bio);
2034                 free = attempt_back_merge(q, req);
2035                 if (free)
2036                         __blk_put_request(q, free);
2037                 else
2038                         elv_merged_request(q, req, ELEVATOR_BACK_MERGE);
2039                 goto out_unlock;
2040         case ELEVATOR_FRONT_MERGE:
2041                 if (!bio_attempt_front_merge(q, req, bio))
2042                         break;
2043                 elv_bio_merged(q, req, bio);
2044                 free = attempt_front_merge(q, req);
2045                 if (free)
2046                         __blk_put_request(q, free);
2047                 else
2048                         elv_merged_request(q, req, ELEVATOR_FRONT_MERGE);
2049                 goto out_unlock;
2050         default:
2051                 break;
2052         }
2053
2054 get_rq:
2055         rq_qos_throttle(q, bio, q->queue_lock);
2056
2057         /*
2058          * Grab a free request. This is might sleep but can not fail.
2059          * Returns with the queue unlocked.
2060          */
2061         blk_queue_enter_live(q);
2062         req = get_request(q, bio->bi_opf, bio, 0, GFP_NOIO);
2063         if (IS_ERR(req)) {
2064                 blk_queue_exit(q);
2065                 rq_qos_cleanup(q, bio);
2066                 if (PTR_ERR(req) == -ENOMEM)
2067                         bio->bi_status = BLK_STS_RESOURCE;
2068                 else
2069                         bio->bi_status = BLK_STS_IOERR;
2070                 bio_endio(bio);
2071                 goto out_unlock;
2072         }
2073
2074         rq_qos_track(q, req, bio);
2075
2076         /*
2077          * After dropping the lock and possibly sleeping here, our request
2078          * may now be mergeable after it had proven unmergeable (above).
2079          * We don't worry about that case for efficiency. It won't happen
2080          * often, and the elevators are able to handle it.
2081          */
2082         blk_init_request_from_bio(req, bio);
2083
2084         if (test_bit(QUEUE_FLAG_SAME_COMP, &q->queue_flags))
2085                 req->cpu = raw_smp_processor_id();
2086
2087         plug = current->plug;
2088         if (plug) {
2089                 /*
2090                  * If this is the first request added after a plug, fire
2091                  * of a plug trace.
2092                  *
2093                  * @request_count may become stale because of schedule
2094                  * out, so check plug list again.
2095                  */
2096                 if (!request_count || list_empty(&plug->list))
2097                         trace_block_plug(q);
2098                 else {
2099                         struct request *last = list_entry_rq(plug->list.prev);
2100                         if (request_count >= BLK_MAX_REQUEST_COUNT ||
2101                             blk_rq_bytes(last) >= BLK_PLUG_FLUSH_SIZE) {
2102                                 blk_flush_plug_list(plug, false);
2103                                 trace_block_plug(q);
2104                         }
2105                 }
2106                 list_add_tail(&req->queuelist, &plug->list);
2107                 blk_account_io_start(req, true);
2108         } else {
2109                 spin_lock_irq(q->queue_lock);
2110                 add_acct_request(q, req, where);
2111                 __blk_run_queue(q);
2112 out_unlock:
2113                 spin_unlock_irq(q->queue_lock);
2114         }
2115
2116         return BLK_QC_T_NONE;
2117 }
2118
2119 static void handle_bad_sector(struct bio *bio, sector_t maxsector)
2120 {
2121         char b[BDEVNAME_SIZE];
2122
2123         printk(KERN_INFO "attempt to access beyond end of device\n");
2124         printk(KERN_INFO "%s: rw=%d, want=%Lu, limit=%Lu\n",
2125                         bio_devname(bio, b), bio->bi_opf,
2126                         (unsigned long long)bio_end_sector(bio),
2127                         (long long)maxsector);
2128 }
2129
2130 #ifdef CONFIG_FAIL_MAKE_REQUEST
2131
2132 static DECLARE_FAULT_ATTR(fail_make_request);
2133
2134 static int __init setup_fail_make_request(char *str)
2135 {
2136         return setup_fault_attr(&fail_make_request, str);
2137 }
2138 __setup("fail_make_request=", setup_fail_make_request);
2139
2140 static bool should_fail_request(struct hd_struct *part, unsigned int bytes)
2141 {
2142         return part->make_it_fail && should_fail(&fail_make_request, bytes);
2143 }
2144
2145 static int __init fail_make_request_debugfs(void)
2146 {
2147         struct dentry *dir = fault_create_debugfs_attr("fail_make_request",
2148                                                 NULL, &fail_make_request);
2149
2150         return PTR_ERR_OR_ZERO(dir);
2151 }
2152
2153 late_initcall(fail_make_request_debugfs);
2154
2155 #else /* CONFIG_FAIL_MAKE_REQUEST */
2156
2157 static inline bool should_fail_request(struct hd_struct *part,
2158                                         unsigned int bytes)
2159 {
2160         return false;
2161 }
2162
2163 #endif /* CONFIG_FAIL_MAKE_REQUEST */
2164
2165 static inline bool bio_check_ro(struct bio *bio, struct hd_struct *part)
2166 {
2167         const int op = bio_op(bio);
2168
2169         if (part->policy && op_is_write(op)) {
2170                 char b[BDEVNAME_SIZE];
2171
2172                 if (op_is_flush(bio->bi_opf) && !bio_sectors(bio))
2173                         return false;
2174
2175                 WARN_ONCE(1,
2176                        "generic_make_request: Trying to write "
2177                         "to read-only block-device %s (partno %d)\n",
2178                         bio_devname(bio, b), part->partno);
2179                 /* Older lvm-tools actually trigger this */
2180                 return false;
2181         }
2182
2183         return false;
2184 }
2185
2186 static noinline int should_fail_bio(struct bio *bio)
2187 {
2188         if (should_fail_request(&bio->bi_disk->part0, bio->bi_iter.bi_size))
2189                 return -EIO;
2190         return 0;
2191 }
2192 ALLOW_ERROR_INJECTION(should_fail_bio, ERRNO);
2193
2194 /*
2195  * Check whether this bio extends beyond the end of the device or partition.
2196  * This may well happen - the kernel calls bread() without checking the size of
2197  * the device, e.g., when mounting a file system.
2198  */
2199 static inline int bio_check_eod(struct bio *bio, sector_t maxsector)
2200 {
2201         unsigned int nr_sectors = bio_sectors(bio);
2202
2203         if (nr_sectors && maxsector &&
2204             (nr_sectors > maxsector ||
2205              bio->bi_iter.bi_sector > maxsector - nr_sectors)) {
2206                 handle_bad_sector(bio, maxsector);
2207                 return -EIO;
2208         }
2209         return 0;
2210 }
2211
2212 /*
2213  * Remap block n of partition p to block n+start(p) of the disk.
2214  */
2215 static inline int blk_partition_remap(struct bio *bio)
2216 {
2217         struct hd_struct *p;
2218         int ret = -EIO;
2219
2220         rcu_read_lock();
2221         p = __disk_get_part(bio->bi_disk, bio->bi_partno);
2222         if (unlikely(!p))
2223                 goto out;
2224         if (unlikely(should_fail_request(p, bio->bi_iter.bi_size)))
2225                 goto out;
2226         if (unlikely(bio_check_ro(bio, p)))
2227                 goto out;
2228
2229         /*
2230          * Zone reset does not include bi_size so bio_sectors() is always 0.
2231          * Include a test for the reset op code and perform the remap if needed.
2232          */
2233         if (bio_sectors(bio) || bio_op(bio) == REQ_OP_ZONE_RESET) {
2234                 if (bio_check_eod(bio, part_nr_sects_read(p)))
2235                         goto out;
2236                 bio->bi_iter.bi_sector += p->start_sect;
2237                 trace_block_bio_remap(bio->bi_disk->queue, bio, part_devt(p),
2238                                       bio->bi_iter.bi_sector - p->start_sect);
2239         }
2240         bio->bi_partno = 0;
2241         ret = 0;
2242 out:
2243         rcu_read_unlock();
2244         return ret;
2245 }
2246
2247 static noinline_for_stack bool
2248 generic_make_request_checks(struct bio *bio)
2249 {
2250         struct request_queue *q;
2251         int nr_sectors = bio_sectors(bio);
2252         blk_status_t status = BLK_STS_IOERR;
2253         char b[BDEVNAME_SIZE];
2254
2255         might_sleep();
2256
2257         q = bio->bi_disk->queue;
2258         if (unlikely(!q)) {
2259                 printk(KERN_ERR
2260                        "generic_make_request: Trying to access "
2261                         "nonexistent block-device %s (%Lu)\n",
2262                         bio_devname(bio, b), (long long)bio->bi_iter.bi_sector);
2263                 goto end_io;
2264         }
2265
2266         /*
2267          * For a REQ_NOWAIT based request, return -EOPNOTSUPP
2268          * if queue is not a request based queue.
2269          */
2270         if ((bio->bi_opf & REQ_NOWAIT) && !queue_is_rq_based(q))
2271                 goto not_supported;
2272
2273         if (should_fail_bio(bio))
2274                 goto end_io;
2275
2276         if (bio->bi_partno) {
2277                 if (unlikely(blk_partition_remap(bio)))
2278                         goto end_io;
2279         } else {
2280                 if (unlikely(bio_check_ro(bio, &bio->bi_disk->part0)))
2281                         goto end_io;
2282                 if (unlikely(bio_check_eod(bio, get_capacity(bio->bi_disk))))
2283                         goto end_io;
2284         }
2285
2286         /*
2287          * Filter flush bio's early so that make_request based
2288          * drivers without flush support don't have to worry
2289          * about them.
2290          */
2291         if (op_is_flush(bio->bi_opf) &&
2292             !test_bit(QUEUE_FLAG_WC, &q->queue_flags)) {
2293                 bio->bi_opf &= ~(REQ_PREFLUSH | REQ_FUA);
2294                 if (!nr_sectors) {
2295                         status = BLK_STS_OK;
2296                         goto end_io;
2297                 }
2298         }
2299
2300         switch (bio_op(bio)) {
2301         case REQ_OP_DISCARD:
2302                 if (!blk_queue_discard(q))
2303                         goto not_supported;
2304                 break;
2305         case REQ_OP_SECURE_ERASE:
2306                 if (!blk_queue_secure_erase(q))
2307                         goto not_supported;
2308                 break;
2309         case REQ_OP_WRITE_SAME:
2310                 if (!q->limits.max_write_same_sectors)
2311                         goto not_supported;
2312                 break;
2313         case REQ_OP_ZONE_REPORT:
2314         case REQ_OP_ZONE_RESET:
2315                 if (!blk_queue_is_zoned(q))
2316                         goto not_supported;
2317                 break;
2318         case REQ_OP_WRITE_ZEROES:
2319                 if (!q->limits.max_write_zeroes_sectors)
2320                         goto not_supported;
2321                 break;
2322         default:
2323                 break;
2324         }
2325
2326         /*
2327          * Various block parts want %current->io_context and lazy ioc
2328          * allocation ends up trading a lot of pain for a small amount of
2329          * memory.  Just allocate it upfront.  This may fail and block
2330          * layer knows how to live with it.
2331          */
2332         create_io_context(GFP_ATOMIC, q->node);
2333
2334         if (!blkcg_bio_issue_check(q, bio))
2335                 return false;
2336
2337         if (!bio_flagged(bio, BIO_TRACE_COMPLETION)) {
2338                 trace_block_bio_queue(q, bio);
2339                 /* Now that enqueuing has been traced, we need to trace
2340                  * completion as well.
2341                  */
2342                 bio_set_flag(bio, BIO_TRACE_COMPLETION);
2343         }
2344         return true;
2345
2346 not_supported:
2347         status = BLK_STS_NOTSUPP;
2348 end_io:
2349         bio->bi_status = status;
2350         bio_endio(bio);
2351         return false;
2352 }
2353
2354 /**
2355  * generic_make_request - hand a buffer to its device driver for I/O
2356  * @bio:  The bio describing the location in memory and on the device.
2357  *
2358  * generic_make_request() is used to make I/O requests of block
2359  * devices. It is passed a &struct bio, which describes the I/O that needs
2360  * to be done.
2361  *
2362  * generic_make_request() does not return any status.  The
2363  * success/failure status of the request, along with notification of
2364  * completion, is delivered asynchronously through the bio->bi_end_io
2365  * function described (one day) else where.
2366  *
2367  * The caller of generic_make_request must make sure that bi_io_vec
2368  * are set to describe the memory buffer, and that bi_dev and bi_sector are
2369  * set to describe the device address, and the
2370  * bi_end_io and optionally bi_private are set to describe how
2371  * completion notification should be signaled.
2372  *
2373  * generic_make_request and the drivers it calls may use bi_next if this
2374  * bio happens to be merged with someone else, and may resubmit the bio to
2375  * a lower device by calling into generic_make_request recursively, which
2376  * means the bio should NOT be touched after the call to ->make_request_fn.
2377  */
2378 blk_qc_t generic_make_request(struct bio *bio)
2379 {
2380         /*
2381          * bio_list_on_stack[0] contains bios submitted by the current
2382          * make_request_fn.
2383          * bio_list_on_stack[1] contains bios that were submitted before
2384          * the current make_request_fn, but that haven't been processed
2385          * yet.
2386          */
2387         struct bio_list bio_list_on_stack[2];
2388         blk_mq_req_flags_t flags = 0;
2389         struct request_queue *q = bio->bi_disk->queue;
2390         blk_qc_t ret = BLK_QC_T_NONE;
2391
2392         if (bio->bi_opf & REQ_NOWAIT)
2393                 flags = BLK_MQ_REQ_NOWAIT;
2394         if (bio_flagged(bio, BIO_QUEUE_ENTERED))
2395                 blk_queue_enter_live(q);
2396         else if (blk_queue_enter(q, flags) < 0) {
2397                 if (!blk_queue_dying(q) && (bio->bi_opf & REQ_NOWAIT))
2398                         bio_wouldblock_error(bio);
2399                 else
2400                         bio_io_error(bio);
2401                 return ret;
2402         }
2403
2404         if (!generic_make_request_checks(bio))
2405                 goto out;
2406
2407         /*
2408          * We only want one ->make_request_fn to be active at a time, else
2409          * stack usage with stacked devices could be a problem.  So use
2410          * current->bio_list to keep a list of requests submited by a
2411          * make_request_fn function.  current->bio_list is also used as a
2412          * flag to say if generic_make_request is currently active in this
2413          * task or not.  If it is NULL, then no make_request is active.  If
2414          * it is non-NULL, then a make_request is active, and new requests
2415          * should be added at the tail
2416          */
2417         if (current->bio_list) {
2418                 bio_list_add(&current->bio_list[0], bio);
2419                 goto out;
2420         }
2421
2422         /* following loop may be a bit non-obvious, and so deserves some
2423          * explanation.
2424          * Before entering the loop, bio->bi_next is NULL (as all callers
2425          * ensure that) so we have a list with a single bio.
2426          * We pretend that we have just taken it off a longer list, so
2427          * we assign bio_list to a pointer to the bio_list_on_stack,
2428          * thus initialising the bio_list of new bios to be
2429          * added.  ->make_request() may indeed add some more bios
2430          * through a recursive call to generic_make_request.  If it
2431          * did, we find a non-NULL value in bio_list and re-enter the loop
2432          * from the top.  In this case we really did just take the bio
2433          * of the top of the list (no pretending) and so remove it from
2434          * bio_list, and call into ->make_request() again.
2435          */
2436         BUG_ON(bio->bi_next);
2437         bio_list_init(&bio_list_on_stack[0]);
2438         current->bio_list = bio_list_on_stack;
2439         do {
2440                 bool enter_succeeded = true;
2441
2442                 if (unlikely(q != bio->bi_disk->queue)) {
2443                         if (q)
2444                                 blk_queue_exit(q);
2445                         q = bio->bi_disk->queue;
2446                         flags = 0;
2447                         if (bio->bi_opf & REQ_NOWAIT)
2448                                 flags = BLK_MQ_REQ_NOWAIT;
2449                         if (blk_queue_enter(q, flags) < 0) {
2450                                 enter_succeeded = false;
2451                                 q = NULL;
2452                         }
2453                 }
2454
2455                 if (enter_succeeded) {
2456                         struct bio_list lower, same;
2457
2458                         /* Create a fresh bio_list for all subordinate requests */
2459                         bio_list_on_stack[1] = bio_list_on_stack[0];
2460                         bio_list_init(&bio_list_on_stack[0]);
2461                         ret = q->make_request_fn(q, bio);
2462
2463                         /* sort new bios into those for a lower level
2464                          * and those for the same level
2465                          */
2466                         bio_list_init(&lower);
2467                         bio_list_init(&same);
2468                         while ((bio = bio_list_pop(&bio_list_on_stack[0])) != NULL)
2469                                 if (q == bio->bi_disk->queue)
2470                                         bio_list_add(&same, bio);
2471                                 else
2472                                         bio_list_add(&lower, bio);
2473                         /* now assemble so we handle the lowest level first */
2474                         bio_list_merge(&bio_list_on_stack[0], &lower);
2475                         bio_list_merge(&bio_list_on_stack[0], &same);
2476                         bio_list_merge(&bio_list_on_stack[0], &bio_list_on_stack[1]);
2477                 } else {
2478                         if (unlikely(!blk_queue_dying(q) &&
2479                                         (bio->bi_opf & REQ_NOWAIT)))
2480                                 bio_wouldblock_error(bio);
2481                         else
2482                                 bio_io_error(bio);
2483                 }
2484                 bio = bio_list_pop(&bio_list_on_stack[0]);
2485         } while (bio);
2486         current->bio_list = NULL; /* deactivate */
2487
2488 out:
2489         if (q)
2490                 blk_queue_exit(q);
2491         return ret;
2492 }
2493 EXPORT_SYMBOL(generic_make_request);
2494
2495 /**
2496  * direct_make_request - hand a buffer directly to its device driver for I/O
2497  * @bio:  The bio describing the location in memory and on the device.
2498  *
2499  * This function behaves like generic_make_request(), but does not protect
2500  * against recursion.  Must only be used if the called driver is known
2501  * to not call generic_make_request (or direct_make_request) again from
2502  * its make_request function.  (Calling direct_make_request again from
2503  * a workqueue is perfectly fine as that doesn't recurse).
2504  */
2505 blk_qc_t direct_make_request(struct bio *bio)
2506 {
2507         struct request_queue *q = bio->bi_disk->queue;
2508         bool nowait = bio->bi_opf & REQ_NOWAIT;
2509         blk_qc_t ret;
2510
2511         if (!generic_make_request_checks(bio))
2512                 return BLK_QC_T_NONE;
2513
2514         if (unlikely(blk_queue_enter(q, nowait ? BLK_MQ_REQ_NOWAIT : 0))) {
2515                 if (nowait && !blk_queue_dying(q))
2516                         bio->bi_status = BLK_STS_AGAIN;
2517                 else
2518                         bio->bi_status = BLK_STS_IOERR;
2519                 bio_endio(bio);
2520                 return BLK_QC_T_NONE;
2521         }
2522
2523         ret = q->make_request_fn(q, bio);
2524         blk_queue_exit(q);
2525         return ret;
2526 }
2527 EXPORT_SYMBOL_GPL(direct_make_request);
2528
2529 /**
2530  * submit_bio - submit a bio to the block device layer for I/O
2531  * @bio: The &struct bio which describes the I/O
2532  *
2533  * submit_bio() is very similar in purpose to generic_make_request(), and
2534  * uses that function to do most of the work. Both are fairly rough
2535  * interfaces; @bio must be presetup and ready for I/O.
2536  *
2537  */
2538 blk_qc_t submit_bio(struct bio *bio)
2539 {
2540         /*
2541          * If it's a regular read/write or a barrier with data attached,
2542          * go through the normal accounting stuff before submission.
2543          */
2544         if (bio_has_data(bio)) {
2545                 unsigned int count;
2546
2547                 if (unlikely(bio_op(bio) == REQ_OP_WRITE_SAME))
2548                         count = queue_logical_block_size(bio->bi_disk->queue) >> 9;
2549                 else
2550                         count = bio_sectors(bio);
2551
2552                 if (op_is_write(bio_op(bio))) {
2553                         count_vm_events(PGPGOUT, count);
2554                 } else {
2555                         task_io_account_read(bio->bi_iter.bi_size);
2556                         count_vm_events(PGPGIN, count);
2557                 }
2558
2559                 if (unlikely(block_dump)) {
2560                         char b[BDEVNAME_SIZE];
2561                         printk(KERN_DEBUG "%s(%d): %s block %Lu on %s (%u sectors)\n",
2562                         current->comm, task_pid_nr(current),
2563                                 op_is_write(bio_op(bio)) ? "WRITE" : "READ",
2564                                 (unsigned long long)bio->bi_iter.bi_sector,
2565                                 bio_devname(bio, b), count);
2566                 }
2567         }
2568
2569         return generic_make_request(bio);
2570 }
2571 EXPORT_SYMBOL(submit_bio);
2572
2573 bool blk_poll(struct request_queue *q, blk_qc_t cookie)
2574 {
2575         if (!q->poll_fn || !blk_qc_t_valid(cookie))
2576                 return false;
2577
2578         if (current->plug)
2579                 blk_flush_plug_list(current->plug, false);
2580         return q->poll_fn(q, cookie);
2581 }
2582 EXPORT_SYMBOL_GPL(blk_poll);
2583
2584 /**
2585  * blk_cloned_rq_check_limits - Helper function to check a cloned request
2586  *                              for new the queue limits
2587  * @q:  the queue
2588  * @rq: the request being checked
2589  *
2590  * Description:
2591  *    @rq may have been made based on weaker limitations of upper-level queues
2592  *    in request stacking drivers, and it may violate the limitation of @q.
2593  *    Since the block layer and the underlying device driver trust @rq
2594  *    after it is inserted to @q, it should be checked against @q before
2595  *    the insertion using this generic function.
2596  *
2597  *    Request stacking drivers like request-based dm may change the queue
2598  *    limits when retrying requests on other queues. Those requests need
2599  *    to be checked against the new queue limits again during dispatch.
2600  */
2601 static int blk_cloned_rq_check_limits(struct request_queue *q,
2602                                       struct request *rq)
2603 {
2604         if (blk_rq_sectors(rq) > blk_queue_get_max_sectors(q, req_op(rq))) {
2605                 printk(KERN_ERR "%s: over max size limit.\n", __func__);
2606                 return -EIO;
2607         }
2608
2609         /*
2610          * queue's settings related to segment counting like q->bounce_pfn
2611          * may differ from that of other stacking queues.
2612          * Recalculate it to check the request correctly on this queue's
2613          * limitation.
2614          */
2615         blk_recalc_rq_segments(rq);
2616         if (rq->nr_phys_segments > queue_max_segments(q)) {
2617                 printk(KERN_ERR "%s: over max segments limit.\n", __func__);
2618                 return -EIO;
2619         }
2620
2621         return 0;
2622 }
2623
2624 /**
2625  * blk_insert_cloned_request - Helper for stacking drivers to submit a request
2626  * @q:  the queue to submit the request
2627  * @rq: the request being queued
2628  */
2629 blk_status_t blk_insert_cloned_request(struct request_queue *q, struct request *rq)
2630 {
2631         unsigned long flags;
2632         int where = ELEVATOR_INSERT_BACK;
2633
2634         if (blk_cloned_rq_check_limits(q, rq))
2635                 return BLK_STS_IOERR;
2636
2637         if (rq->rq_disk &&
2638             should_fail_request(&rq->rq_disk->part0, blk_rq_bytes(rq)))
2639                 return BLK_STS_IOERR;
2640
2641         if (q->mq_ops) {
2642                 if (blk_queue_io_stat(q))
2643                         blk_account_io_start(rq, true);
2644                 /*
2645                  * Since we have a scheduler attached on the top device,
2646                  * bypass a potential scheduler on the bottom device for
2647                  * insert.
2648                  */
2649                 return blk_mq_request_issue_directly(rq);
2650         }
2651
2652         spin_lock_irqsave(q->queue_lock, flags);
2653         if (unlikely(blk_queue_dying(q))) {
2654                 spin_unlock_irqrestore(q->queue_lock, flags);
2655                 return BLK_STS_IOERR;
2656         }
2657
2658         /*
2659          * Submitting request must be dequeued before calling this function
2660          * because it will be linked to another request_queue
2661          */
2662         BUG_ON(blk_queued_rq(rq));
2663
2664         if (op_is_flush(rq->cmd_flags))
2665                 where = ELEVATOR_INSERT_FLUSH;
2666
2667         add_acct_request(q, rq, where);
2668         if (where == ELEVATOR_INSERT_FLUSH)
2669                 __blk_run_queue(q);
2670         spin_unlock_irqrestore(q->queue_lock, flags);
2671
2672         return BLK_STS_OK;
2673 }
2674 EXPORT_SYMBOL_GPL(blk_insert_cloned_request);
2675
2676 /**
2677  * blk_rq_err_bytes - determine number of bytes till the next failure boundary
2678  * @rq: request to examine
2679  *
2680  * Description:
2681  *     A request could be merge of IOs which require different failure
2682  *     handling.  This function determines the number of bytes which
2683  *     can be failed from the beginning of the request without
2684  *     crossing into area which need to be retried further.
2685  *
2686  * Return:
2687  *     The number of bytes to fail.
2688  */
2689 unsigned int blk_rq_err_bytes(const struct request *rq)
2690 {
2691         unsigned int ff = rq->cmd_flags & REQ_FAILFAST_MASK;
2692         unsigned int bytes = 0;
2693         struct bio *bio;
2694
2695         if (!(rq->rq_flags & RQF_MIXED_MERGE))
2696                 return blk_rq_bytes(rq);
2697
2698         /*
2699          * Currently the only 'mixing' which can happen is between
2700          * different fastfail types.  We can safely fail portions
2701          * which have all the failfast bits that the first one has -
2702          * the ones which are at least as eager to fail as the first
2703          * one.
2704          */
2705         for (bio = rq->bio; bio; bio = bio->bi_next) {
2706                 if ((bio->bi_opf & ff) != ff)
2707                         break;
2708                 bytes += bio->bi_iter.bi_size;
2709         }
2710
2711         /* this could lead to infinite loop */
2712         BUG_ON(blk_rq_bytes(rq) && !bytes);
2713         return bytes;
2714 }
2715 EXPORT_SYMBOL_GPL(blk_rq_err_bytes);
2716
2717 void blk_account_io_completion(struct request *req, unsigned int bytes)
2718 {
2719         if (blk_do_io_stat(req)) {
2720                 const int sgrp = op_stat_group(req_op(req));
2721                 struct hd_struct *part;
2722                 int cpu;
2723
2724                 cpu = part_stat_lock();
2725                 part = req->part;
2726                 part_stat_add(cpu, part, sectors[sgrp], bytes >> 9);
2727                 part_stat_unlock();
2728         }
2729 }
2730
2731 void blk_account_io_done(struct request *req, u64 now)
2732 {
2733         /*
2734          * Account IO completion.  flush_rq isn't accounted as a
2735          * normal IO on queueing nor completion.  Accounting the
2736          * containing request is enough.
2737          */
2738         if (blk_do_io_stat(req) && !(req->rq_flags & RQF_FLUSH_SEQ)) {
2739                 const int sgrp = op_stat_group(req_op(req));
2740                 struct hd_struct *part;
2741                 int cpu;
2742
2743                 cpu = part_stat_lock();
2744                 part = req->part;
2745
2746                 part_stat_inc(cpu, part, ios[sgrp]);
2747                 part_stat_add(cpu, part, nsecs[sgrp], now - req->start_time_ns);
2748                 part_round_stats(req->q, cpu, part);
2749                 part_dec_in_flight(req->q, part, rq_data_dir(req));
2750
2751                 hd_struct_put(part);
2752                 part_stat_unlock();
2753         }
2754 }
2755
2756 #ifdef CONFIG_PM
2757 /*
2758  * Don't process normal requests when queue is suspended
2759  * or in the process of suspending/resuming
2760  */
2761 static bool blk_pm_allow_request(struct request *rq)
2762 {
2763         switch (rq->q->rpm_status) {
2764         case RPM_RESUMING:
2765         case RPM_SUSPENDING:
2766                 return rq->rq_flags & RQF_PM;
2767         case RPM_SUSPENDED:
2768                 return false;
2769         default:
2770                 return true;
2771         }
2772 }
2773 #else
2774 static bool blk_pm_allow_request(struct request *rq)
2775 {
2776         return true;
2777 }
2778 #endif
2779
2780 void blk_account_io_start(struct request *rq, bool new_io)
2781 {
2782         struct hd_struct *part;
2783         int rw = rq_data_dir(rq);
2784         int cpu;
2785
2786         if (!blk_do_io_stat(rq))
2787                 return;
2788
2789         cpu = part_stat_lock();
2790
2791         if (!new_io) {
2792                 part = rq->part;
2793                 part_stat_inc(cpu, part, merges[rw]);
2794         } else {
2795                 part = disk_map_sector_rcu(rq->rq_disk, blk_rq_pos(rq));
2796                 if (!hd_struct_try_get(part)) {
2797                         /*
2798                          * The partition is already being removed,
2799                          * the request will be accounted on the disk only
2800                          *
2801                          * We take a reference on disk->part0 although that
2802                          * partition will never be deleted, so we can treat
2803                          * it as any other partition.
2804                          */
2805                         part = &rq->rq_disk->part0;
2806                         hd_struct_get(part);
2807                 }
2808                 part_round_stats(rq->q, cpu, part);
2809                 part_inc_in_flight(rq->q, part, rw);
2810                 rq->part = part;
2811         }
2812
2813         part_stat_unlock();
2814 }
2815
2816 static struct request *elv_next_request(struct request_queue *q)
2817 {
2818         struct request *rq;
2819         struct blk_flush_queue *fq = blk_get_flush_queue(q, NULL);
2820
2821         WARN_ON_ONCE(q->mq_ops);
2822
2823         while (1) {
2824                 list_for_each_entry(rq, &q->queue_head, queuelist) {
2825                         if (blk_pm_allow_request(rq))
2826                                 return rq;
2827
2828                         if (rq->rq_flags & RQF_SOFTBARRIER)
2829                                 break;
2830                 }
2831
2832                 /*
2833                  * Flush request is running and flush request isn't queueable
2834                  * in the drive, we can hold the queue till flush request is
2835                  * finished. Even we don't do this, driver can't dispatch next
2836                  * requests and will requeue them. And this can improve
2837                  * throughput too. For example, we have request flush1, write1,
2838                  * flush 2. flush1 is dispatched, then queue is hold, write1
2839                  * isn't inserted to queue. After flush1 is finished, flush2
2840                  * will be dispatched. Since disk cache is already clean,
2841                  * flush2 will be finished very soon, so looks like flush2 is
2842                  * folded to flush1.
2843                  * Since the queue is hold, a flag is set to indicate the queue
2844                  * should be restarted later. Please see flush_end_io() for
2845                  * details.
2846                  */
2847                 if (fq->flush_pending_idx != fq->flush_running_idx &&
2848                                 !queue_flush_queueable(q)) {
2849                         fq->flush_queue_delayed = 1;
2850                         return NULL;
2851                 }
2852                 if (unlikely(blk_queue_bypass(q)) ||
2853                     !q->elevator->type->ops.sq.elevator_dispatch_fn(q, 0))
2854                         return NULL;
2855         }
2856 }
2857
2858 /**
2859  * blk_peek_request - peek at the top of a request queue
2860  * @q: request queue to peek at
2861  *
2862  * Description:
2863  *     Return the request at the top of @q.  The returned request
2864  *     should be started using blk_start_request() before LLD starts
2865  *     processing it.
2866  *
2867  * Return:
2868  *     Pointer to the request at the top of @q if available.  Null
2869  *     otherwise.
2870  */
2871 struct request *blk_peek_request(struct request_queue *q)
2872 {
2873         struct request *rq;
2874         int ret;
2875
2876         lockdep_assert_held(q->queue_lock);
2877         WARN_ON_ONCE(q->mq_ops);
2878
2879         while ((rq = elv_next_request(q)) != NULL) {
2880                 if (!(rq->rq_flags & RQF_STARTED)) {
2881                         /*
2882                          * This is the first time the device driver
2883                          * sees this request (possibly after
2884                          * requeueing).  Notify IO scheduler.
2885                          */
2886                         if (rq->rq_flags & RQF_SORTED)
2887                                 elv_activate_rq(q, rq);
2888
2889                         /*
2890                          * just mark as started even if we don't start
2891                          * it, a request that has been delayed should
2892                          * not be passed by new incoming requests
2893                          */
2894                         rq->rq_flags |= RQF_STARTED;
2895                         trace_block_rq_issue(q, rq);
2896                 }
2897
2898                 if (!q->boundary_rq || q->boundary_rq == rq) {
2899                         q->end_sector = rq_end_sector(rq);
2900                         q->boundary_rq = NULL;
2901                 }
2902
2903                 if (rq->rq_flags & RQF_DONTPREP)
2904                         break;
2905
2906                 if (q->dma_drain_size && blk_rq_bytes(rq)) {
2907                         /*
2908                          * make sure space for the drain appears we
2909                          * know we can do this because max_hw_segments
2910                          * has been adjusted to be one fewer than the
2911                          * device can handle
2912                          */
2913                         rq->nr_phys_segments++;
2914                 }
2915
2916                 if (!q->prep_rq_fn)
2917                         break;
2918
2919                 ret = q->prep_rq_fn(q, rq);
2920                 if (ret == BLKPREP_OK) {
2921                         break;
2922                 } else if (ret == BLKPREP_DEFER) {
2923                         /*
2924                          * the request may have been (partially) prepped.
2925                          * we need to keep this request in the front to
2926                          * avoid resource deadlock.  RQF_STARTED will
2927                          * prevent other fs requests from passing this one.
2928                          */
2929                         if (q->dma_drain_size && blk_rq_bytes(rq) &&
2930                             !(rq->rq_flags & RQF_DONTPREP)) {
2931                                 /*
2932                                  * remove the space for the drain we added
2933                                  * so that we don't add it again
2934                                  */
2935                                 --rq->nr_phys_segments;
2936                         }
2937
2938                         rq = NULL;
2939                         break;
2940                 } else if (ret == BLKPREP_KILL || ret == BLKPREP_INVALID) {
2941                         rq->rq_flags |= RQF_QUIET;
2942                         /*
2943                          * Mark this request as started so we don't trigger
2944                          * any debug logic in the end I/O path.
2945                          */
2946                         blk_start_request(rq);
2947                         __blk_end_request_all(rq, ret == BLKPREP_INVALID ?
2948                                         BLK_STS_TARGET : BLK_STS_IOERR);
2949                 } else {
2950                         printk(KERN_ERR "%s: bad return=%d\n", __func__, ret);
2951                         break;
2952                 }
2953         }
2954
2955         return rq;
2956 }
2957 EXPORT_SYMBOL(blk_peek_request);
2958
2959 static void blk_dequeue_request(struct request *rq)
2960 {
2961         struct request_queue *q = rq->q;
2962
2963         BUG_ON(list_empty(&rq->queuelist));
2964         BUG_ON(ELV_ON_HASH(rq));
2965
2966         list_del_init(&rq->queuelist);
2967
2968         /*
2969          * the time frame between a request being removed from the lists
2970          * and to it is freed is accounted as io that is in progress at
2971          * the driver side.
2972          */
2973         if (blk_account_rq(rq))
2974                 q->in_flight[rq_is_sync(rq)]++;
2975 }
2976
2977 /**
2978  * blk_start_request - start request processing on the driver
2979  * @req: request to dequeue
2980  *
2981  * Description:
2982  *     Dequeue @req and start timeout timer on it.  This hands off the
2983  *     request to the driver.
2984  */
2985 void blk_start_request(struct request *req)
2986 {
2987         lockdep_assert_held(req->q->queue_lock);
2988         WARN_ON_ONCE(req->q->mq_ops);
2989
2990         blk_dequeue_request(req);
2991
2992         if (test_bit(QUEUE_FLAG_STATS, &req->q->queue_flags)) {
2993                 req->io_start_time_ns = ktime_get_ns();
2994 #ifdef CONFIG_BLK_DEV_THROTTLING_LOW
2995                 req->throtl_size = blk_rq_sectors(req);
2996 #endif
2997                 req->rq_flags |= RQF_STATS;
2998                 rq_qos_issue(req->q, req);
2999         }
3000
3001         BUG_ON(blk_rq_is_complete(req));
3002         blk_add_timer(req);
3003 }
3004 EXPORT_SYMBOL(blk_start_request);
3005
3006 /**
3007  * blk_fetch_request - fetch a request from a request queue
3008  * @q: request queue to fetch a request from
3009  *
3010  * Description:
3011  *     Return the request at the top of @q.  The request is started on
3012  *     return and LLD can start processing it immediately.
3013  *
3014  * Return:
3015  *     Pointer to the request at the top of @q if available.  Null
3016  *     otherwise.
3017  */
3018 struct request *blk_fetch_request(struct request_queue *q)
3019 {
3020         struct request *rq;
3021
3022         lockdep_assert_held(q->queue_lock);
3023         WARN_ON_ONCE(q->mq_ops);
3024
3025         rq = blk_peek_request(q);
3026         if (rq)
3027                 blk_start_request(rq);
3028         return rq;
3029 }
3030 EXPORT_SYMBOL(blk_fetch_request);
3031
3032 /*
3033  * Steal bios from a request and add them to a bio list.
3034  * The request must not have been partially completed before.
3035  */
3036 void blk_steal_bios(struct bio_list *list, struct request *rq)
3037 {
3038         if (rq->bio) {
3039                 if (list->tail)
3040                         list->tail->bi_next = rq->bio;
3041                 else
3042                         list->head = rq->bio;
3043                 list->tail = rq->biotail;
3044
3045                 rq->bio = NULL;
3046                 rq->biotail = NULL;
3047         }
3048
3049         rq->__data_len = 0;
3050 }
3051 EXPORT_SYMBOL_GPL(blk_steal_bios);
3052
3053 /**
3054  * blk_update_request - Special helper function for request stacking drivers
3055  * @req:      the request being processed
3056  * @error:    block status code
3057  * @nr_bytes: number of bytes to complete @req
3058  *
3059  * Description:
3060  *     Ends I/O on a number of bytes attached to @req, but doesn't complete
3061  *     the request structure even if @req doesn't have leftover.
3062  *     If @req has leftover, sets it up for the next range of segments.
3063  *
3064  *     This special helper function is only for request stacking drivers
3065  *     (e.g. request-based dm) so that they can handle partial completion.
3066  *     Actual device drivers should use blk_end_request instead.
3067  *
3068  *     Passing the result of blk_rq_bytes() as @nr_bytes guarantees
3069  *     %false return from this function.
3070  *
3071  * Note:
3072  *      The RQF_SPECIAL_PAYLOAD flag is ignored on purpose in both
3073  *      blk_rq_bytes() and in blk_update_request().
3074  *
3075  * Return:
3076  *     %false - this request doesn't have any more data
3077  *     %true  - this request has more data
3078  **/
3079 bool blk_update_request(struct request *req, blk_status_t error,
3080                 unsigned int nr_bytes)
3081 {
3082         int total_bytes;
3083
3084         trace_block_rq_complete(req, blk_status_to_errno(error), nr_bytes);
3085
3086         if (!req->bio)
3087                 return false;
3088
3089         if (unlikely(error && !blk_rq_is_passthrough(req) &&
3090                      !(req->rq_flags & RQF_QUIET)))
3091                 print_req_error(req, error);
3092
3093         blk_account_io_completion(req, nr_bytes);
3094
3095         total_bytes = 0;
3096         while (req->bio) {
3097                 struct bio *bio = req->bio;
3098                 unsigned bio_bytes = min(bio->bi_iter.bi_size, nr_bytes);
3099
3100                 if (bio_bytes == bio->bi_iter.bi_size)
3101                         req->bio = bio->bi_next;
3102
3103                 /* Completion has already been traced */
3104                 bio_clear_flag(bio, BIO_TRACE_COMPLETION);
3105                 req_bio_endio(req, bio, bio_bytes, error);
3106
3107                 total_bytes += bio_bytes;
3108                 nr_bytes -= bio_bytes;
3109
3110                 if (!nr_bytes)
3111                         break;
3112         }
3113
3114         /*
3115          * completely done
3116          */
3117         if (!req->bio) {
3118                 /*
3119                  * Reset counters so that the request stacking driver
3120                  * can find how many bytes remain in the request
3121                  * later.
3122                  */
3123                 req->__data_len = 0;
3124                 return false;
3125         }
3126
3127         req->__data_len -= total_bytes;
3128
3129         /* update sector only for requests with clear definition of sector */
3130         if (!blk_rq_is_passthrough(req))
3131                 req->__sector += total_bytes >> 9;
3132
3133         /* mixed attributes always follow the first bio */
3134         if (req->rq_flags & RQF_MIXED_MERGE) {
3135                 req->cmd_flags &= ~REQ_FAILFAST_MASK;
3136                 req->cmd_flags |= req->bio->bi_opf & REQ_FAILFAST_MASK;
3137         }
3138
3139         if (!(req->rq_flags & RQF_SPECIAL_PAYLOAD)) {
3140                 /*
3141                  * If total number of sectors is less than the first segment
3142                  * size, something has gone terribly wrong.
3143                  */
3144                 if (blk_rq_bytes(req) < blk_rq_cur_bytes(req)) {
3145                         blk_dump_rq_flags(req, "request botched");
3146                         req->__data_len = blk_rq_cur_bytes(req);
3147                 }
3148
3149                 /* recalculate the number of segments */
3150                 blk_recalc_rq_segments(req);
3151         }
3152
3153         return true;
3154 }
3155 EXPORT_SYMBOL_GPL(blk_update_request);
3156
3157 static bool blk_update_bidi_request(struct request *rq, blk_status_t error,
3158                                     unsigned int nr_bytes,
3159                                     unsigned int bidi_bytes)
3160 {
3161         if (blk_update_request(rq, error, nr_bytes))
3162                 return true;
3163
3164         /* Bidi request must be completed as a whole */
3165         if (unlikely(blk_bidi_rq(rq)) &&
3166             blk_update_request(rq->next_rq, error, bidi_bytes))
3167                 return true;
3168
3169         if (blk_queue_add_random(rq->q))
3170                 add_disk_randomness(rq->rq_disk);
3171
3172         return false;
3173 }
3174
3175 /**
3176  * blk_unprep_request - unprepare a request
3177  * @req:        the request
3178  *
3179  * This function makes a request ready for complete resubmission (or
3180  * completion).  It happens only after all error handling is complete,
3181  * so represents the appropriate moment to deallocate any resources
3182  * that were allocated to the request in the prep_rq_fn.  The queue
3183  * lock is held when calling this.
3184  */
3185 void blk_unprep_request(struct request *req)
3186 {
3187         struct request_queue *q = req->q;
3188
3189         req->rq_flags &= ~RQF_DONTPREP;
3190         if (q->unprep_rq_fn)
3191                 q->unprep_rq_fn(q, req);
3192 }
3193 EXPORT_SYMBOL_GPL(blk_unprep_request);
3194
3195 void blk_finish_request(struct request *req, blk_status_t error)
3196 {
3197         struct request_queue *q = req->q;
3198         u64 now = ktime_get_ns();
3199
3200         lockdep_assert_held(req->q->queue_lock);
3201         WARN_ON_ONCE(q->mq_ops);
3202
3203         if (req->rq_flags & RQF_STATS)
3204                 blk_stat_add(req, now);
3205
3206         if (req->rq_flags & RQF_QUEUED)
3207                 blk_queue_end_tag(q, req);
3208
3209         BUG_ON(blk_queued_rq(req));
3210
3211         if (unlikely(laptop_mode) && !blk_rq_is_passthrough(req))
3212                 laptop_io_completion(req->q->backing_dev_info);
3213
3214         blk_delete_timer(req);
3215
3216         if (req->rq_flags & RQF_DONTPREP)
3217                 blk_unprep_request(req);
3218
3219         blk_account_io_done(req, now);
3220
3221         if (req->end_io) {
3222                 rq_qos_done(q, req);
3223                 req->end_io(req, error);
3224         } else {
3225                 if (blk_bidi_rq(req))
3226                         __blk_put_request(req->next_rq->q, req->next_rq);
3227
3228                 __blk_put_request(q, req);
3229         }
3230 }
3231 EXPORT_SYMBOL(blk_finish_request);
3232
3233 /**
3234  * blk_end_bidi_request - Complete a bidi request
3235  * @rq:         the request to complete
3236  * @error:      block status code
3237  * @nr_bytes:   number of bytes to complete @rq
3238  * @bidi_bytes: number of bytes to complete @rq->next_rq
3239  *
3240  * Description:
3241  *     Ends I/O on a number of bytes attached to @rq and @rq->next_rq.
3242  *     Drivers that supports bidi can safely call this member for any
3243  *     type of request, bidi or uni.  In the later case @bidi_bytes is
3244  *     just ignored.
3245  *
3246  * Return:
3247  *     %false - we are done with this request
3248  *     %true  - still buffers pending for this request
3249  **/
3250 static bool blk_end_bidi_request(struct request *rq, blk_status_t error,
3251                                  unsigned int nr_bytes, unsigned int bidi_bytes)
3252 {
3253         struct request_queue *q = rq->q;
3254         unsigned long flags;
3255
3256         WARN_ON_ONCE(q->mq_ops);
3257
3258         if (blk_update_bidi_request(rq, error, nr_bytes, bidi_bytes))
3259                 return true;
3260
3261         spin_lock_irqsave(q->queue_lock, flags);
3262         blk_finish_request(rq, error);
3263         spin_unlock_irqrestore(q->queue_lock, flags);
3264
3265         return false;
3266 }
3267
3268 /**
3269  * __blk_end_bidi_request - Complete a bidi request with queue lock held
3270  * @rq:         the request to complete
3271  * @error:      block status code
3272  * @nr_bytes:   number of bytes to complete @rq
3273  * @bidi_bytes: number of bytes to complete @rq->next_rq
3274  *
3275  * Description:
3276  *     Identical to blk_end_bidi_request() except that queue lock is
3277  *     assumed to be locked on entry and remains so on return.
3278  *
3279  * Return:
3280  *     %false - we are done with this request
3281  *     %true  - still buffers pending for this request
3282  **/
3283 static bool __blk_end_bidi_request(struct request *rq, blk_status_t error,
3284                                    unsigned int nr_bytes, unsigned int bidi_bytes)
3285 {
3286         lockdep_assert_held(rq->q->queue_lock);
3287         WARN_ON_ONCE(rq->q->mq_ops);
3288
3289         if (blk_update_bidi_request(rq, error, nr_bytes, bidi_bytes))
3290                 return true;
3291
3292         blk_finish_request(rq, error);
3293
3294         return false;
3295 }
3296
3297 /**
3298  * blk_end_request - Helper function for drivers to complete the request.
3299  * @rq:       the request being processed
3300  * @error:    block status code
3301  * @nr_bytes: number of bytes to complete
3302  *
3303  * Description:
3304  *     Ends I/O on a number of bytes attached to @rq.
3305  *     If @rq has leftover, sets it up for the next range of segments.
3306  *
3307  * Return:
3308  *     %false - we are done with this request
3309  *     %true  - still buffers pending for this request
3310  **/
3311 bool blk_end_request(struct request *rq, blk_status_t error,
3312                 unsigned int nr_bytes)
3313 {
3314         WARN_ON_ONCE(rq->q->mq_ops);
3315         return blk_end_bidi_request(rq, error, nr_bytes, 0);
3316 }
3317 EXPORT_SYMBOL(blk_end_request);
3318
3319 /**
3320  * blk_end_request_all - Helper function for drives to finish the request.
3321  * @rq: the request to finish
3322  * @error: block status code
3323  *
3324  * Description:
3325  *     Completely finish @rq.
3326  */
3327 void blk_end_request_all(struct request *rq, blk_status_t error)
3328 {
3329         bool pending;
3330         unsigned int bidi_bytes = 0;
3331
3332         if (unlikely(blk_bidi_rq(rq)))
3333                 bidi_bytes = blk_rq_bytes(rq->next_rq);
3334
3335         pending = blk_end_bidi_request(rq, error, blk_rq_bytes(rq), bidi_bytes);
3336         BUG_ON(pending);
3337 }
3338 EXPORT_SYMBOL(blk_end_request_all);
3339
3340 /**
3341  * __blk_end_request - Helper function for drivers to complete the request.
3342  * @rq:       the request being processed
3343  * @error:    block status code
3344  * @nr_bytes: number of bytes to complete
3345  *
3346  * Description:
3347  *     Must be called with queue lock held unlike blk_end_request().
3348  *
3349  * Return:
3350  *     %false - we are done with this request
3351  *     %true  - still buffers pending for this request
3352  **/
3353 bool __blk_end_request(struct request *rq, blk_status_t error,
3354                 unsigned int nr_bytes)
3355 {
3356         lockdep_assert_held(rq->q->queue_lock);
3357         WARN_ON_ONCE(rq->q->mq_ops);
3358
3359         return __blk_end_bidi_request(rq, error, nr_bytes, 0);
3360 }
3361 EXPORT_SYMBOL(__blk_end_request);
3362
3363 /**
3364  * __blk_end_request_all - Helper function for drives to finish the request.
3365  * @rq: the request to finish
3366  * @error:    block status code
3367  *
3368  * Description:
3369  *     Completely finish @rq.  Must be called with queue lock held.
3370  */
3371 void __blk_end_request_all(struct request *rq, blk_status_t error)
3372 {
3373         bool pending;
3374         unsigned int bidi_bytes = 0;
3375
3376         lockdep_assert_held(rq->q->queue_lock);
3377         WARN_ON_ONCE(rq->q->mq_ops);
3378
3379         if (unlikely(blk_bidi_rq(rq)))
3380                 bidi_bytes = blk_rq_bytes(rq->next_rq);
3381
3382         pending = __blk_end_bidi_request(rq, error, blk_rq_bytes(rq), bidi_bytes);
3383         BUG_ON(pending);
3384 }
3385 EXPORT_SYMBOL(__blk_end_request_all);
3386
3387 /**
3388  * __blk_end_request_cur - Helper function to finish the current request chunk.
3389  * @rq: the request to finish the current chunk for
3390  * @error:    block status code
3391  *
3392  * Description:
3393  *     Complete the current consecutively mapped chunk from @rq.  Must
3394  *     be called with queue lock held.
3395  *
3396  * Return:
3397  *     %false - we are done with this request
3398  *     %true  - still buffers pending for this request
3399  */
3400 bool __blk_end_request_cur(struct request *rq, blk_status_t error)
3401 {
3402         return __blk_end_request(rq, error, blk_rq_cur_bytes(rq));
3403 }
3404 EXPORT_SYMBOL(__blk_end_request_cur);
3405
3406 void blk_rq_bio_prep(struct request_queue *q, struct request *rq,
3407                      struct bio *bio)
3408 {
3409         if (bio_has_data(bio))
3410                 rq->nr_phys_segments = bio_phys_segments(q, bio);
3411         else if (bio_op(bio) == REQ_OP_DISCARD)
3412                 rq->nr_phys_segments = 1;
3413
3414         rq->__data_len = bio->bi_iter.bi_size;
3415         rq->bio = rq->biotail = bio;
3416
3417         if (bio->bi_disk)
3418                 rq->rq_disk = bio->bi_disk;
3419 }
3420
3421 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
3422 /**
3423  * rq_flush_dcache_pages - Helper function to flush all pages in a request
3424  * @rq: the request to be flushed
3425  *
3426  * Description:
3427  *     Flush all pages in @rq.
3428  */
3429 void rq_flush_dcache_pages(struct request *rq)
3430 {
3431         struct req_iterator iter;
3432         struct bio_vec bvec;
3433
3434         rq_for_each_segment(bvec, rq, iter)
3435                 flush_dcache_page(bvec.bv_page);
3436 }
3437 EXPORT_SYMBOL_GPL(rq_flush_dcache_pages);
3438 #endif
3439
3440 /**
3441  * blk_lld_busy - Check if underlying low-level drivers of a device are busy
3442  * @q : the queue of the device being checked
3443  *
3444  * Description:
3445  *    Check if underlying low-level drivers of a device are busy.
3446  *    If the drivers want to export their busy state, they must set own
3447  *    exporting function using blk_queue_lld_busy() first.
3448  *
3449  *    Basically, this function is used only by request stacking drivers
3450  *    to stop dispatching requests to underlying devices when underlying
3451  *    devices are busy.  This behavior helps more I/O merging on the queue
3452  *    of the request stacking driver and prevents I/O throughput regression
3453  *    on burst I/O load.
3454  *
3455  * Return:
3456  *    0 - Not busy (The request stacking driver should dispatch request)
3457  *    1 - Busy (The request stacking driver should stop dispatching request)
3458  */
3459 int blk_lld_busy(struct request_queue *q)
3460 {
3461         if (q->lld_busy_fn)
3462                 return q->lld_busy_fn(q);
3463
3464         return 0;
3465 }
3466 EXPORT_SYMBOL_GPL(blk_lld_busy);
3467
3468 /**
3469  * blk_rq_unprep_clone - Helper function to free all bios in a cloned request
3470  * @rq: the clone request to be cleaned up
3471  *
3472  * Description:
3473  *     Free all bios in @rq for a cloned request.
3474  */
3475 void blk_rq_unprep_clone(struct request *rq)
3476 {
3477         struct bio *bio;
3478
3479         while ((bio = rq->bio) != NULL) {
3480                 rq->bio = bio->bi_next;
3481
3482                 bio_put(bio);
3483         }
3484 }
3485 EXPORT_SYMBOL_GPL(blk_rq_unprep_clone);
3486
3487 /*
3488  * Copy attributes of the original request to the clone request.
3489  * The actual data parts (e.g. ->cmd, ->sense) are not copied.
3490  */
3491 static void __blk_rq_prep_clone(struct request *dst, struct request *src)
3492 {
3493         dst->cpu = src->cpu;
3494         dst->__sector = blk_rq_pos(src);
3495         dst->__data_len = blk_rq_bytes(src);
3496         if (src->rq_flags & RQF_SPECIAL_PAYLOAD) {
3497                 dst->rq_flags |= RQF_SPECIAL_PAYLOAD;
3498                 dst->special_vec = src->special_vec;
3499         }
3500         dst->nr_phys_segments = src->nr_phys_segments;
3501         dst->ioprio = src->ioprio;
3502         dst->extra_len = src->extra_len;
3503 }
3504
3505 /**
3506  * blk_rq_prep_clone - Helper function to setup clone request
3507  * @rq: the request to be setup
3508  * @rq_src: original request to be cloned
3509  * @bs: bio_set that bios for clone are allocated from
3510  * @gfp_mask: memory allocation mask for bio
3511  * @bio_ctr: setup function to be called for each clone bio.
3512  *           Returns %0 for success, non %0 for failure.
3513  * @data: private data to be passed to @bio_ctr
3514  *
3515  * Description:
3516  *     Clones bios in @rq_src to @rq, and copies attributes of @rq_src to @rq.
3517  *     The actual data parts of @rq_src (e.g. ->cmd, ->sense)
3518  *     are not copied, and copying such parts is the caller's responsibility.
3519  *     Also, pages which the original bios are pointing to are not copied
3520  *     and the cloned bios just point same pages.
3521  *     So cloned bios must be completed before original bios, which means
3522  *     the caller must complete @rq before @rq_src.
3523  */
3524 int blk_rq_prep_clone(struct request *rq, struct request *rq_src,
3525                       struct bio_set *bs, gfp_t gfp_mask,
3526                       int (*bio_ctr)(struct bio *, struct bio *, void *),
3527                       void *data)
3528 {
3529         struct bio *bio, *bio_src;
3530
3531         if (!bs)
3532                 bs = &fs_bio_set;
3533
3534         __rq_for_each_bio(bio_src, rq_src) {
3535                 bio = bio_clone_fast(bio_src, gfp_mask, bs);
3536                 if (!bio)
3537                         goto free_and_out;
3538
3539                 if (bio_ctr && bio_ctr(bio, bio_src, data))
3540                         goto free_and_out;
3541
3542                 if (rq->bio) {
3543                         rq->biotail->bi_next = bio;
3544                         rq->biotail = bio;
3545                 } else
3546                         rq->bio = rq->biotail = bio;
3547         }
3548
3549         __blk_rq_prep_clone(rq, rq_src);
3550
3551         return 0;
3552
3553 free_and_out:
3554         if (bio)
3555                 bio_put(bio);
3556         blk_rq_unprep_clone(rq);
3557
3558         return -ENOMEM;
3559 }
3560 EXPORT_SYMBOL_GPL(blk_rq_prep_clone);
3561
3562 int kblockd_schedule_work(struct work_struct *work)
3563 {
3564         return queue_work(kblockd_workqueue, work);
3565 }
3566 EXPORT_SYMBOL(kblockd_schedule_work);
3567
3568 int kblockd_schedule_work_on(int cpu, struct work_struct *work)
3569 {
3570         return queue_work_on(cpu, kblockd_workqueue, work);
3571 }
3572 EXPORT_SYMBOL(kblockd_schedule_work_on);
3573
3574 int kblockd_mod_delayed_work_on(int cpu, struct delayed_work *dwork,
3575                                 unsigned long delay)
3576 {
3577         return mod_delayed_work_on(cpu, kblockd_workqueue, dwork, delay);
3578 }
3579 EXPORT_SYMBOL(kblockd_mod_delayed_work_on);
3580
3581 /**
3582  * blk_start_plug - initialize blk_plug and track it inside the task_struct
3583  * @plug:       The &struct blk_plug that needs to be initialized
3584  *
3585  * Description:
3586  *   Tracking blk_plug inside the task_struct will help with auto-flushing the
3587  *   pending I/O should the task end up blocking between blk_start_plug() and
3588  *   blk_finish_plug(). This is important from a performance perspective, but
3589  *   also ensures that we don't deadlock. For instance, if the task is blocking
3590  *   for a memory allocation, memory reclaim could end up wanting to free a
3591  *   page belonging to that request that is currently residing in our private
3592  *   plug. By flushing the pending I/O when the process goes to sleep, we avoid
3593  *   this kind of deadlock.
3594  */
3595 void blk_start_plug(struct blk_plug *plug)
3596 {
3597         struct task_struct *tsk = current;
3598
3599         /*
3600          * If this is a nested plug, don't actually assign it.
3601          */
3602         if (tsk->plug)
3603                 return;
3604
3605         INIT_LIST_HEAD(&plug->list);
3606         INIT_LIST_HEAD(&plug->mq_list);
3607         INIT_LIST_HEAD(&plug->cb_list);
3608         /*
3609          * Store ordering should not be needed here, since a potential
3610          * preempt will imply a full memory barrier
3611          */
3612         tsk->plug = plug;
3613 }
3614 EXPORT_SYMBOL(blk_start_plug);
3615
3616 static int plug_rq_cmp(void *priv, struct list_head *a, struct list_head *b)
3617 {
3618         struct request *rqa = container_of(a, struct request, queuelist);
3619         struct request *rqb = container_of(b, struct request, queuelist);
3620
3621         return !(rqa->q < rqb->q ||
3622                 (rqa->q == rqb->q && blk_rq_pos(rqa) < blk_rq_pos(rqb)));
3623 }
3624
3625 /*
3626  * If 'from_schedule' is true, then postpone the dispatch of requests
3627  * until a safe kblockd context. We due this to avoid accidental big
3628  * additional stack usage in driver dispatch, in places where the originally
3629  * plugger did not intend it.
3630  */
3631 static void queue_unplugged(struct request_queue *q, unsigned int depth,
3632                             bool from_schedule)
3633         __releases(q->queue_lock)
3634 {
3635         lockdep_assert_held(q->queue_lock);
3636
3637         trace_block_unplug(q, depth, !from_schedule);
3638
3639         if (from_schedule)
3640                 blk_run_queue_async(q);
3641         else
3642                 __blk_run_queue(q);
3643         spin_unlock_irq(q->queue_lock);
3644 }
3645
3646 static void flush_plug_callbacks(struct blk_plug *plug, bool from_schedule)
3647 {
3648         LIST_HEAD(callbacks);
3649
3650         while (!list_empty(&plug->cb_list)) {
3651                 list_splice_init(&plug->cb_list, &callbacks);
3652
3653                 while (!list_empty(&callbacks)) {
3654                         struct blk_plug_cb *cb = list_first_entry(&callbacks,
3655                                                           struct blk_plug_cb,
3656                                                           list);
3657                         list_del(&cb->list);
3658                         cb->callback(cb, from_schedule);
3659                 }
3660         }
3661 }
3662
3663 struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug, void *data,
3664                                       int size)
3665 {
3666         struct blk_plug *plug = current->plug;
3667         struct blk_plug_cb *cb;
3668
3669         if (!plug)
3670                 return NULL;
3671
3672         list_for_each_entry(cb, &plug->cb_list, list)
3673                 if (cb->callback == unplug && cb->data == data)
3674                         return cb;
3675
3676         /* Not currently on the callback list */
3677         BUG_ON(size < sizeof(*cb));
3678         cb = kzalloc(size, GFP_ATOMIC);
3679         if (cb) {
3680                 cb->data = data;
3681                 cb->callback = unplug;
3682                 list_add(&cb->list, &plug->cb_list);
3683         }
3684         return cb;
3685 }
3686 EXPORT_SYMBOL(blk_check_plugged);
3687
3688 void blk_flush_plug_list(struct blk_plug *plug, bool from_schedule)
3689 {
3690         struct request_queue *q;
3691         struct request *rq;
3692         LIST_HEAD(list);
3693         unsigned int depth;
3694
3695         flush_plug_callbacks(plug, from_schedule);
3696
3697         if (!list_empty(&plug->mq_list))
3698                 blk_mq_flush_plug_list(plug, from_schedule);
3699
3700         if (list_empty(&plug->list))
3701                 return;
3702
3703         list_splice_init(&plug->list, &list);
3704
3705         list_sort(NULL, &list, plug_rq_cmp);
3706
3707         q = NULL;
3708         depth = 0;
3709
3710         while (!list_empty(&list)) {
3711                 rq = list_entry_rq(list.next);
3712                 list_del_init(&rq->queuelist);
3713                 BUG_ON(!rq->q);
3714                 if (rq->q != q) {
3715                         /*
3716                          * This drops the queue lock
3717                          */
3718                         if (q)
3719                                 queue_unplugged(q, depth, from_schedule);
3720                         q = rq->q;
3721                         depth = 0;
3722                         spin_lock_irq(q->queue_lock);
3723                 }
3724
3725                 /*
3726                  * Short-circuit if @q is dead
3727                  */
3728                 if (unlikely(blk_queue_dying(q))) {
3729                         __blk_end_request_all(rq, BLK_STS_IOERR);
3730                         continue;
3731                 }
3732
3733                 /*
3734                  * rq is already accounted, so use raw insert
3735                  */
3736                 if (op_is_flush(rq->cmd_flags))
3737                         __elv_add_request(q, rq, ELEVATOR_INSERT_FLUSH);
3738                 else
3739                         __elv_add_request(q, rq, ELEVATOR_INSERT_SORT_MERGE);
3740
3741                 depth++;
3742         }
3743
3744         /*
3745          * This drops the queue lock
3746          */
3747         if (q)
3748                 queue_unplugged(q, depth, from_schedule);
3749 }
3750
3751 void blk_finish_plug(struct blk_plug *plug)
3752 {
3753         if (plug != current->plug)
3754                 return;
3755         blk_flush_plug_list(plug, false);
3756
3757         current->plug = NULL;
3758 }
3759 EXPORT_SYMBOL(blk_finish_plug);
3760
3761 #ifdef CONFIG_PM
3762 /**
3763  * blk_pm_runtime_init - Block layer runtime PM initialization routine
3764  * @q: the queue of the device
3765  * @dev: the device the queue belongs to
3766  *
3767  * Description:
3768  *    Initialize runtime-PM-related fields for @q and start auto suspend for
3769  *    @dev. Drivers that want to take advantage of request-based runtime PM
3770  *    should call this function after @dev has been initialized, and its
3771  *    request queue @q has been allocated, and runtime PM for it can not happen
3772  *    yet(either due to disabled/forbidden or its usage_count > 0). In most
3773  *    cases, driver should call this function before any I/O has taken place.
3774  *
3775  *    This function takes care of setting up using auto suspend for the device,
3776  *    the autosuspend delay is set to -1 to make runtime suspend impossible
3777  *    until an updated value is either set by user or by driver. Drivers do
3778  *    not need to touch other autosuspend settings.
3779  *
3780  *    The block layer runtime PM is request based, so only works for drivers
3781  *    that use request as their IO unit instead of those directly use bio's.
3782  */
3783 void blk_pm_runtime_init(struct request_queue *q, struct device *dev)
3784 {
3785         /* Don't enable runtime PM for blk-mq until it is ready */
3786         if (q->mq_ops) {
3787                 pm_runtime_disable(dev);
3788                 return;
3789         }
3790
3791         q->dev = dev;
3792         q->rpm_status = RPM_ACTIVE;
3793         pm_runtime_set_autosuspend_delay(q->dev, -1);
3794         pm_runtime_use_autosuspend(q->dev);
3795 }
3796 EXPORT_SYMBOL(blk_pm_runtime_init);
3797
3798 /**
3799  * blk_pre_runtime_suspend - Pre runtime suspend check
3800  * @q: the queue of the device
3801  *
3802  * Description:
3803  *    This function will check if runtime suspend is allowed for the device
3804  *    by examining if there are any requests pending in the queue. If there
3805  *    are requests pending, the device can not be runtime suspended; otherwise,
3806  *    the queue's status will be updated to SUSPENDING and the driver can
3807  *    proceed to suspend the device.
3808  *
3809  *    For the not allowed case, we mark last busy for the device so that
3810  *    runtime PM core will try to autosuspend it some time later.
3811  *
3812  *    This function should be called near the start of the device's
3813  *    runtime_suspend callback.
3814  *
3815  * Return:
3816  *    0         - OK to runtime suspend the device
3817  *    -EBUSY    - Device should not be runtime suspended
3818  */
3819 int blk_pre_runtime_suspend(struct request_queue *q)
3820 {
3821         int ret = 0;
3822
3823         if (!q->dev)
3824                 return ret;
3825
3826         spin_lock_irq(q->queue_lock);
3827         if (q->nr_pending) {
3828                 ret = -EBUSY;
3829                 pm_runtime_mark_last_busy(q->dev);
3830         } else {
3831                 q->rpm_status = RPM_SUSPENDING;
3832         }
3833         spin_unlock_irq(q->queue_lock);
3834         return ret;
3835 }
3836 EXPORT_SYMBOL(blk_pre_runtime_suspend);
3837
3838 /**
3839  * blk_post_runtime_suspend - Post runtime suspend processing
3840  * @q: the queue of the device
3841  * @err: return value of the device's runtime_suspend function
3842  *
3843  * Description:
3844  *    Update the queue's runtime status according to the return value of the
3845  *    device's runtime suspend function and mark last busy for the device so
3846  *    that PM core will try to auto suspend the device at a later time.
3847  *
3848  *    This function should be called near the end of the device's
3849  *    runtime_suspend callback.
3850  */
3851 void blk_post_runtime_suspend(struct request_queue *q, int err)
3852 {
3853         if (!q->dev)
3854                 return;
3855
3856         spin_lock_irq(q->queue_lock);
3857         if (!err) {
3858                 q->rpm_status = RPM_SUSPENDED;
3859         } else {
3860                 q->rpm_status = RPM_ACTIVE;
3861                 pm_runtime_mark_last_busy(q->dev);
3862         }
3863         spin_unlock_irq(q->queue_lock);
3864 }
3865 EXPORT_SYMBOL(blk_post_runtime_suspend);
3866
3867 /**
3868  * blk_pre_runtime_resume - Pre runtime resume processing
3869  * @q: the queue of the device
3870  *
3871  * Description:
3872  *    Update the queue's runtime status to RESUMING in preparation for the
3873  *    runtime resume of the device.
3874  *
3875  *    This function should be called near the start of the device's
3876  *    runtime_resume callback.
3877  */
3878 void blk_pre_runtime_resume(struct request_queue *q)
3879 {
3880         if (!q->dev)
3881                 return;
3882
3883         spin_lock_irq(q->queue_lock);
3884         q->rpm_status = RPM_RESUMING;
3885         spin_unlock_irq(q->queue_lock);
3886 }
3887 EXPORT_SYMBOL(blk_pre_runtime_resume);
3888
3889 /**
3890  * blk_post_runtime_resume - Post runtime resume processing
3891  * @q: the queue of the device
3892  * @err: return value of the device's runtime_resume function
3893  *
3894  * Description:
3895  *    Update the queue's runtime status according to the return value of the
3896  *    device's runtime_resume function. If it is successfully resumed, process
3897  *    the requests that are queued into the device's queue when it is resuming
3898  *    and then mark last busy and initiate autosuspend for it.
3899  *
3900  *    This function should be called near the end of the device's
3901  *    runtime_resume callback.
3902  */
3903 void blk_post_runtime_resume(struct request_queue *q, int err)
3904 {
3905         if (!q->dev)
3906                 return;
3907
3908         spin_lock_irq(q->queue_lock);
3909         if (!err) {
3910                 q->rpm_status = RPM_ACTIVE;
3911                 __blk_run_queue(q);
3912                 pm_runtime_mark_last_busy(q->dev);
3913                 pm_request_autosuspend(q->dev);
3914         } else {
3915                 q->rpm_status = RPM_SUSPENDED;
3916         }
3917         spin_unlock_irq(q->queue_lock);
3918 }
3919 EXPORT_SYMBOL(blk_post_runtime_resume);
3920
3921 /**
3922  * blk_set_runtime_active - Force runtime status of the queue to be active
3923  * @q: the queue of the device
3924  *
3925  * If the device is left runtime suspended during system suspend the resume
3926  * hook typically resumes the device and corrects runtime status
3927  * accordingly. However, that does not affect the queue runtime PM status
3928  * which is still "suspended". This prevents processing requests from the
3929  * queue.
3930  *
3931  * This function can be used in driver's resume hook to correct queue
3932  * runtime PM status and re-enable peeking requests from the queue. It
3933  * should be called before first request is added to the queue.
3934  */
3935 void blk_set_runtime_active(struct request_queue *q)
3936 {
3937         spin_lock_irq(q->queue_lock);
3938         q->rpm_status = RPM_ACTIVE;
3939         pm_runtime_mark_last_busy(q->dev);
3940         pm_request_autosuspend(q->dev);
3941         spin_unlock_irq(q->queue_lock);
3942 }
3943 EXPORT_SYMBOL(blk_set_runtime_active);
3944 #endif
3945
3946 int __init blk_dev_init(void)
3947 {
3948         BUILD_BUG_ON(REQ_OP_LAST >= (1 << REQ_OP_BITS));
3949         BUILD_BUG_ON(REQ_OP_BITS + REQ_FLAG_BITS > 8 *
3950                         FIELD_SIZEOF(struct request, cmd_flags));
3951         BUILD_BUG_ON(REQ_OP_BITS + REQ_FLAG_BITS > 8 *
3952                         FIELD_SIZEOF(struct bio, bi_opf));
3953
3954         /* used for unplugging and affects IO latency/throughput - HIGHPRI */
3955         kblockd_workqueue = alloc_workqueue("kblockd",
3956                                             WQ_MEM_RECLAIM | WQ_HIGHPRI, 0);
3957         if (!kblockd_workqueue)
3958                 panic("Failed to create kblockd\n");
3959
3960         request_cachep = kmem_cache_create("blkdev_requests",
3961                         sizeof(struct request), 0, SLAB_PANIC, NULL);
3962
3963         blk_requestq_cachep = kmem_cache_create("request_queue",
3964                         sizeof(struct request_queue), 0, SLAB_PANIC, NULL);
3965
3966 #ifdef CONFIG_DEBUG_FS
3967         blk_debugfs_root = debugfs_create_dir("block", NULL);
3968 #endif
3969
3970         return 0;
3971 }