]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - block/blk-core.c
block: introduce blk_flush_queue to drive flush machinery
[karo-tx-linux.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
36 #define CREATE_TRACE_POINTS
37 #include <trace/events/block.h>
38
39 #include "blk.h"
40 #include "blk-cgroup.h"
41 #include "blk-mq.h"
42
43 EXPORT_TRACEPOINT_SYMBOL_GPL(block_bio_remap);
44 EXPORT_TRACEPOINT_SYMBOL_GPL(block_rq_remap);
45 EXPORT_TRACEPOINT_SYMBOL_GPL(block_bio_complete);
46 EXPORT_TRACEPOINT_SYMBOL_GPL(block_split);
47 EXPORT_TRACEPOINT_SYMBOL_GPL(block_unplug);
48
49 DEFINE_IDA(blk_queue_ida);
50
51 /*
52  * For the allocated request tables
53  */
54 struct kmem_cache *request_cachep = NULL;
55
56 /*
57  * For queue allocation
58  */
59 struct kmem_cache *blk_requestq_cachep;
60
61 /*
62  * Controlling structure to kblockd
63  */
64 static struct workqueue_struct *kblockd_workqueue;
65
66 void blk_queue_congestion_threshold(struct request_queue *q)
67 {
68         int nr;
69
70         nr = q->nr_requests - (q->nr_requests / 8) + 1;
71         if (nr > q->nr_requests)
72                 nr = q->nr_requests;
73         q->nr_congestion_on = nr;
74
75         nr = q->nr_requests - (q->nr_requests / 8) - (q->nr_requests / 16) - 1;
76         if (nr < 1)
77                 nr = 1;
78         q->nr_congestion_off = nr;
79 }
80
81 /**
82  * blk_get_backing_dev_info - get the address of a queue's backing_dev_info
83  * @bdev:       device
84  *
85  * Locates the passed device's request queue and returns the address of its
86  * backing_dev_info.  This function can only be called if @bdev is opened
87  * and the return value is never NULL.
88  */
89 struct backing_dev_info *blk_get_backing_dev_info(struct block_device *bdev)
90 {
91         struct request_queue *q = bdev_get_queue(bdev);
92
93         return &q->backing_dev_info;
94 }
95 EXPORT_SYMBOL(blk_get_backing_dev_info);
96
97 void blk_rq_init(struct request_queue *q, struct request *rq)
98 {
99         memset(rq, 0, sizeof(*rq));
100
101         INIT_LIST_HEAD(&rq->queuelist);
102         INIT_LIST_HEAD(&rq->timeout_list);
103         rq->cpu = -1;
104         rq->q = q;
105         rq->__sector = (sector_t) -1;
106         INIT_HLIST_NODE(&rq->hash);
107         RB_CLEAR_NODE(&rq->rb_node);
108         rq->cmd = rq->__cmd;
109         rq->cmd_len = BLK_MAX_CDB;
110         rq->tag = -1;
111         rq->start_time = jiffies;
112         set_start_time_ns(rq);
113         rq->part = NULL;
114 }
115 EXPORT_SYMBOL(blk_rq_init);
116
117 static void req_bio_endio(struct request *rq, struct bio *bio,
118                           unsigned int nbytes, int error)
119 {
120         if (error)
121                 clear_bit(BIO_UPTODATE, &bio->bi_flags);
122         else if (!test_bit(BIO_UPTODATE, &bio->bi_flags))
123                 error = -EIO;
124
125         if (unlikely(rq->cmd_flags & REQ_QUIET))
126                 set_bit(BIO_QUIET, &bio->bi_flags);
127
128         bio_advance(bio, nbytes);
129
130         /* don't actually finish bio if it's part of flush sequence */
131         if (bio->bi_iter.bi_size == 0 && !(rq->cmd_flags & REQ_FLUSH_SEQ))
132                 bio_endio(bio, error);
133 }
134
135 void blk_dump_rq_flags(struct request *rq, char *msg)
136 {
137         int bit;
138
139         printk(KERN_INFO "%s: dev %s: type=%x, flags=%llx\n", msg,
140                 rq->rq_disk ? rq->rq_disk->disk_name : "?", rq->cmd_type,
141                 (unsigned long long) rq->cmd_flags);
142
143         printk(KERN_INFO "  sector %llu, nr/cnr %u/%u\n",
144                (unsigned long long)blk_rq_pos(rq),
145                blk_rq_sectors(rq), blk_rq_cur_sectors(rq));
146         printk(KERN_INFO "  bio %p, biotail %p, len %u\n",
147                rq->bio, rq->biotail, blk_rq_bytes(rq));
148
149         if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
150                 printk(KERN_INFO "  cdb: ");
151                 for (bit = 0; bit < BLK_MAX_CDB; bit++)
152                         printk("%02x ", rq->cmd[bit]);
153                 printk("\n");
154         }
155 }
156 EXPORT_SYMBOL(blk_dump_rq_flags);
157
158 static void blk_delay_work(struct work_struct *work)
159 {
160         struct request_queue *q;
161
162         q = container_of(work, struct request_queue, delay_work.work);
163         spin_lock_irq(q->queue_lock);
164         __blk_run_queue(q);
165         spin_unlock_irq(q->queue_lock);
166 }
167
168 /**
169  * blk_delay_queue - restart queueing after defined interval
170  * @q:          The &struct request_queue in question
171  * @msecs:      Delay in msecs
172  *
173  * Description:
174  *   Sometimes queueing needs to be postponed for a little while, to allow
175  *   resources to come back. This function will make sure that queueing is
176  *   restarted around the specified time. Queue lock must be held.
177  */
178 void blk_delay_queue(struct request_queue *q, unsigned long msecs)
179 {
180         if (likely(!blk_queue_dead(q)))
181                 queue_delayed_work(kblockd_workqueue, &q->delay_work,
182                                    msecs_to_jiffies(msecs));
183 }
184 EXPORT_SYMBOL(blk_delay_queue);
185
186 /**
187  * blk_start_queue - restart a previously stopped queue
188  * @q:    The &struct request_queue in question
189  *
190  * Description:
191  *   blk_start_queue() will clear the stop flag on the queue, and call
192  *   the request_fn for the queue if it was in a stopped state when
193  *   entered. Also see blk_stop_queue(). Queue lock must be held.
194  **/
195 void blk_start_queue(struct request_queue *q)
196 {
197         WARN_ON(!irqs_disabled());
198
199         queue_flag_clear(QUEUE_FLAG_STOPPED, q);
200         __blk_run_queue(q);
201 }
202 EXPORT_SYMBOL(blk_start_queue);
203
204 /**
205  * blk_stop_queue - stop a queue
206  * @q:    The &struct request_queue in question
207  *
208  * Description:
209  *   The Linux block layer assumes that a block driver will consume all
210  *   entries on the request queue when the request_fn strategy is called.
211  *   Often this will not happen, because of hardware limitations (queue
212  *   depth settings). If a device driver gets a 'queue full' response,
213  *   or if it simply chooses not to queue more I/O at one point, it can
214  *   call this function to prevent the request_fn from being called until
215  *   the driver has signalled it's ready to go again. This happens by calling
216  *   blk_start_queue() to restart queue operations. Queue lock must be held.
217  **/
218 void blk_stop_queue(struct request_queue *q)
219 {
220         cancel_delayed_work(&q->delay_work);
221         queue_flag_set(QUEUE_FLAG_STOPPED, q);
222 }
223 EXPORT_SYMBOL(blk_stop_queue);
224
225 /**
226  * blk_sync_queue - cancel any pending callbacks on a queue
227  * @q: the queue
228  *
229  * Description:
230  *     The block layer may perform asynchronous callback activity
231  *     on a queue, such as calling the unplug function after a timeout.
232  *     A block device may call blk_sync_queue to ensure that any
233  *     such activity is cancelled, thus allowing it to release resources
234  *     that the callbacks might use. The caller must already have made sure
235  *     that its ->make_request_fn will not re-add plugging prior to calling
236  *     this function.
237  *
238  *     This function does not cancel any asynchronous activity arising
239  *     out of elevator or throttling code. That would require elevaotor_exit()
240  *     and blkcg_exit_queue() to be called with queue lock initialized.
241  *
242  */
243 void blk_sync_queue(struct request_queue *q)
244 {
245         del_timer_sync(&q->timeout);
246
247         if (q->mq_ops) {
248                 struct blk_mq_hw_ctx *hctx;
249                 int i;
250
251                 queue_for_each_hw_ctx(q, hctx, i) {
252                         cancel_delayed_work_sync(&hctx->run_work);
253                         cancel_delayed_work_sync(&hctx->delay_work);
254                 }
255         } else {
256                 cancel_delayed_work_sync(&q->delay_work);
257         }
258 }
259 EXPORT_SYMBOL(blk_sync_queue);
260
261 /**
262  * __blk_run_queue_uncond - run a queue whether or not it has been stopped
263  * @q:  The queue to run
264  *
265  * Description:
266  *    Invoke request handling on a queue if there are any pending requests.
267  *    May be used to restart request handling after a request has completed.
268  *    This variant runs the queue whether or not the queue has been
269  *    stopped. Must be called with the queue lock held and interrupts
270  *    disabled. See also @blk_run_queue.
271  */
272 inline void __blk_run_queue_uncond(struct request_queue *q)
273 {
274         if (unlikely(blk_queue_dead(q)))
275                 return;
276
277         /*
278          * Some request_fn implementations, e.g. scsi_request_fn(), unlock
279          * the queue lock internally. As a result multiple threads may be
280          * running such a request function concurrently. Keep track of the
281          * number of active request_fn invocations such that blk_drain_queue()
282          * can wait until all these request_fn calls have finished.
283          */
284         q->request_fn_active++;
285         q->request_fn(q);
286         q->request_fn_active--;
287 }
288
289 /**
290  * __blk_run_queue - run a single device queue
291  * @q:  The queue to run
292  *
293  * Description:
294  *    See @blk_run_queue. This variant must be called with the queue lock
295  *    held and interrupts disabled.
296  */
297 void __blk_run_queue(struct request_queue *q)
298 {
299         if (unlikely(blk_queue_stopped(q)))
300                 return;
301
302         __blk_run_queue_uncond(q);
303 }
304 EXPORT_SYMBOL(__blk_run_queue);
305
306 /**
307  * blk_run_queue_async - run a single device queue in workqueue context
308  * @q:  The queue to run
309  *
310  * Description:
311  *    Tells kblockd to perform the equivalent of @blk_run_queue on behalf
312  *    of us. The caller must hold the queue lock.
313  */
314 void blk_run_queue_async(struct request_queue *q)
315 {
316         if (likely(!blk_queue_stopped(q) && !blk_queue_dead(q)))
317                 mod_delayed_work(kblockd_workqueue, &q->delay_work, 0);
318 }
319 EXPORT_SYMBOL(blk_run_queue_async);
320
321 /**
322  * blk_run_queue - run a single device queue
323  * @q: The queue to run
324  *
325  * Description:
326  *    Invoke request handling on this queue, if it has pending work to do.
327  *    May be used to restart queueing when a request has completed.
328  */
329 void blk_run_queue(struct request_queue *q)
330 {
331         unsigned long flags;
332
333         spin_lock_irqsave(q->queue_lock, flags);
334         __blk_run_queue(q);
335         spin_unlock_irqrestore(q->queue_lock, flags);
336 }
337 EXPORT_SYMBOL(blk_run_queue);
338
339 void blk_put_queue(struct request_queue *q)
340 {
341         kobject_put(&q->kobj);
342 }
343 EXPORT_SYMBOL(blk_put_queue);
344
345 /**
346  * __blk_drain_queue - drain requests from request_queue
347  * @q: queue to drain
348  * @drain_all: whether to drain all requests or only the ones w/ ELVPRIV
349  *
350  * Drain requests from @q.  If @drain_all is set, all requests are drained.
351  * If not, only ELVPRIV requests are drained.  The caller is responsible
352  * for ensuring that no new requests which need to be drained are queued.
353  */
354 static void __blk_drain_queue(struct request_queue *q, bool drain_all)
355         __releases(q->queue_lock)
356         __acquires(q->queue_lock)
357 {
358         int i;
359
360         lockdep_assert_held(q->queue_lock);
361
362         while (true) {
363                 bool drain = false;
364
365                 /*
366                  * The caller might be trying to drain @q before its
367                  * elevator is initialized.
368                  */
369                 if (q->elevator)
370                         elv_drain_elevator(q);
371
372                 blkcg_drain_queue(q);
373
374                 /*
375                  * This function might be called on a queue which failed
376                  * driver init after queue creation or is not yet fully
377                  * active yet.  Some drivers (e.g. fd and loop) get unhappy
378                  * in such cases.  Kick queue iff dispatch queue has
379                  * something on it and @q has request_fn set.
380                  */
381                 if (!list_empty(&q->queue_head) && q->request_fn)
382                         __blk_run_queue(q);
383
384                 drain |= q->nr_rqs_elvpriv;
385                 drain |= q->request_fn_active;
386
387                 /*
388                  * Unfortunately, requests are queued at and tracked from
389                  * multiple places and there's no single counter which can
390                  * be drained.  Check all the queues and counters.
391                  */
392                 if (drain_all) {
393                         struct blk_flush_queue *fq = blk_get_flush_queue(q);
394                         drain |= !list_empty(&q->queue_head);
395                         for (i = 0; i < 2; i++) {
396                                 drain |= q->nr_rqs[i];
397                                 drain |= q->in_flight[i];
398                                 if (fq)
399                                     drain |= !list_empty(&fq->flush_queue[i]);
400                         }
401                 }
402
403                 if (!drain)
404                         break;
405
406                 spin_unlock_irq(q->queue_lock);
407
408                 msleep(10);
409
410                 spin_lock_irq(q->queue_lock);
411         }
412
413         /*
414          * With queue marked dead, any woken up waiter will fail the
415          * allocation path, so the wakeup chaining is lost and we're
416          * left with hung waiters. We need to wake up those waiters.
417          */
418         if (q->request_fn) {
419                 struct request_list *rl;
420
421                 blk_queue_for_each_rl(rl, q)
422                         for (i = 0; i < ARRAY_SIZE(rl->wait); i++)
423                                 wake_up_all(&rl->wait[i]);
424         }
425 }
426
427 /**
428  * blk_queue_bypass_start - enter queue bypass mode
429  * @q: queue of interest
430  *
431  * In bypass mode, only the dispatch FIFO queue of @q is used.  This
432  * function makes @q enter bypass mode and drains all requests which were
433  * throttled or issued before.  On return, it's guaranteed that no request
434  * is being throttled or has ELVPRIV set and blk_queue_bypass() %true
435  * inside queue or RCU read lock.
436  */
437 void blk_queue_bypass_start(struct request_queue *q)
438 {
439         spin_lock_irq(q->queue_lock);
440         q->bypass_depth++;
441         queue_flag_set(QUEUE_FLAG_BYPASS, q);
442         spin_unlock_irq(q->queue_lock);
443
444         /*
445          * Queues start drained.  Skip actual draining till init is
446          * complete.  This avoids lenghty delays during queue init which
447          * can happen many times during boot.
448          */
449         if (blk_queue_init_done(q)) {
450                 spin_lock_irq(q->queue_lock);
451                 __blk_drain_queue(q, false);
452                 spin_unlock_irq(q->queue_lock);
453
454                 /* ensure blk_queue_bypass() is %true inside RCU read lock */
455                 synchronize_rcu();
456         }
457 }
458 EXPORT_SYMBOL_GPL(blk_queue_bypass_start);
459
460 /**
461  * blk_queue_bypass_end - leave queue bypass mode
462  * @q: queue of interest
463  *
464  * Leave bypass mode and restore the normal queueing behavior.
465  */
466 void blk_queue_bypass_end(struct request_queue *q)
467 {
468         spin_lock_irq(q->queue_lock);
469         if (!--q->bypass_depth)
470                 queue_flag_clear(QUEUE_FLAG_BYPASS, q);
471         WARN_ON_ONCE(q->bypass_depth < 0);
472         spin_unlock_irq(q->queue_lock);
473 }
474 EXPORT_SYMBOL_GPL(blk_queue_bypass_end);
475
476 /**
477  * blk_cleanup_queue - shutdown a request queue
478  * @q: request queue to shutdown
479  *
480  * Mark @q DYING, drain all pending requests, mark @q DEAD, destroy and
481  * put it.  All future requests will be failed immediately with -ENODEV.
482  */
483 void blk_cleanup_queue(struct request_queue *q)
484 {
485         spinlock_t *lock = q->queue_lock;
486
487         /* mark @q DYING, no new request or merges will be allowed afterwards */
488         mutex_lock(&q->sysfs_lock);
489         queue_flag_set_unlocked(QUEUE_FLAG_DYING, q);
490         spin_lock_irq(lock);
491
492         /*
493          * A dying queue is permanently in bypass mode till released.  Note
494          * that, unlike blk_queue_bypass_start(), we aren't performing
495          * synchronize_rcu() after entering bypass mode to avoid the delay
496          * as some drivers create and destroy a lot of queues while
497          * probing.  This is still safe because blk_release_queue() will be
498          * called only after the queue refcnt drops to zero and nothing,
499          * RCU or not, would be traversing the queue by then.
500          */
501         q->bypass_depth++;
502         queue_flag_set(QUEUE_FLAG_BYPASS, q);
503
504         queue_flag_set(QUEUE_FLAG_NOMERGES, q);
505         queue_flag_set(QUEUE_FLAG_NOXMERGES, q);
506         queue_flag_set(QUEUE_FLAG_DYING, q);
507         spin_unlock_irq(lock);
508         mutex_unlock(&q->sysfs_lock);
509
510         /*
511          * Drain all requests queued before DYING marking. Set DEAD flag to
512          * prevent that q->request_fn() gets invoked after draining finished.
513          */
514         if (q->mq_ops) {
515                 blk_mq_freeze_queue(q);
516                 spin_lock_irq(lock);
517         } else {
518                 spin_lock_irq(lock);
519                 __blk_drain_queue(q, true);
520         }
521         queue_flag_set(QUEUE_FLAG_DEAD, q);
522         spin_unlock_irq(lock);
523
524         /* @q won't process any more request, flush async actions */
525         del_timer_sync(&q->backing_dev_info.laptop_mode_wb_timer);
526         blk_sync_queue(q);
527
528         spin_lock_irq(lock);
529         if (q->queue_lock != &q->__queue_lock)
530                 q->queue_lock = &q->__queue_lock;
531         spin_unlock_irq(lock);
532
533         /* @q is and will stay empty, shutdown and put */
534         blk_put_queue(q);
535 }
536 EXPORT_SYMBOL(blk_cleanup_queue);
537
538 int blk_init_rl(struct request_list *rl, struct request_queue *q,
539                 gfp_t gfp_mask)
540 {
541         if (unlikely(rl->rq_pool))
542                 return 0;
543
544         rl->q = q;
545         rl->count[BLK_RW_SYNC] = rl->count[BLK_RW_ASYNC] = 0;
546         rl->starved[BLK_RW_SYNC] = rl->starved[BLK_RW_ASYNC] = 0;
547         init_waitqueue_head(&rl->wait[BLK_RW_SYNC]);
548         init_waitqueue_head(&rl->wait[BLK_RW_ASYNC]);
549
550         rl->rq_pool = mempool_create_node(BLKDEV_MIN_RQ, mempool_alloc_slab,
551                                           mempool_free_slab, request_cachep,
552                                           gfp_mask, q->node);
553         if (!rl->rq_pool)
554                 return -ENOMEM;
555
556         return 0;
557 }
558
559 void blk_exit_rl(struct request_list *rl)
560 {
561         if (rl->rq_pool)
562                 mempool_destroy(rl->rq_pool);
563 }
564
565 struct request_queue *blk_alloc_queue(gfp_t gfp_mask)
566 {
567         return blk_alloc_queue_node(gfp_mask, NUMA_NO_NODE);
568 }
569 EXPORT_SYMBOL(blk_alloc_queue);
570
571 struct request_queue *blk_alloc_queue_node(gfp_t gfp_mask, int node_id)
572 {
573         struct request_queue *q;
574         int err;
575
576         q = kmem_cache_alloc_node(blk_requestq_cachep,
577                                 gfp_mask | __GFP_ZERO, node_id);
578         if (!q)
579                 return NULL;
580
581         q->id = ida_simple_get(&blk_queue_ida, 0, 0, gfp_mask);
582         if (q->id < 0)
583                 goto fail_q;
584
585         q->backing_dev_info.ra_pages =
586                         (VM_MAX_READAHEAD * 1024) / PAGE_CACHE_SIZE;
587         q->backing_dev_info.state = 0;
588         q->backing_dev_info.capabilities = BDI_CAP_MAP_COPY;
589         q->backing_dev_info.name = "block";
590         q->node = node_id;
591
592         err = bdi_init(&q->backing_dev_info);
593         if (err)
594                 goto fail_id;
595
596         setup_timer(&q->backing_dev_info.laptop_mode_wb_timer,
597                     laptop_mode_timer_fn, (unsigned long) q);
598         setup_timer(&q->timeout, blk_rq_timed_out_timer, (unsigned long) q);
599         INIT_LIST_HEAD(&q->queue_head);
600         INIT_LIST_HEAD(&q->timeout_list);
601         INIT_LIST_HEAD(&q->icq_list);
602 #ifdef CONFIG_BLK_CGROUP
603         INIT_LIST_HEAD(&q->blkg_list);
604 #endif
605         INIT_DELAYED_WORK(&q->delay_work, blk_delay_work);
606
607         kobject_init(&q->kobj, &blk_queue_ktype);
608
609         mutex_init(&q->sysfs_lock);
610         spin_lock_init(&q->__queue_lock);
611
612         /*
613          * By default initialize queue_lock to internal lock and driver can
614          * override it later if need be.
615          */
616         q->queue_lock = &q->__queue_lock;
617
618         /*
619          * A queue starts its life with bypass turned on to avoid
620          * unnecessary bypass on/off overhead and nasty surprises during
621          * init.  The initial bypass will be finished when the queue is
622          * registered by blk_register_queue().
623          */
624         q->bypass_depth = 1;
625         __set_bit(QUEUE_FLAG_BYPASS, &q->queue_flags);
626
627         init_waitqueue_head(&q->mq_freeze_wq);
628
629         if (blkcg_init_queue(q))
630                 goto fail_bdi;
631
632         return q;
633
634 fail_bdi:
635         bdi_destroy(&q->backing_dev_info);
636 fail_id:
637         ida_simple_remove(&blk_queue_ida, q->id);
638 fail_q:
639         kmem_cache_free(blk_requestq_cachep, q);
640         return NULL;
641 }
642 EXPORT_SYMBOL(blk_alloc_queue_node);
643
644 /**
645  * blk_init_queue  - prepare a request queue for use with a block device
646  * @rfn:  The function to be called to process requests that have been
647  *        placed on the queue.
648  * @lock: Request queue spin lock
649  *
650  * Description:
651  *    If a block device wishes to use the standard request handling procedures,
652  *    which sorts requests and coalesces adjacent requests, then it must
653  *    call blk_init_queue().  The function @rfn will be called when there
654  *    are requests on the queue that need to be processed.  If the device
655  *    supports plugging, then @rfn may not be called immediately when requests
656  *    are available on the queue, but may be called at some time later instead.
657  *    Plugged queues are generally unplugged when a buffer belonging to one
658  *    of the requests on the queue is needed, or due to memory pressure.
659  *
660  *    @rfn is not required, or even expected, to remove all requests off the
661  *    queue, but only as many as it can handle at a time.  If it does leave
662  *    requests on the queue, it is responsible for arranging that the requests
663  *    get dealt with eventually.
664  *
665  *    The queue spin lock must be held while manipulating the requests on the
666  *    request queue; this lock will be taken also from interrupt context, so irq
667  *    disabling is needed for it.
668  *
669  *    Function returns a pointer to the initialized request queue, or %NULL if
670  *    it didn't succeed.
671  *
672  * Note:
673  *    blk_init_queue() must be paired with a blk_cleanup_queue() call
674  *    when the block device is deactivated (such as at module unload).
675  **/
676
677 struct request_queue *blk_init_queue(request_fn_proc *rfn, spinlock_t *lock)
678 {
679         return blk_init_queue_node(rfn, lock, NUMA_NO_NODE);
680 }
681 EXPORT_SYMBOL(blk_init_queue);
682
683 struct request_queue *
684 blk_init_queue_node(request_fn_proc *rfn, spinlock_t *lock, int node_id)
685 {
686         struct request_queue *uninit_q, *q;
687
688         uninit_q = blk_alloc_queue_node(GFP_KERNEL, node_id);
689         if (!uninit_q)
690                 return NULL;
691
692         q = blk_init_allocated_queue(uninit_q, rfn, lock);
693         if (!q)
694                 blk_cleanup_queue(uninit_q);
695
696         return q;
697 }
698 EXPORT_SYMBOL(blk_init_queue_node);
699
700 struct request_queue *
701 blk_init_allocated_queue(struct request_queue *q, request_fn_proc *rfn,
702                          spinlock_t *lock)
703 {
704         if (!q)
705                 return NULL;
706
707         if (blk_init_flush(q))
708                 return NULL;
709
710         if (blk_init_rl(&q->root_rl, q, GFP_KERNEL))
711                 goto fail;
712
713         q->request_fn           = rfn;
714         q->prep_rq_fn           = NULL;
715         q->unprep_rq_fn         = NULL;
716         q->queue_flags          |= QUEUE_FLAG_DEFAULT;
717
718         /* Override internal queue lock with supplied lock pointer */
719         if (lock)
720                 q->queue_lock           = lock;
721
722         /*
723          * This also sets hw/phys segments, boundary and size
724          */
725         blk_queue_make_request(q, blk_queue_bio);
726
727         q->sg_reserved_size = INT_MAX;
728
729         /* Protect q->elevator from elevator_change */
730         mutex_lock(&q->sysfs_lock);
731
732         /* init elevator */
733         if (elevator_init(q, NULL)) {
734                 mutex_unlock(&q->sysfs_lock);
735                 goto fail;
736         }
737
738         mutex_unlock(&q->sysfs_lock);
739
740         return q;
741
742 fail:
743         blk_exit_flush(q);
744         return NULL;
745 }
746 EXPORT_SYMBOL(blk_init_allocated_queue);
747
748 bool blk_get_queue(struct request_queue *q)
749 {
750         if (likely(!blk_queue_dying(q))) {
751                 __blk_get_queue(q);
752                 return true;
753         }
754
755         return false;
756 }
757 EXPORT_SYMBOL(blk_get_queue);
758
759 static inline void blk_free_request(struct request_list *rl, struct request *rq)
760 {
761         if (rq->cmd_flags & REQ_ELVPRIV) {
762                 elv_put_request(rl->q, rq);
763                 if (rq->elv.icq)
764                         put_io_context(rq->elv.icq->ioc);
765         }
766
767         mempool_free(rq, rl->rq_pool);
768 }
769
770 /*
771  * ioc_batching returns true if the ioc is a valid batching request and
772  * should be given priority access to a request.
773  */
774 static inline int ioc_batching(struct request_queue *q, struct io_context *ioc)
775 {
776         if (!ioc)
777                 return 0;
778
779         /*
780          * Make sure the process is able to allocate at least 1 request
781          * even if the batch times out, otherwise we could theoretically
782          * lose wakeups.
783          */
784         return ioc->nr_batch_requests == q->nr_batching ||
785                 (ioc->nr_batch_requests > 0
786                 && time_before(jiffies, ioc->last_waited + BLK_BATCH_TIME));
787 }
788
789 /*
790  * ioc_set_batching sets ioc to be a new "batcher" if it is not one. This
791  * will cause the process to be a "batcher" on all queues in the system. This
792  * is the behaviour we want though - once it gets a wakeup it should be given
793  * a nice run.
794  */
795 static void ioc_set_batching(struct request_queue *q, struct io_context *ioc)
796 {
797         if (!ioc || ioc_batching(q, ioc))
798                 return;
799
800         ioc->nr_batch_requests = q->nr_batching;
801         ioc->last_waited = jiffies;
802 }
803
804 static void __freed_request(struct request_list *rl, int sync)
805 {
806         struct request_queue *q = rl->q;
807
808         /*
809          * bdi isn't aware of blkcg yet.  As all async IOs end up root
810          * blkcg anyway, just use root blkcg state.
811          */
812         if (rl == &q->root_rl &&
813             rl->count[sync] < queue_congestion_off_threshold(q))
814                 blk_clear_queue_congested(q, sync);
815
816         if (rl->count[sync] + 1 <= q->nr_requests) {
817                 if (waitqueue_active(&rl->wait[sync]))
818                         wake_up(&rl->wait[sync]);
819
820                 blk_clear_rl_full(rl, sync);
821         }
822 }
823
824 /*
825  * A request has just been released.  Account for it, update the full and
826  * congestion status, wake up any waiters.   Called under q->queue_lock.
827  */
828 static void freed_request(struct request_list *rl, unsigned int flags)
829 {
830         struct request_queue *q = rl->q;
831         int sync = rw_is_sync(flags);
832
833         q->nr_rqs[sync]--;
834         rl->count[sync]--;
835         if (flags & REQ_ELVPRIV)
836                 q->nr_rqs_elvpriv--;
837
838         __freed_request(rl, sync);
839
840         if (unlikely(rl->starved[sync ^ 1]))
841                 __freed_request(rl, sync ^ 1);
842 }
843
844 int blk_update_nr_requests(struct request_queue *q, unsigned int nr)
845 {
846         struct request_list *rl;
847
848         spin_lock_irq(q->queue_lock);
849         q->nr_requests = nr;
850         blk_queue_congestion_threshold(q);
851
852         /* congestion isn't cgroup aware and follows root blkcg for now */
853         rl = &q->root_rl;
854
855         if (rl->count[BLK_RW_SYNC] >= queue_congestion_on_threshold(q))
856                 blk_set_queue_congested(q, BLK_RW_SYNC);
857         else if (rl->count[BLK_RW_SYNC] < queue_congestion_off_threshold(q))
858                 blk_clear_queue_congested(q, BLK_RW_SYNC);
859
860         if (rl->count[BLK_RW_ASYNC] >= queue_congestion_on_threshold(q))
861                 blk_set_queue_congested(q, BLK_RW_ASYNC);
862         else if (rl->count[BLK_RW_ASYNC] < queue_congestion_off_threshold(q))
863                 blk_clear_queue_congested(q, BLK_RW_ASYNC);
864
865         blk_queue_for_each_rl(rl, q) {
866                 if (rl->count[BLK_RW_SYNC] >= q->nr_requests) {
867                         blk_set_rl_full(rl, BLK_RW_SYNC);
868                 } else {
869                         blk_clear_rl_full(rl, BLK_RW_SYNC);
870                         wake_up(&rl->wait[BLK_RW_SYNC]);
871                 }
872
873                 if (rl->count[BLK_RW_ASYNC] >= q->nr_requests) {
874                         blk_set_rl_full(rl, BLK_RW_ASYNC);
875                 } else {
876                         blk_clear_rl_full(rl, BLK_RW_ASYNC);
877                         wake_up(&rl->wait[BLK_RW_ASYNC]);
878                 }
879         }
880
881         spin_unlock_irq(q->queue_lock);
882         return 0;
883 }
884
885 /*
886  * Determine if elevator data should be initialized when allocating the
887  * request associated with @bio.
888  */
889 static bool blk_rq_should_init_elevator(struct bio *bio)
890 {
891         if (!bio)
892                 return true;
893
894         /*
895          * Flush requests do not use the elevator so skip initialization.
896          * This allows a request to share the flush and elevator data.
897          */
898         if (bio->bi_rw & (REQ_FLUSH | REQ_FUA))
899                 return false;
900
901         return true;
902 }
903
904 /**
905  * rq_ioc - determine io_context for request allocation
906  * @bio: request being allocated is for this bio (can be %NULL)
907  *
908  * Determine io_context to use for request allocation for @bio.  May return
909  * %NULL if %current->io_context doesn't exist.
910  */
911 static struct io_context *rq_ioc(struct bio *bio)
912 {
913 #ifdef CONFIG_BLK_CGROUP
914         if (bio && bio->bi_ioc)
915                 return bio->bi_ioc;
916 #endif
917         return current->io_context;
918 }
919
920 /**
921  * __get_request - get a free request
922  * @rl: request list to allocate from
923  * @rw_flags: RW and SYNC flags
924  * @bio: bio to allocate request for (can be %NULL)
925  * @gfp_mask: allocation mask
926  *
927  * Get a free request from @q.  This function may fail under memory
928  * pressure or if @q is dead.
929  *
930  * Must be called with @q->queue_lock held and,
931  * Returns ERR_PTR on failure, with @q->queue_lock held.
932  * Returns request pointer on success, with @q->queue_lock *not held*.
933  */
934 static struct request *__get_request(struct request_list *rl, int rw_flags,
935                                      struct bio *bio, gfp_t gfp_mask)
936 {
937         struct request_queue *q = rl->q;
938         struct request *rq;
939         struct elevator_type *et = q->elevator->type;
940         struct io_context *ioc = rq_ioc(bio);
941         struct io_cq *icq = NULL;
942         const bool is_sync = rw_is_sync(rw_flags) != 0;
943         int may_queue;
944
945         if (unlikely(blk_queue_dying(q)))
946                 return ERR_PTR(-ENODEV);
947
948         may_queue = elv_may_queue(q, rw_flags);
949         if (may_queue == ELV_MQUEUE_NO)
950                 goto rq_starved;
951
952         if (rl->count[is_sync]+1 >= queue_congestion_on_threshold(q)) {
953                 if (rl->count[is_sync]+1 >= q->nr_requests) {
954                         /*
955                          * The queue will fill after this allocation, so set
956                          * it as full, and mark this process as "batching".
957                          * This process will be allowed to complete a batch of
958                          * requests, others will be blocked.
959                          */
960                         if (!blk_rl_full(rl, is_sync)) {
961                                 ioc_set_batching(q, ioc);
962                                 blk_set_rl_full(rl, is_sync);
963                         } else {
964                                 if (may_queue != ELV_MQUEUE_MUST
965                                                 && !ioc_batching(q, ioc)) {
966                                         /*
967                                          * The queue is full and the allocating
968                                          * process is not a "batcher", and not
969                                          * exempted by the IO scheduler
970                                          */
971                                         return ERR_PTR(-ENOMEM);
972                                 }
973                         }
974                 }
975                 /*
976                  * bdi isn't aware of blkcg yet.  As all async IOs end up
977                  * root blkcg anyway, just use root blkcg state.
978                  */
979                 if (rl == &q->root_rl)
980                         blk_set_queue_congested(q, is_sync);
981         }
982
983         /*
984          * Only allow batching queuers to allocate up to 50% over the defined
985          * limit of requests, otherwise we could have thousands of requests
986          * allocated with any setting of ->nr_requests
987          */
988         if (rl->count[is_sync] >= (3 * q->nr_requests / 2))
989                 return ERR_PTR(-ENOMEM);
990
991         q->nr_rqs[is_sync]++;
992         rl->count[is_sync]++;
993         rl->starved[is_sync] = 0;
994
995         /*
996          * Decide whether the new request will be managed by elevator.  If
997          * so, mark @rw_flags and increment elvpriv.  Non-zero elvpriv will
998          * prevent the current elevator from being destroyed until the new
999          * request is freed.  This guarantees icq's won't be destroyed and
1000          * makes creating new ones safe.
1001          *
1002          * Also, lookup icq while holding queue_lock.  If it doesn't exist,
1003          * it will be created after releasing queue_lock.
1004          */
1005         if (blk_rq_should_init_elevator(bio) && !blk_queue_bypass(q)) {
1006                 rw_flags |= REQ_ELVPRIV;
1007                 q->nr_rqs_elvpriv++;
1008                 if (et->icq_cache && ioc)
1009                         icq = ioc_lookup_icq(ioc, q);
1010         }
1011
1012         if (blk_queue_io_stat(q))
1013                 rw_flags |= REQ_IO_STAT;
1014         spin_unlock_irq(q->queue_lock);
1015
1016         /* allocate and init request */
1017         rq = mempool_alloc(rl->rq_pool, gfp_mask);
1018         if (!rq)
1019                 goto fail_alloc;
1020
1021         blk_rq_init(q, rq);
1022         blk_rq_set_rl(rq, rl);
1023         rq->cmd_flags = rw_flags | REQ_ALLOCED;
1024
1025         /* init elvpriv */
1026         if (rw_flags & REQ_ELVPRIV) {
1027                 if (unlikely(et->icq_cache && !icq)) {
1028                         if (ioc)
1029                                 icq = ioc_create_icq(ioc, q, gfp_mask);
1030                         if (!icq)
1031                                 goto fail_elvpriv;
1032                 }
1033
1034                 rq->elv.icq = icq;
1035                 if (unlikely(elv_set_request(q, rq, bio, gfp_mask)))
1036                         goto fail_elvpriv;
1037
1038                 /* @rq->elv.icq holds io_context until @rq is freed */
1039                 if (icq)
1040                         get_io_context(icq->ioc);
1041         }
1042 out:
1043         /*
1044          * ioc may be NULL here, and ioc_batching will be false. That's
1045          * OK, if the queue is under the request limit then requests need
1046          * not count toward the nr_batch_requests limit. There will always
1047          * be some limit enforced by BLK_BATCH_TIME.
1048          */
1049         if (ioc_batching(q, ioc))
1050                 ioc->nr_batch_requests--;
1051
1052         trace_block_getrq(q, bio, rw_flags & 1);
1053         return rq;
1054
1055 fail_elvpriv:
1056         /*
1057          * elvpriv init failed.  ioc, icq and elvpriv aren't mempool backed
1058          * and may fail indefinitely under memory pressure and thus
1059          * shouldn't stall IO.  Treat this request as !elvpriv.  This will
1060          * disturb iosched and blkcg but weird is bettern than dead.
1061          */
1062         printk_ratelimited(KERN_WARNING "%s: request aux data allocation failed, iosched may be disturbed\n",
1063                            dev_name(q->backing_dev_info.dev));
1064
1065         rq->cmd_flags &= ~REQ_ELVPRIV;
1066         rq->elv.icq = NULL;
1067
1068         spin_lock_irq(q->queue_lock);
1069         q->nr_rqs_elvpriv--;
1070         spin_unlock_irq(q->queue_lock);
1071         goto out;
1072
1073 fail_alloc:
1074         /*
1075          * Allocation failed presumably due to memory. Undo anything we
1076          * might have messed up.
1077          *
1078          * Allocating task should really be put onto the front of the wait
1079          * queue, but this is pretty rare.
1080          */
1081         spin_lock_irq(q->queue_lock);
1082         freed_request(rl, rw_flags);
1083
1084         /*
1085          * in the very unlikely event that allocation failed and no
1086          * requests for this direction was pending, mark us starved so that
1087          * freeing of a request in the other direction will notice
1088          * us. another possible fix would be to split the rq mempool into
1089          * READ and WRITE
1090          */
1091 rq_starved:
1092         if (unlikely(rl->count[is_sync] == 0))
1093                 rl->starved[is_sync] = 1;
1094         return ERR_PTR(-ENOMEM);
1095 }
1096
1097 /**
1098  * get_request - get a free request
1099  * @q: request_queue to allocate request from
1100  * @rw_flags: RW and SYNC flags
1101  * @bio: bio to allocate request for (can be %NULL)
1102  * @gfp_mask: allocation mask
1103  *
1104  * Get a free request from @q.  If %__GFP_WAIT is set in @gfp_mask, this
1105  * function keeps retrying under memory pressure and fails iff @q is dead.
1106  *
1107  * Must be called with @q->queue_lock held and,
1108  * Returns ERR_PTR on failure, with @q->queue_lock held.
1109  * Returns request pointer on success, with @q->queue_lock *not held*.
1110  */
1111 static struct request *get_request(struct request_queue *q, int rw_flags,
1112                                    struct bio *bio, gfp_t gfp_mask)
1113 {
1114         const bool is_sync = rw_is_sync(rw_flags) != 0;
1115         DEFINE_WAIT(wait);
1116         struct request_list *rl;
1117         struct request *rq;
1118
1119         rl = blk_get_rl(q, bio);        /* transferred to @rq on success */
1120 retry:
1121         rq = __get_request(rl, rw_flags, bio, gfp_mask);
1122         if (!IS_ERR(rq))
1123                 return rq;
1124
1125         if (!(gfp_mask & __GFP_WAIT) || unlikely(blk_queue_dying(q))) {
1126                 blk_put_rl(rl);
1127                 return rq;
1128         }
1129
1130         /* wait on @rl and retry */
1131         prepare_to_wait_exclusive(&rl->wait[is_sync], &wait,
1132                                   TASK_UNINTERRUPTIBLE);
1133
1134         trace_block_sleeprq(q, bio, rw_flags & 1);
1135
1136         spin_unlock_irq(q->queue_lock);
1137         io_schedule();
1138
1139         /*
1140          * After sleeping, we become a "batching" process and will be able
1141          * to allocate at least one request, and up to a big batch of them
1142          * for a small period time.  See ioc_batching, ioc_set_batching
1143          */
1144         ioc_set_batching(q, current->io_context);
1145
1146         spin_lock_irq(q->queue_lock);
1147         finish_wait(&rl->wait[is_sync], &wait);
1148
1149         goto retry;
1150 }
1151
1152 static struct request *blk_old_get_request(struct request_queue *q, int rw,
1153                 gfp_t gfp_mask)
1154 {
1155         struct request *rq;
1156
1157         BUG_ON(rw != READ && rw != WRITE);
1158
1159         /* create ioc upfront */
1160         create_io_context(gfp_mask, q->node);
1161
1162         spin_lock_irq(q->queue_lock);
1163         rq = get_request(q, rw, NULL, gfp_mask);
1164         if (IS_ERR(rq))
1165                 spin_unlock_irq(q->queue_lock);
1166         /* q->queue_lock is unlocked at this point */
1167
1168         return rq;
1169 }
1170
1171 struct request *blk_get_request(struct request_queue *q, int rw, gfp_t gfp_mask)
1172 {
1173         if (q->mq_ops)
1174                 return blk_mq_alloc_request(q, rw, gfp_mask, false);
1175         else
1176                 return blk_old_get_request(q, rw, gfp_mask);
1177 }
1178 EXPORT_SYMBOL(blk_get_request);
1179
1180 /**
1181  * blk_make_request - given a bio, allocate a corresponding struct request.
1182  * @q: target request queue
1183  * @bio:  The bio describing the memory mappings that will be submitted for IO.
1184  *        It may be a chained-bio properly constructed by block/bio layer.
1185  * @gfp_mask: gfp flags to be used for memory allocation
1186  *
1187  * blk_make_request is the parallel of generic_make_request for BLOCK_PC
1188  * type commands. Where the struct request needs to be farther initialized by
1189  * the caller. It is passed a &struct bio, which describes the memory info of
1190  * the I/O transfer.
1191  *
1192  * The caller of blk_make_request must make sure that bi_io_vec
1193  * are set to describe the memory buffers. That bio_data_dir() will return
1194  * the needed direction of the request. (And all bio's in the passed bio-chain
1195  * are properly set accordingly)
1196  *
1197  * If called under none-sleepable conditions, mapped bio buffers must not
1198  * need bouncing, by calling the appropriate masked or flagged allocator,
1199  * suitable for the target device. Otherwise the call to blk_queue_bounce will
1200  * BUG.
1201  *
1202  * WARNING: When allocating/cloning a bio-chain, careful consideration should be
1203  * given to how you allocate bios. In particular, you cannot use __GFP_WAIT for
1204  * anything but the first bio in the chain. Otherwise you risk waiting for IO
1205  * completion of a bio that hasn't been submitted yet, thus resulting in a
1206  * deadlock. Alternatively bios should be allocated using bio_kmalloc() instead
1207  * of bio_alloc(), as that avoids the mempool deadlock.
1208  * If possible a big IO should be split into smaller parts when allocation
1209  * fails. Partial allocation should not be an error, or you risk a live-lock.
1210  */
1211 struct request *blk_make_request(struct request_queue *q, struct bio *bio,
1212                                  gfp_t gfp_mask)
1213 {
1214         struct request *rq = blk_get_request(q, bio_data_dir(bio), gfp_mask);
1215
1216         if (IS_ERR(rq))
1217                 return rq;
1218
1219         blk_rq_set_block_pc(rq);
1220
1221         for_each_bio(bio) {
1222                 struct bio *bounce_bio = bio;
1223                 int ret;
1224
1225                 blk_queue_bounce(q, &bounce_bio);
1226                 ret = blk_rq_append_bio(q, rq, bounce_bio);
1227                 if (unlikely(ret)) {
1228                         blk_put_request(rq);
1229                         return ERR_PTR(ret);
1230                 }
1231         }
1232
1233         return rq;
1234 }
1235 EXPORT_SYMBOL(blk_make_request);
1236
1237 /**
1238  * blk_rq_set_block_pc - initialize a requeest to type BLOCK_PC
1239  * @rq:         request to be initialized
1240  *
1241  */
1242 void blk_rq_set_block_pc(struct request *rq)
1243 {
1244         rq->cmd_type = REQ_TYPE_BLOCK_PC;
1245         rq->__data_len = 0;
1246         rq->__sector = (sector_t) -1;
1247         rq->bio = rq->biotail = NULL;
1248         memset(rq->__cmd, 0, sizeof(rq->__cmd));
1249 }
1250 EXPORT_SYMBOL(blk_rq_set_block_pc);
1251
1252 /**
1253  * blk_requeue_request - put a request back on queue
1254  * @q:          request queue where request should be inserted
1255  * @rq:         request to be inserted
1256  *
1257  * Description:
1258  *    Drivers often keep queueing requests until the hardware cannot accept
1259  *    more, when that condition happens we need to put the request back
1260  *    on the queue. Must be called with queue lock held.
1261  */
1262 void blk_requeue_request(struct request_queue *q, struct request *rq)
1263 {
1264         blk_delete_timer(rq);
1265         blk_clear_rq_complete(rq);
1266         trace_block_rq_requeue(q, rq);
1267
1268         if (blk_rq_tagged(rq))
1269                 blk_queue_end_tag(q, rq);
1270
1271         BUG_ON(blk_queued_rq(rq));
1272
1273         elv_requeue_request(q, rq);
1274 }
1275 EXPORT_SYMBOL(blk_requeue_request);
1276
1277 static void add_acct_request(struct request_queue *q, struct request *rq,
1278                              int where)
1279 {
1280         blk_account_io_start(rq, true);
1281         __elv_add_request(q, rq, where);
1282 }
1283
1284 static void part_round_stats_single(int cpu, struct hd_struct *part,
1285                                     unsigned long now)
1286 {
1287         int inflight;
1288
1289         if (now == part->stamp)
1290                 return;
1291
1292         inflight = part_in_flight(part);
1293         if (inflight) {
1294                 __part_stat_add(cpu, part, time_in_queue,
1295                                 inflight * (now - part->stamp));
1296                 __part_stat_add(cpu, part, io_ticks, (now - part->stamp));
1297         }
1298         part->stamp = now;
1299 }
1300
1301 /**
1302  * part_round_stats() - Round off the performance stats on a struct disk_stats.
1303  * @cpu: cpu number for stats access
1304  * @part: target partition
1305  *
1306  * The average IO queue length and utilisation statistics are maintained
1307  * by observing the current state of the queue length and the amount of
1308  * time it has been in this state for.
1309  *
1310  * Normally, that accounting is done on IO completion, but that can result
1311  * in more than a second's worth of IO being accounted for within any one
1312  * second, leading to >100% utilisation.  To deal with that, we call this
1313  * function to do a round-off before returning the results when reading
1314  * /proc/diskstats.  This accounts immediately for all queue usage up to
1315  * the current jiffies and restarts the counters again.
1316  */
1317 void part_round_stats(int cpu, struct hd_struct *part)
1318 {
1319         unsigned long now = jiffies;
1320
1321         if (part->partno)
1322                 part_round_stats_single(cpu, &part_to_disk(part)->part0, now);
1323         part_round_stats_single(cpu, part, now);
1324 }
1325 EXPORT_SYMBOL_GPL(part_round_stats);
1326
1327 #ifdef CONFIG_PM_RUNTIME
1328 static void blk_pm_put_request(struct request *rq)
1329 {
1330         if (rq->q->dev && !(rq->cmd_flags & REQ_PM) && !--rq->q->nr_pending)
1331                 pm_runtime_mark_last_busy(rq->q->dev);
1332 }
1333 #else
1334 static inline void blk_pm_put_request(struct request *rq) {}
1335 #endif
1336
1337 /*
1338  * queue lock must be held
1339  */
1340 void __blk_put_request(struct request_queue *q, struct request *req)
1341 {
1342         if (unlikely(!q))
1343                 return;
1344
1345         if (q->mq_ops) {
1346                 blk_mq_free_request(req);
1347                 return;
1348         }
1349
1350         blk_pm_put_request(req);
1351
1352         elv_completed_request(q, req);
1353
1354         /* this is a bio leak */
1355         WARN_ON(req->bio != NULL);
1356
1357         /*
1358          * Request may not have originated from ll_rw_blk. if not,
1359          * it didn't come out of our reserved rq pools
1360          */
1361         if (req->cmd_flags & REQ_ALLOCED) {
1362                 unsigned int flags = req->cmd_flags;
1363                 struct request_list *rl = blk_rq_rl(req);
1364
1365                 BUG_ON(!list_empty(&req->queuelist));
1366                 BUG_ON(ELV_ON_HASH(req));
1367
1368                 blk_free_request(rl, req);
1369                 freed_request(rl, flags);
1370                 blk_put_rl(rl);
1371         }
1372 }
1373 EXPORT_SYMBOL_GPL(__blk_put_request);
1374
1375 void blk_put_request(struct request *req)
1376 {
1377         struct request_queue *q = req->q;
1378
1379         if (q->mq_ops)
1380                 blk_mq_free_request(req);
1381         else {
1382                 unsigned long flags;
1383
1384                 spin_lock_irqsave(q->queue_lock, flags);
1385                 __blk_put_request(q, req);
1386                 spin_unlock_irqrestore(q->queue_lock, flags);
1387         }
1388 }
1389 EXPORT_SYMBOL(blk_put_request);
1390
1391 /**
1392  * blk_add_request_payload - add a payload to a request
1393  * @rq: request to update
1394  * @page: page backing the payload
1395  * @len: length of the payload.
1396  *
1397  * This allows to later add a payload to an already submitted request by
1398  * a block driver.  The driver needs to take care of freeing the payload
1399  * itself.
1400  *
1401  * Note that this is a quite horrible hack and nothing but handling of
1402  * discard requests should ever use it.
1403  */
1404 void blk_add_request_payload(struct request *rq, struct page *page,
1405                 unsigned int len)
1406 {
1407         struct bio *bio = rq->bio;
1408
1409         bio->bi_io_vec->bv_page = page;
1410         bio->bi_io_vec->bv_offset = 0;
1411         bio->bi_io_vec->bv_len = len;
1412
1413         bio->bi_iter.bi_size = len;
1414         bio->bi_vcnt = 1;
1415         bio->bi_phys_segments = 1;
1416
1417         rq->__data_len = rq->resid_len = len;
1418         rq->nr_phys_segments = 1;
1419 }
1420 EXPORT_SYMBOL_GPL(blk_add_request_payload);
1421
1422 bool bio_attempt_back_merge(struct request_queue *q, struct request *req,
1423                             struct bio *bio)
1424 {
1425         const int ff = bio->bi_rw & REQ_FAILFAST_MASK;
1426
1427         if (!ll_back_merge_fn(q, req, bio))
1428                 return false;
1429
1430         trace_block_bio_backmerge(q, req, bio);
1431
1432         if ((req->cmd_flags & REQ_FAILFAST_MASK) != ff)
1433                 blk_rq_set_mixed_merge(req);
1434
1435         req->biotail->bi_next = bio;
1436         req->biotail = bio;
1437         req->__data_len += bio->bi_iter.bi_size;
1438         req->ioprio = ioprio_best(req->ioprio, bio_prio(bio));
1439
1440         blk_account_io_start(req, false);
1441         return true;
1442 }
1443
1444 bool bio_attempt_front_merge(struct request_queue *q, struct request *req,
1445                              struct bio *bio)
1446 {
1447         const int ff = bio->bi_rw & REQ_FAILFAST_MASK;
1448
1449         if (!ll_front_merge_fn(q, req, bio))
1450                 return false;
1451
1452         trace_block_bio_frontmerge(q, req, bio);
1453
1454         if ((req->cmd_flags & REQ_FAILFAST_MASK) != ff)
1455                 blk_rq_set_mixed_merge(req);
1456
1457         bio->bi_next = req->bio;
1458         req->bio = bio;
1459
1460         req->__sector = bio->bi_iter.bi_sector;
1461         req->__data_len += bio->bi_iter.bi_size;
1462         req->ioprio = ioprio_best(req->ioprio, bio_prio(bio));
1463
1464         blk_account_io_start(req, false);
1465         return true;
1466 }
1467
1468 /**
1469  * blk_attempt_plug_merge - try to merge with %current's plugged list
1470  * @q: request_queue new bio is being queued at
1471  * @bio: new bio being queued
1472  * @request_count: out parameter for number of traversed plugged requests
1473  *
1474  * Determine whether @bio being queued on @q can be merged with a request
1475  * on %current's plugged list.  Returns %true if merge was successful,
1476  * otherwise %false.
1477  *
1478  * Plugging coalesces IOs from the same issuer for the same purpose without
1479  * going through @q->queue_lock.  As such it's more of an issuing mechanism
1480  * than scheduling, and the request, while may have elvpriv data, is not
1481  * added on the elevator at this point.  In addition, we don't have
1482  * reliable access to the elevator outside queue lock.  Only check basic
1483  * merging parameters without querying the elevator.
1484  *
1485  * Caller must ensure !blk_queue_nomerges(q) beforehand.
1486  */
1487 bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
1488                             unsigned int *request_count)
1489 {
1490         struct blk_plug *plug;
1491         struct request *rq;
1492         bool ret = false;
1493         struct list_head *plug_list;
1494
1495         plug = current->plug;
1496         if (!plug)
1497                 goto out;
1498         *request_count = 0;
1499
1500         if (q->mq_ops)
1501                 plug_list = &plug->mq_list;
1502         else
1503                 plug_list = &plug->list;
1504
1505         list_for_each_entry_reverse(rq, plug_list, queuelist) {
1506                 int el_ret;
1507
1508                 if (rq->q == q)
1509                         (*request_count)++;
1510
1511                 if (rq->q != q || !blk_rq_merge_ok(rq, bio))
1512                         continue;
1513
1514                 el_ret = blk_try_merge(rq, bio);
1515                 if (el_ret == ELEVATOR_BACK_MERGE) {
1516                         ret = bio_attempt_back_merge(q, rq, bio);
1517                         if (ret)
1518                                 break;
1519                 } else if (el_ret == ELEVATOR_FRONT_MERGE) {
1520                         ret = bio_attempt_front_merge(q, rq, bio);
1521                         if (ret)
1522                                 break;
1523                 }
1524         }
1525 out:
1526         return ret;
1527 }
1528
1529 void init_request_from_bio(struct request *req, struct bio *bio)
1530 {
1531         req->cmd_type = REQ_TYPE_FS;
1532
1533         req->cmd_flags |= bio->bi_rw & REQ_COMMON_MASK;
1534         if (bio->bi_rw & REQ_RAHEAD)
1535                 req->cmd_flags |= REQ_FAILFAST_MASK;
1536
1537         req->errors = 0;
1538         req->__sector = bio->bi_iter.bi_sector;
1539         req->ioprio = bio_prio(bio);
1540         blk_rq_bio_prep(req->q, req, bio);
1541 }
1542
1543 void blk_queue_bio(struct request_queue *q, struct bio *bio)
1544 {
1545         const bool sync = !!(bio->bi_rw & REQ_SYNC);
1546         struct blk_plug *plug;
1547         int el_ret, rw_flags, where = ELEVATOR_INSERT_SORT;
1548         struct request *req;
1549         unsigned int request_count = 0;
1550
1551         /*
1552          * low level driver can indicate that it wants pages above a
1553          * certain limit bounced to low memory (ie for highmem, or even
1554          * ISA dma in theory)
1555          */
1556         blk_queue_bounce(q, &bio);
1557
1558         if (bio_integrity_enabled(bio) && bio_integrity_prep(bio)) {
1559                 bio_endio(bio, -EIO);
1560                 return;
1561         }
1562
1563         if (bio->bi_rw & (REQ_FLUSH | REQ_FUA)) {
1564                 spin_lock_irq(q->queue_lock);
1565                 where = ELEVATOR_INSERT_FLUSH;
1566                 goto get_rq;
1567         }
1568
1569         /*
1570          * Check if we can merge with the plugged list before grabbing
1571          * any locks.
1572          */
1573         if (!blk_queue_nomerges(q) &&
1574             blk_attempt_plug_merge(q, bio, &request_count))
1575                 return;
1576
1577         spin_lock_irq(q->queue_lock);
1578
1579         el_ret = elv_merge(q, &req, bio);
1580         if (el_ret == ELEVATOR_BACK_MERGE) {
1581                 if (bio_attempt_back_merge(q, req, bio)) {
1582                         elv_bio_merged(q, req, bio);
1583                         if (!attempt_back_merge(q, req))
1584                                 elv_merged_request(q, req, el_ret);
1585                         goto out_unlock;
1586                 }
1587         } else if (el_ret == ELEVATOR_FRONT_MERGE) {
1588                 if (bio_attempt_front_merge(q, req, bio)) {
1589                         elv_bio_merged(q, req, bio);
1590                         if (!attempt_front_merge(q, req))
1591                                 elv_merged_request(q, req, el_ret);
1592                         goto out_unlock;
1593                 }
1594         }
1595
1596 get_rq:
1597         /*
1598          * This sync check and mask will be re-done in init_request_from_bio(),
1599          * but we need to set it earlier to expose the sync flag to the
1600          * rq allocator and io schedulers.
1601          */
1602         rw_flags = bio_data_dir(bio);
1603         if (sync)
1604                 rw_flags |= REQ_SYNC;
1605
1606         /*
1607          * Grab a free request. This is might sleep but can not fail.
1608          * Returns with the queue unlocked.
1609          */
1610         req = get_request(q, rw_flags, bio, GFP_NOIO);
1611         if (IS_ERR(req)) {
1612                 bio_endio(bio, PTR_ERR(req));   /* @q is dead */
1613                 goto out_unlock;
1614         }
1615
1616         /*
1617          * After dropping the lock and possibly sleeping here, our request
1618          * may now be mergeable after it had proven unmergeable (above).
1619          * We don't worry about that case for efficiency. It won't happen
1620          * often, and the elevators are able to handle it.
1621          */
1622         init_request_from_bio(req, bio);
1623
1624         if (test_bit(QUEUE_FLAG_SAME_COMP, &q->queue_flags))
1625                 req->cpu = raw_smp_processor_id();
1626
1627         plug = current->plug;
1628         if (plug) {
1629                 /*
1630                  * If this is the first request added after a plug, fire
1631                  * of a plug trace.
1632                  */
1633                 if (!request_count)
1634                         trace_block_plug(q);
1635                 else {
1636                         if (request_count >= BLK_MAX_REQUEST_COUNT) {
1637                                 blk_flush_plug_list(plug, false);
1638                                 trace_block_plug(q);
1639                         }
1640                 }
1641                 list_add_tail(&req->queuelist, &plug->list);
1642                 blk_account_io_start(req, true);
1643         } else {
1644                 spin_lock_irq(q->queue_lock);
1645                 add_acct_request(q, req, where);
1646                 __blk_run_queue(q);
1647 out_unlock:
1648                 spin_unlock_irq(q->queue_lock);
1649         }
1650 }
1651 EXPORT_SYMBOL_GPL(blk_queue_bio);       /* for device mapper only */
1652
1653 /*
1654  * If bio->bi_dev is a partition, remap the location
1655  */
1656 static inline void blk_partition_remap(struct bio *bio)
1657 {
1658         struct block_device *bdev = bio->bi_bdev;
1659
1660         if (bio_sectors(bio) && bdev != bdev->bd_contains) {
1661                 struct hd_struct *p = bdev->bd_part;
1662
1663                 bio->bi_iter.bi_sector += p->start_sect;
1664                 bio->bi_bdev = bdev->bd_contains;
1665
1666                 trace_block_bio_remap(bdev_get_queue(bio->bi_bdev), bio,
1667                                       bdev->bd_dev,
1668                                       bio->bi_iter.bi_sector - p->start_sect);
1669         }
1670 }
1671
1672 static void handle_bad_sector(struct bio *bio)
1673 {
1674         char b[BDEVNAME_SIZE];
1675
1676         printk(KERN_INFO "attempt to access beyond end of device\n");
1677         printk(KERN_INFO "%s: rw=%ld, want=%Lu, limit=%Lu\n",
1678                         bdevname(bio->bi_bdev, b),
1679                         bio->bi_rw,
1680                         (unsigned long long)bio_end_sector(bio),
1681                         (long long)(i_size_read(bio->bi_bdev->bd_inode) >> 9));
1682
1683         set_bit(BIO_EOF, &bio->bi_flags);
1684 }
1685
1686 #ifdef CONFIG_FAIL_MAKE_REQUEST
1687
1688 static DECLARE_FAULT_ATTR(fail_make_request);
1689
1690 static int __init setup_fail_make_request(char *str)
1691 {
1692         return setup_fault_attr(&fail_make_request, str);
1693 }
1694 __setup("fail_make_request=", setup_fail_make_request);
1695
1696 static bool should_fail_request(struct hd_struct *part, unsigned int bytes)
1697 {
1698         return part->make_it_fail && should_fail(&fail_make_request, bytes);
1699 }
1700
1701 static int __init fail_make_request_debugfs(void)
1702 {
1703         struct dentry *dir = fault_create_debugfs_attr("fail_make_request",
1704                                                 NULL, &fail_make_request);
1705
1706         return PTR_ERR_OR_ZERO(dir);
1707 }
1708
1709 late_initcall(fail_make_request_debugfs);
1710
1711 #else /* CONFIG_FAIL_MAKE_REQUEST */
1712
1713 static inline bool should_fail_request(struct hd_struct *part,
1714                                         unsigned int bytes)
1715 {
1716         return false;
1717 }
1718
1719 #endif /* CONFIG_FAIL_MAKE_REQUEST */
1720
1721 /*
1722  * Check whether this bio extends beyond the end of the device.
1723  */
1724 static inline int bio_check_eod(struct bio *bio, unsigned int nr_sectors)
1725 {
1726         sector_t maxsector;
1727
1728         if (!nr_sectors)
1729                 return 0;
1730
1731         /* Test device or partition size, when known. */
1732         maxsector = i_size_read(bio->bi_bdev->bd_inode) >> 9;
1733         if (maxsector) {
1734                 sector_t sector = bio->bi_iter.bi_sector;
1735
1736                 if (maxsector < nr_sectors || maxsector - nr_sectors < sector) {
1737                         /*
1738                          * This may well happen - the kernel calls bread()
1739                          * without checking the size of the device, e.g., when
1740                          * mounting a device.
1741                          */
1742                         handle_bad_sector(bio);
1743                         return 1;
1744                 }
1745         }
1746
1747         return 0;
1748 }
1749
1750 static noinline_for_stack bool
1751 generic_make_request_checks(struct bio *bio)
1752 {
1753         struct request_queue *q;
1754         int nr_sectors = bio_sectors(bio);
1755         int err = -EIO;
1756         char b[BDEVNAME_SIZE];
1757         struct hd_struct *part;
1758
1759         might_sleep();
1760
1761         if (bio_check_eod(bio, nr_sectors))
1762                 goto end_io;
1763
1764         q = bdev_get_queue(bio->bi_bdev);
1765         if (unlikely(!q)) {
1766                 printk(KERN_ERR
1767                        "generic_make_request: Trying to access "
1768                         "nonexistent block-device %s (%Lu)\n",
1769                         bdevname(bio->bi_bdev, b),
1770                         (long long) bio->bi_iter.bi_sector);
1771                 goto end_io;
1772         }
1773
1774         if (likely(bio_is_rw(bio) &&
1775                    nr_sectors > queue_max_hw_sectors(q))) {
1776                 printk(KERN_ERR "bio too big device %s (%u > %u)\n",
1777                        bdevname(bio->bi_bdev, b),
1778                        bio_sectors(bio),
1779                        queue_max_hw_sectors(q));
1780                 goto end_io;
1781         }
1782
1783         part = bio->bi_bdev->bd_part;
1784         if (should_fail_request(part, bio->bi_iter.bi_size) ||
1785             should_fail_request(&part_to_disk(part)->part0,
1786                                 bio->bi_iter.bi_size))
1787                 goto end_io;
1788
1789         /*
1790          * If this device has partitions, remap block n
1791          * of partition p to block n+start(p) of the disk.
1792          */
1793         blk_partition_remap(bio);
1794
1795         if (bio_check_eod(bio, nr_sectors))
1796                 goto end_io;
1797
1798         /*
1799          * Filter flush bio's early so that make_request based
1800          * drivers without flush support don't have to worry
1801          * about them.
1802          */
1803         if ((bio->bi_rw & (REQ_FLUSH | REQ_FUA)) && !q->flush_flags) {
1804                 bio->bi_rw &= ~(REQ_FLUSH | REQ_FUA);
1805                 if (!nr_sectors) {
1806                         err = 0;
1807                         goto end_io;
1808                 }
1809         }
1810
1811         if ((bio->bi_rw & REQ_DISCARD) &&
1812             (!blk_queue_discard(q) ||
1813              ((bio->bi_rw & REQ_SECURE) && !blk_queue_secdiscard(q)))) {
1814                 err = -EOPNOTSUPP;
1815                 goto end_io;
1816         }
1817
1818         if (bio->bi_rw & REQ_WRITE_SAME && !bdev_write_same(bio->bi_bdev)) {
1819                 err = -EOPNOTSUPP;
1820                 goto end_io;
1821         }
1822
1823         /*
1824          * Various block parts want %current->io_context and lazy ioc
1825          * allocation ends up trading a lot of pain for a small amount of
1826          * memory.  Just allocate it upfront.  This may fail and block
1827          * layer knows how to live with it.
1828          */
1829         create_io_context(GFP_ATOMIC, q->node);
1830
1831         if (blk_throtl_bio(q, bio))
1832                 return false;   /* throttled, will be resubmitted later */
1833
1834         trace_block_bio_queue(q, bio);
1835         return true;
1836
1837 end_io:
1838         bio_endio(bio, err);
1839         return false;
1840 }
1841
1842 /**
1843  * generic_make_request - hand a buffer to its device driver for I/O
1844  * @bio:  The bio describing the location in memory and on the device.
1845  *
1846  * generic_make_request() is used to make I/O requests of block
1847  * devices. It is passed a &struct bio, which describes the I/O that needs
1848  * to be done.
1849  *
1850  * generic_make_request() does not return any status.  The
1851  * success/failure status of the request, along with notification of
1852  * completion, is delivered asynchronously through the bio->bi_end_io
1853  * function described (one day) else where.
1854  *
1855  * The caller of generic_make_request must make sure that bi_io_vec
1856  * are set to describe the memory buffer, and that bi_dev and bi_sector are
1857  * set to describe the device address, and the
1858  * bi_end_io and optionally bi_private are set to describe how
1859  * completion notification should be signaled.
1860  *
1861  * generic_make_request and the drivers it calls may use bi_next if this
1862  * bio happens to be merged with someone else, and may resubmit the bio to
1863  * a lower device by calling into generic_make_request recursively, which
1864  * means the bio should NOT be touched after the call to ->make_request_fn.
1865  */
1866 void generic_make_request(struct bio *bio)
1867 {
1868         struct bio_list bio_list_on_stack;
1869
1870         if (!generic_make_request_checks(bio))
1871                 return;
1872
1873         /*
1874          * We only want one ->make_request_fn to be active at a time, else
1875          * stack usage with stacked devices could be a problem.  So use
1876          * current->bio_list to keep a list of requests submited by a
1877          * make_request_fn function.  current->bio_list is also used as a
1878          * flag to say if generic_make_request is currently active in this
1879          * task or not.  If it is NULL, then no make_request is active.  If
1880          * it is non-NULL, then a make_request is active, and new requests
1881          * should be added at the tail
1882          */
1883         if (current->bio_list) {
1884                 bio_list_add(current->bio_list, bio);
1885                 return;
1886         }
1887
1888         /* following loop may be a bit non-obvious, and so deserves some
1889          * explanation.
1890          * Before entering the loop, bio->bi_next is NULL (as all callers
1891          * ensure that) so we have a list with a single bio.
1892          * We pretend that we have just taken it off a longer list, so
1893          * we assign bio_list to a pointer to the bio_list_on_stack,
1894          * thus initialising the bio_list of new bios to be
1895          * added.  ->make_request() may indeed add some more bios
1896          * through a recursive call to generic_make_request.  If it
1897          * did, we find a non-NULL value in bio_list and re-enter the loop
1898          * from the top.  In this case we really did just take the bio
1899          * of the top of the list (no pretending) and so remove it from
1900          * bio_list, and call into ->make_request() again.
1901          */
1902         BUG_ON(bio->bi_next);
1903         bio_list_init(&bio_list_on_stack);
1904         current->bio_list = &bio_list_on_stack;
1905         do {
1906                 struct request_queue *q = bdev_get_queue(bio->bi_bdev);
1907
1908                 q->make_request_fn(q, bio);
1909
1910                 bio = bio_list_pop(current->bio_list);
1911         } while (bio);
1912         current->bio_list = NULL; /* deactivate */
1913 }
1914 EXPORT_SYMBOL(generic_make_request);
1915
1916 /**
1917  * submit_bio - submit a bio to the block device layer for I/O
1918  * @rw: whether to %READ or %WRITE, or maybe to %READA (read ahead)
1919  * @bio: The &struct bio which describes the I/O
1920  *
1921  * submit_bio() is very similar in purpose to generic_make_request(), and
1922  * uses that function to do most of the work. Both are fairly rough
1923  * interfaces; @bio must be presetup and ready for I/O.
1924  *
1925  */
1926 void submit_bio(int rw, struct bio *bio)
1927 {
1928         bio->bi_rw |= rw;
1929
1930         /*
1931          * If it's a regular read/write or a barrier with data attached,
1932          * go through the normal accounting stuff before submission.
1933          */
1934         if (bio_has_data(bio)) {
1935                 unsigned int count;
1936
1937                 if (unlikely(rw & REQ_WRITE_SAME))
1938                         count = bdev_logical_block_size(bio->bi_bdev) >> 9;
1939                 else
1940                         count = bio_sectors(bio);
1941
1942                 if (rw & WRITE) {
1943                         count_vm_events(PGPGOUT, count);
1944                 } else {
1945                         task_io_account_read(bio->bi_iter.bi_size);
1946                         count_vm_events(PGPGIN, count);
1947                 }
1948
1949                 if (unlikely(block_dump)) {
1950                         char b[BDEVNAME_SIZE];
1951                         printk(KERN_DEBUG "%s(%d): %s block %Lu on %s (%u sectors)\n",
1952                         current->comm, task_pid_nr(current),
1953                                 (rw & WRITE) ? "WRITE" : "READ",
1954                                 (unsigned long long)bio->bi_iter.bi_sector,
1955                                 bdevname(bio->bi_bdev, b),
1956                                 count);
1957                 }
1958         }
1959
1960         generic_make_request(bio);
1961 }
1962 EXPORT_SYMBOL(submit_bio);
1963
1964 /**
1965  * blk_rq_check_limits - Helper function to check a request for the queue limit
1966  * @q:  the queue
1967  * @rq: the request being checked
1968  *
1969  * Description:
1970  *    @rq may have been made based on weaker limitations of upper-level queues
1971  *    in request stacking drivers, and it may violate the limitation of @q.
1972  *    Since the block layer and the underlying device driver trust @rq
1973  *    after it is inserted to @q, it should be checked against @q before
1974  *    the insertion using this generic function.
1975  *
1976  *    This function should also be useful for request stacking drivers
1977  *    in some cases below, so export this function.
1978  *    Request stacking drivers like request-based dm may change the queue
1979  *    limits while requests are in the queue (e.g. dm's table swapping).
1980  *    Such request stacking drivers should check those requests against
1981  *    the new queue limits again when they dispatch those requests,
1982  *    although such checkings are also done against the old queue limits
1983  *    when submitting requests.
1984  */
1985 int blk_rq_check_limits(struct request_queue *q, struct request *rq)
1986 {
1987         if (!rq_mergeable(rq))
1988                 return 0;
1989
1990         if (blk_rq_sectors(rq) > blk_queue_get_max_sectors(q, rq->cmd_flags)) {
1991                 printk(KERN_ERR "%s: over max size limit.\n", __func__);
1992                 return -EIO;
1993         }
1994
1995         /*
1996          * queue's settings related to segment counting like q->bounce_pfn
1997          * may differ from that of other stacking queues.
1998          * Recalculate it to check the request correctly on this queue's
1999          * limitation.
2000          */
2001         blk_recalc_rq_segments(rq);
2002         if (rq->nr_phys_segments > queue_max_segments(q)) {
2003                 printk(KERN_ERR "%s: over max segments limit.\n", __func__);
2004                 return -EIO;
2005         }
2006
2007         return 0;
2008 }
2009 EXPORT_SYMBOL_GPL(blk_rq_check_limits);
2010
2011 /**
2012  * blk_insert_cloned_request - Helper for stacking drivers to submit a request
2013  * @q:  the queue to submit the request
2014  * @rq: the request being queued
2015  */
2016 int blk_insert_cloned_request(struct request_queue *q, struct request *rq)
2017 {
2018         unsigned long flags;
2019         int where = ELEVATOR_INSERT_BACK;
2020
2021         if (blk_rq_check_limits(q, rq))
2022                 return -EIO;
2023
2024         if (rq->rq_disk &&
2025             should_fail_request(&rq->rq_disk->part0, blk_rq_bytes(rq)))
2026                 return -EIO;
2027
2028         spin_lock_irqsave(q->queue_lock, flags);
2029         if (unlikely(blk_queue_dying(q))) {
2030                 spin_unlock_irqrestore(q->queue_lock, flags);
2031                 return -ENODEV;
2032         }
2033
2034         /*
2035          * Submitting request must be dequeued before calling this function
2036          * because it will be linked to another request_queue
2037          */
2038         BUG_ON(blk_queued_rq(rq));
2039
2040         if (rq->cmd_flags & (REQ_FLUSH|REQ_FUA))
2041                 where = ELEVATOR_INSERT_FLUSH;
2042
2043         add_acct_request(q, rq, where);
2044         if (where == ELEVATOR_INSERT_FLUSH)
2045                 __blk_run_queue(q);
2046         spin_unlock_irqrestore(q->queue_lock, flags);
2047
2048         return 0;
2049 }
2050 EXPORT_SYMBOL_GPL(blk_insert_cloned_request);
2051
2052 /**
2053  * blk_rq_err_bytes - determine number of bytes till the next failure boundary
2054  * @rq: request to examine
2055  *
2056  * Description:
2057  *     A request could be merge of IOs which require different failure
2058  *     handling.  This function determines the number of bytes which
2059  *     can be failed from the beginning of the request without
2060  *     crossing into area which need to be retried further.
2061  *
2062  * Return:
2063  *     The number of bytes to fail.
2064  *
2065  * Context:
2066  *     queue_lock must be held.
2067  */
2068 unsigned int blk_rq_err_bytes(const struct request *rq)
2069 {
2070         unsigned int ff = rq->cmd_flags & REQ_FAILFAST_MASK;
2071         unsigned int bytes = 0;
2072         struct bio *bio;
2073
2074         if (!(rq->cmd_flags & REQ_MIXED_MERGE))
2075                 return blk_rq_bytes(rq);
2076
2077         /*
2078          * Currently the only 'mixing' which can happen is between
2079          * different fastfail types.  We can safely fail portions
2080          * which have all the failfast bits that the first one has -
2081          * the ones which are at least as eager to fail as the first
2082          * one.
2083          */
2084         for (bio = rq->bio; bio; bio = bio->bi_next) {
2085                 if ((bio->bi_rw & ff) != ff)
2086                         break;
2087                 bytes += bio->bi_iter.bi_size;
2088         }
2089
2090         /* this could lead to infinite loop */
2091         BUG_ON(blk_rq_bytes(rq) && !bytes);
2092         return bytes;
2093 }
2094 EXPORT_SYMBOL_GPL(blk_rq_err_bytes);
2095
2096 void blk_account_io_completion(struct request *req, unsigned int bytes)
2097 {
2098         if (blk_do_io_stat(req)) {
2099                 const int rw = rq_data_dir(req);
2100                 struct hd_struct *part;
2101                 int cpu;
2102
2103                 cpu = part_stat_lock();
2104                 part = req->part;
2105                 part_stat_add(cpu, part, sectors[rw], bytes >> 9);
2106                 part_stat_unlock();
2107         }
2108 }
2109
2110 void blk_account_io_done(struct request *req)
2111 {
2112         /*
2113          * Account IO completion.  flush_rq isn't accounted as a
2114          * normal IO on queueing nor completion.  Accounting the
2115          * containing request is enough.
2116          */
2117         if (blk_do_io_stat(req) && !(req->cmd_flags & REQ_FLUSH_SEQ)) {
2118                 unsigned long duration = jiffies - req->start_time;
2119                 const int rw = rq_data_dir(req);
2120                 struct hd_struct *part;
2121                 int cpu;
2122
2123                 cpu = part_stat_lock();
2124                 part = req->part;
2125
2126                 part_stat_inc(cpu, part, ios[rw]);
2127                 part_stat_add(cpu, part, ticks[rw], duration);
2128                 part_round_stats(cpu, part);
2129                 part_dec_in_flight(part, rw);
2130
2131                 hd_struct_put(part);
2132                 part_stat_unlock();
2133         }
2134 }
2135
2136 #ifdef CONFIG_PM_RUNTIME
2137 /*
2138  * Don't process normal requests when queue is suspended
2139  * or in the process of suspending/resuming
2140  */
2141 static struct request *blk_pm_peek_request(struct request_queue *q,
2142                                            struct request *rq)
2143 {
2144         if (q->dev && (q->rpm_status == RPM_SUSPENDED ||
2145             (q->rpm_status != RPM_ACTIVE && !(rq->cmd_flags & REQ_PM))))
2146                 return NULL;
2147         else
2148                 return rq;
2149 }
2150 #else
2151 static inline struct request *blk_pm_peek_request(struct request_queue *q,
2152                                                   struct request *rq)
2153 {
2154         return rq;
2155 }
2156 #endif
2157
2158 void blk_account_io_start(struct request *rq, bool new_io)
2159 {
2160         struct hd_struct *part;
2161         int rw = rq_data_dir(rq);
2162         int cpu;
2163
2164         if (!blk_do_io_stat(rq))
2165                 return;
2166
2167         cpu = part_stat_lock();
2168
2169         if (!new_io) {
2170                 part = rq->part;
2171                 part_stat_inc(cpu, part, merges[rw]);
2172         } else {
2173                 part = disk_map_sector_rcu(rq->rq_disk, blk_rq_pos(rq));
2174                 if (!hd_struct_try_get(part)) {
2175                         /*
2176                          * The partition is already being removed,
2177                          * the request will be accounted on the disk only
2178                          *
2179                          * We take a reference on disk->part0 although that
2180                          * partition will never be deleted, so we can treat
2181                          * it as any other partition.
2182                          */
2183                         part = &rq->rq_disk->part0;
2184                         hd_struct_get(part);
2185                 }
2186                 part_round_stats(cpu, part);
2187                 part_inc_in_flight(part, rw);
2188                 rq->part = part;
2189         }
2190
2191         part_stat_unlock();
2192 }
2193
2194 /**
2195  * blk_peek_request - peek at the top of a request queue
2196  * @q: request queue to peek at
2197  *
2198  * Description:
2199  *     Return the request at the top of @q.  The returned request
2200  *     should be started using blk_start_request() before LLD starts
2201  *     processing it.
2202  *
2203  * Return:
2204  *     Pointer to the request at the top of @q if available.  Null
2205  *     otherwise.
2206  *
2207  * Context:
2208  *     queue_lock must be held.
2209  */
2210 struct request *blk_peek_request(struct request_queue *q)
2211 {
2212         struct request *rq;
2213         int ret;
2214
2215         while ((rq = __elv_next_request(q)) != NULL) {
2216
2217                 rq = blk_pm_peek_request(q, rq);
2218                 if (!rq)
2219                         break;
2220
2221                 if (!(rq->cmd_flags & REQ_STARTED)) {
2222                         /*
2223                          * This is the first time the device driver
2224                          * sees this request (possibly after
2225                          * requeueing).  Notify IO scheduler.
2226                          */
2227                         if (rq->cmd_flags & REQ_SORTED)
2228                                 elv_activate_rq(q, rq);
2229
2230                         /*
2231                          * just mark as started even if we don't start
2232                          * it, a request that has been delayed should
2233                          * not be passed by new incoming requests
2234                          */
2235                         rq->cmd_flags |= REQ_STARTED;
2236                         trace_block_rq_issue(q, rq);
2237                 }
2238
2239                 if (!q->boundary_rq || q->boundary_rq == rq) {
2240                         q->end_sector = rq_end_sector(rq);
2241                         q->boundary_rq = NULL;
2242                 }
2243
2244                 if (rq->cmd_flags & REQ_DONTPREP)
2245                         break;
2246
2247                 if (q->dma_drain_size && blk_rq_bytes(rq)) {
2248                         /*
2249                          * make sure space for the drain appears we
2250                          * know we can do this because max_hw_segments
2251                          * has been adjusted to be one fewer than the
2252                          * device can handle
2253                          */
2254                         rq->nr_phys_segments++;
2255                 }
2256
2257                 if (!q->prep_rq_fn)
2258                         break;
2259
2260                 ret = q->prep_rq_fn(q, rq);
2261                 if (ret == BLKPREP_OK) {
2262                         break;
2263                 } else if (ret == BLKPREP_DEFER) {
2264                         /*
2265                          * the request may have been (partially) prepped.
2266                          * we need to keep this request in the front to
2267                          * avoid resource deadlock.  REQ_STARTED will
2268                          * prevent other fs requests from passing this one.
2269                          */
2270                         if (q->dma_drain_size && blk_rq_bytes(rq) &&
2271                             !(rq->cmd_flags & REQ_DONTPREP)) {
2272                                 /*
2273                                  * remove the space for the drain we added
2274                                  * so that we don't add it again
2275                                  */
2276                                 --rq->nr_phys_segments;
2277                         }
2278
2279                         rq = NULL;
2280                         break;
2281                 } else if (ret == BLKPREP_KILL) {
2282                         rq->cmd_flags |= REQ_QUIET;
2283                         /*
2284                          * Mark this request as started so we don't trigger
2285                          * any debug logic in the end I/O path.
2286                          */
2287                         blk_start_request(rq);
2288                         __blk_end_request_all(rq, -EIO);
2289                 } else {
2290                         printk(KERN_ERR "%s: bad return=%d\n", __func__, ret);
2291                         break;
2292                 }
2293         }
2294
2295         return rq;
2296 }
2297 EXPORT_SYMBOL(blk_peek_request);
2298
2299 void blk_dequeue_request(struct request *rq)
2300 {
2301         struct request_queue *q = rq->q;
2302
2303         BUG_ON(list_empty(&rq->queuelist));
2304         BUG_ON(ELV_ON_HASH(rq));
2305
2306         list_del_init(&rq->queuelist);
2307
2308         /*
2309          * the time frame between a request being removed from the lists
2310          * and to it is freed is accounted as io that is in progress at
2311          * the driver side.
2312          */
2313         if (blk_account_rq(rq)) {
2314                 q->in_flight[rq_is_sync(rq)]++;
2315                 set_io_start_time_ns(rq);
2316         }
2317 }
2318
2319 /**
2320  * blk_start_request - start request processing on the driver
2321  * @req: request to dequeue
2322  *
2323  * Description:
2324  *     Dequeue @req and start timeout timer on it.  This hands off the
2325  *     request to the driver.
2326  *
2327  *     Block internal functions which don't want to start timer should
2328  *     call blk_dequeue_request().
2329  *
2330  * Context:
2331  *     queue_lock must be held.
2332  */
2333 void blk_start_request(struct request *req)
2334 {
2335         blk_dequeue_request(req);
2336
2337         /*
2338          * We are now handing the request to the hardware, initialize
2339          * resid_len to full count and add the timeout handler.
2340          */
2341         req->resid_len = blk_rq_bytes(req);
2342         if (unlikely(blk_bidi_rq(req)))
2343                 req->next_rq->resid_len = blk_rq_bytes(req->next_rq);
2344
2345         BUG_ON(test_bit(REQ_ATOM_COMPLETE, &req->atomic_flags));
2346         blk_add_timer(req);
2347 }
2348 EXPORT_SYMBOL(blk_start_request);
2349
2350 /**
2351  * blk_fetch_request - fetch a request from a request queue
2352  * @q: request queue to fetch a request from
2353  *
2354  * Description:
2355  *     Return the request at the top of @q.  The request is started on
2356  *     return and LLD can start processing it immediately.
2357  *
2358  * Return:
2359  *     Pointer to the request at the top of @q if available.  Null
2360  *     otherwise.
2361  *
2362  * Context:
2363  *     queue_lock must be held.
2364  */
2365 struct request *blk_fetch_request(struct request_queue *q)
2366 {
2367         struct request *rq;
2368
2369         rq = blk_peek_request(q);
2370         if (rq)
2371                 blk_start_request(rq);
2372         return rq;
2373 }
2374 EXPORT_SYMBOL(blk_fetch_request);
2375
2376 /**
2377  * blk_update_request - Special helper function for request stacking drivers
2378  * @req:      the request being processed
2379  * @error:    %0 for success, < %0 for error
2380  * @nr_bytes: number of bytes to complete @req
2381  *
2382  * Description:
2383  *     Ends I/O on a number of bytes attached to @req, but doesn't complete
2384  *     the request structure even if @req doesn't have leftover.
2385  *     If @req has leftover, sets it up for the next range of segments.
2386  *
2387  *     This special helper function is only for request stacking drivers
2388  *     (e.g. request-based dm) so that they can handle partial completion.
2389  *     Actual device drivers should use blk_end_request instead.
2390  *
2391  *     Passing the result of blk_rq_bytes() as @nr_bytes guarantees
2392  *     %false return from this function.
2393  *
2394  * Return:
2395  *     %false - this request doesn't have any more data
2396  *     %true  - this request has more data
2397  **/
2398 bool blk_update_request(struct request *req, int error, unsigned int nr_bytes)
2399 {
2400         int total_bytes;
2401
2402         if (!req->bio)
2403                 return false;
2404
2405         trace_block_rq_complete(req->q, req, nr_bytes);
2406
2407         /*
2408          * For fs requests, rq is just carrier of independent bio's
2409          * and each partial completion should be handled separately.
2410          * Reset per-request error on each partial completion.
2411          *
2412          * TODO: tj: This is too subtle.  It would be better to let
2413          * low level drivers do what they see fit.
2414          */
2415         if (req->cmd_type == REQ_TYPE_FS)
2416                 req->errors = 0;
2417
2418         if (error && req->cmd_type == REQ_TYPE_FS &&
2419             !(req->cmd_flags & REQ_QUIET)) {
2420                 char *error_type;
2421
2422                 switch (error) {
2423                 case -ENOLINK:
2424                         error_type = "recoverable transport";
2425                         break;
2426                 case -EREMOTEIO:
2427                         error_type = "critical target";
2428                         break;
2429                 case -EBADE:
2430                         error_type = "critical nexus";
2431                         break;
2432                 case -ETIMEDOUT:
2433                         error_type = "timeout";
2434                         break;
2435                 case -ENOSPC:
2436                         error_type = "critical space allocation";
2437                         break;
2438                 case -ENODATA:
2439                         error_type = "critical medium";
2440                         break;
2441                 case -EIO:
2442                 default:
2443                         error_type = "I/O";
2444                         break;
2445                 }
2446                 printk_ratelimited(KERN_ERR "end_request: %s error, dev %s, sector %llu\n",
2447                                    error_type, req->rq_disk ?
2448                                    req->rq_disk->disk_name : "?",
2449                                    (unsigned long long)blk_rq_pos(req));
2450
2451         }
2452
2453         blk_account_io_completion(req, nr_bytes);
2454
2455         total_bytes = 0;
2456         while (req->bio) {
2457                 struct bio *bio = req->bio;
2458                 unsigned bio_bytes = min(bio->bi_iter.bi_size, nr_bytes);
2459
2460                 if (bio_bytes == bio->bi_iter.bi_size)
2461                         req->bio = bio->bi_next;
2462
2463                 req_bio_endio(req, bio, bio_bytes, error);
2464
2465                 total_bytes += bio_bytes;
2466                 nr_bytes -= bio_bytes;
2467
2468                 if (!nr_bytes)
2469                         break;
2470         }
2471
2472         /*
2473          * completely done
2474          */
2475         if (!req->bio) {
2476                 /*
2477                  * Reset counters so that the request stacking driver
2478                  * can find how many bytes remain in the request
2479                  * later.
2480                  */
2481                 req->__data_len = 0;
2482                 return false;
2483         }
2484
2485         req->__data_len -= total_bytes;
2486
2487         /* update sector only for requests with clear definition of sector */
2488         if (req->cmd_type == REQ_TYPE_FS)
2489                 req->__sector += total_bytes >> 9;
2490
2491         /* mixed attributes always follow the first bio */
2492         if (req->cmd_flags & REQ_MIXED_MERGE) {
2493                 req->cmd_flags &= ~REQ_FAILFAST_MASK;
2494                 req->cmd_flags |= req->bio->bi_rw & REQ_FAILFAST_MASK;
2495         }
2496
2497         /*
2498          * If total number of sectors is less than the first segment
2499          * size, something has gone terribly wrong.
2500          */
2501         if (blk_rq_bytes(req) < blk_rq_cur_bytes(req)) {
2502                 blk_dump_rq_flags(req, "request botched");
2503                 req->__data_len = blk_rq_cur_bytes(req);
2504         }
2505
2506         /* recalculate the number of segments */
2507         blk_recalc_rq_segments(req);
2508
2509         return true;
2510 }
2511 EXPORT_SYMBOL_GPL(blk_update_request);
2512
2513 static bool blk_update_bidi_request(struct request *rq, int error,
2514                                     unsigned int nr_bytes,
2515                                     unsigned int bidi_bytes)
2516 {
2517         if (blk_update_request(rq, error, nr_bytes))
2518                 return true;
2519
2520         /* Bidi request must be completed as a whole */
2521         if (unlikely(blk_bidi_rq(rq)) &&
2522             blk_update_request(rq->next_rq, error, bidi_bytes))
2523                 return true;
2524
2525         if (blk_queue_add_random(rq->q))
2526                 add_disk_randomness(rq->rq_disk);
2527
2528         return false;
2529 }
2530
2531 /**
2532  * blk_unprep_request - unprepare a request
2533  * @req:        the request
2534  *
2535  * This function makes a request ready for complete resubmission (or
2536  * completion).  It happens only after all error handling is complete,
2537  * so represents the appropriate moment to deallocate any resources
2538  * that were allocated to the request in the prep_rq_fn.  The queue
2539  * lock is held when calling this.
2540  */
2541 void blk_unprep_request(struct request *req)
2542 {
2543         struct request_queue *q = req->q;
2544
2545         req->cmd_flags &= ~REQ_DONTPREP;
2546         if (q->unprep_rq_fn)
2547                 q->unprep_rq_fn(q, req);
2548 }
2549 EXPORT_SYMBOL_GPL(blk_unprep_request);
2550
2551 /*
2552  * queue lock must be held
2553  */
2554 void blk_finish_request(struct request *req, int error)
2555 {
2556         if (blk_rq_tagged(req))
2557                 blk_queue_end_tag(req->q, req);
2558
2559         BUG_ON(blk_queued_rq(req));
2560
2561         if (unlikely(laptop_mode) && req->cmd_type == REQ_TYPE_FS)
2562                 laptop_io_completion(&req->q->backing_dev_info);
2563
2564         blk_delete_timer(req);
2565
2566         if (req->cmd_flags & REQ_DONTPREP)
2567                 blk_unprep_request(req);
2568
2569         blk_account_io_done(req);
2570
2571         if (req->end_io)
2572                 req->end_io(req, error);
2573         else {
2574                 if (blk_bidi_rq(req))
2575                         __blk_put_request(req->next_rq->q, req->next_rq);
2576
2577                 __blk_put_request(req->q, req);
2578         }
2579 }
2580 EXPORT_SYMBOL(blk_finish_request);
2581
2582 /**
2583  * blk_end_bidi_request - Complete a bidi request
2584  * @rq:         the request to complete
2585  * @error:      %0 for success, < %0 for error
2586  * @nr_bytes:   number of bytes to complete @rq
2587  * @bidi_bytes: number of bytes to complete @rq->next_rq
2588  *
2589  * Description:
2590  *     Ends I/O on a number of bytes attached to @rq and @rq->next_rq.
2591  *     Drivers that supports bidi can safely call this member for any
2592  *     type of request, bidi or uni.  In the later case @bidi_bytes is
2593  *     just ignored.
2594  *
2595  * Return:
2596  *     %false - we are done with this request
2597  *     %true  - still buffers pending for this request
2598  **/
2599 static bool blk_end_bidi_request(struct request *rq, int error,
2600                                  unsigned int nr_bytes, unsigned int bidi_bytes)
2601 {
2602         struct request_queue *q = rq->q;
2603         unsigned long flags;
2604
2605         if (blk_update_bidi_request(rq, error, nr_bytes, bidi_bytes))
2606                 return true;
2607
2608         spin_lock_irqsave(q->queue_lock, flags);
2609         blk_finish_request(rq, error);
2610         spin_unlock_irqrestore(q->queue_lock, flags);
2611
2612         return false;
2613 }
2614
2615 /**
2616  * __blk_end_bidi_request - Complete a bidi request with queue lock held
2617  * @rq:         the request to complete
2618  * @error:      %0 for success, < %0 for error
2619  * @nr_bytes:   number of bytes to complete @rq
2620  * @bidi_bytes: number of bytes to complete @rq->next_rq
2621  *
2622  * Description:
2623  *     Identical to blk_end_bidi_request() except that queue lock is
2624  *     assumed to be locked on entry and remains so on return.
2625  *
2626  * Return:
2627  *     %false - we are done with this request
2628  *     %true  - still buffers pending for this request
2629  **/
2630 bool __blk_end_bidi_request(struct request *rq, int error,
2631                                    unsigned int nr_bytes, unsigned int bidi_bytes)
2632 {
2633         if (blk_update_bidi_request(rq, error, nr_bytes, bidi_bytes))
2634                 return true;
2635
2636         blk_finish_request(rq, error);
2637
2638         return false;
2639 }
2640
2641 /**
2642  * blk_end_request - Helper function for drivers to complete the request.
2643  * @rq:       the request being processed
2644  * @error:    %0 for success, < %0 for error
2645  * @nr_bytes: number of bytes to complete
2646  *
2647  * Description:
2648  *     Ends I/O on a number of bytes attached to @rq.
2649  *     If @rq has leftover, sets it up for the next range of segments.
2650  *
2651  * Return:
2652  *     %false - we are done with this request
2653  *     %true  - still buffers pending for this request
2654  **/
2655 bool blk_end_request(struct request *rq, int error, unsigned int nr_bytes)
2656 {
2657         return blk_end_bidi_request(rq, error, nr_bytes, 0);
2658 }
2659 EXPORT_SYMBOL(blk_end_request);
2660
2661 /**
2662  * blk_end_request_all - Helper function for drives to finish the request.
2663  * @rq: the request to finish
2664  * @error: %0 for success, < %0 for error
2665  *
2666  * Description:
2667  *     Completely finish @rq.
2668  */
2669 void blk_end_request_all(struct request *rq, int error)
2670 {
2671         bool pending;
2672         unsigned int bidi_bytes = 0;
2673
2674         if (unlikely(blk_bidi_rq(rq)))
2675                 bidi_bytes = blk_rq_bytes(rq->next_rq);
2676
2677         pending = blk_end_bidi_request(rq, error, blk_rq_bytes(rq), bidi_bytes);
2678         BUG_ON(pending);
2679 }
2680 EXPORT_SYMBOL(blk_end_request_all);
2681
2682 /**
2683  * blk_end_request_cur - Helper function to finish the current request chunk.
2684  * @rq: the request to finish the current chunk for
2685  * @error: %0 for success, < %0 for error
2686  *
2687  * Description:
2688  *     Complete the current consecutively mapped chunk from @rq.
2689  *
2690  * Return:
2691  *     %false - we are done with this request
2692  *     %true  - still buffers pending for this request
2693  */
2694 bool blk_end_request_cur(struct request *rq, int error)
2695 {
2696         return blk_end_request(rq, error, blk_rq_cur_bytes(rq));
2697 }
2698 EXPORT_SYMBOL(blk_end_request_cur);
2699
2700 /**
2701  * blk_end_request_err - Finish a request till the next failure boundary.
2702  * @rq: the request to finish till the next failure boundary for
2703  * @error: must be negative errno
2704  *
2705  * Description:
2706  *     Complete @rq till the next failure boundary.
2707  *
2708  * Return:
2709  *     %false - we are done with this request
2710  *     %true  - still buffers pending for this request
2711  */
2712 bool blk_end_request_err(struct request *rq, int error)
2713 {
2714         WARN_ON(error >= 0);
2715         return blk_end_request(rq, error, blk_rq_err_bytes(rq));
2716 }
2717 EXPORT_SYMBOL_GPL(blk_end_request_err);
2718
2719 /**
2720  * __blk_end_request - Helper function for drivers to complete the request.
2721  * @rq:       the request being processed
2722  * @error:    %0 for success, < %0 for error
2723  * @nr_bytes: number of bytes to complete
2724  *
2725  * Description:
2726  *     Must be called with queue lock held unlike blk_end_request().
2727  *
2728  * Return:
2729  *     %false - we are done with this request
2730  *     %true  - still buffers pending for this request
2731  **/
2732 bool __blk_end_request(struct request *rq, int error, unsigned int nr_bytes)
2733 {
2734         return __blk_end_bidi_request(rq, error, nr_bytes, 0);
2735 }
2736 EXPORT_SYMBOL(__blk_end_request);
2737
2738 /**
2739  * __blk_end_request_all - Helper function for drives to finish the request.
2740  * @rq: the request to finish
2741  * @error: %0 for success, < %0 for error
2742  *
2743  * Description:
2744  *     Completely finish @rq.  Must be called with queue lock held.
2745  */
2746 void __blk_end_request_all(struct request *rq, int error)
2747 {
2748         bool pending;
2749         unsigned int bidi_bytes = 0;
2750
2751         if (unlikely(blk_bidi_rq(rq)))
2752                 bidi_bytes = blk_rq_bytes(rq->next_rq);
2753
2754         pending = __blk_end_bidi_request(rq, error, blk_rq_bytes(rq), bidi_bytes);
2755         BUG_ON(pending);
2756 }
2757 EXPORT_SYMBOL(__blk_end_request_all);
2758
2759 /**
2760  * __blk_end_request_cur - Helper function to finish the current request chunk.
2761  * @rq: the request to finish the current chunk for
2762  * @error: %0 for success, < %0 for error
2763  *
2764  * Description:
2765  *     Complete the current consecutively mapped chunk from @rq.  Must
2766  *     be called with queue lock held.
2767  *
2768  * Return:
2769  *     %false - we are done with this request
2770  *     %true  - still buffers pending for this request
2771  */
2772 bool __blk_end_request_cur(struct request *rq, int error)
2773 {
2774         return __blk_end_request(rq, error, blk_rq_cur_bytes(rq));
2775 }
2776 EXPORT_SYMBOL(__blk_end_request_cur);
2777
2778 /**
2779  * __blk_end_request_err - Finish a request till the next failure boundary.
2780  * @rq: the request to finish till the next failure boundary for
2781  * @error: must be negative errno
2782  *
2783  * Description:
2784  *     Complete @rq till the next failure boundary.  Must be called
2785  *     with queue lock held.
2786  *
2787  * Return:
2788  *     %false - we are done with this request
2789  *     %true  - still buffers pending for this request
2790  */
2791 bool __blk_end_request_err(struct request *rq, int error)
2792 {
2793         WARN_ON(error >= 0);
2794         return __blk_end_request(rq, error, blk_rq_err_bytes(rq));
2795 }
2796 EXPORT_SYMBOL_GPL(__blk_end_request_err);
2797
2798 void blk_rq_bio_prep(struct request_queue *q, struct request *rq,
2799                      struct bio *bio)
2800 {
2801         /* Bit 0 (R/W) is identical in rq->cmd_flags and bio->bi_rw */
2802         rq->cmd_flags |= bio->bi_rw & REQ_WRITE;
2803
2804         if (bio_has_data(bio))
2805                 rq->nr_phys_segments = bio_phys_segments(q, bio);
2806
2807         rq->__data_len = bio->bi_iter.bi_size;
2808         rq->bio = rq->biotail = bio;
2809
2810         if (bio->bi_bdev)
2811                 rq->rq_disk = bio->bi_bdev->bd_disk;
2812 }
2813
2814 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
2815 /**
2816  * rq_flush_dcache_pages - Helper function to flush all pages in a request
2817  * @rq: the request to be flushed
2818  *
2819  * Description:
2820  *     Flush all pages in @rq.
2821  */
2822 void rq_flush_dcache_pages(struct request *rq)
2823 {
2824         struct req_iterator iter;
2825         struct bio_vec bvec;
2826
2827         rq_for_each_segment(bvec, rq, iter)
2828                 flush_dcache_page(bvec.bv_page);
2829 }
2830 EXPORT_SYMBOL_GPL(rq_flush_dcache_pages);
2831 #endif
2832
2833 /**
2834  * blk_lld_busy - Check if underlying low-level drivers of a device are busy
2835  * @q : the queue of the device being checked
2836  *
2837  * Description:
2838  *    Check if underlying low-level drivers of a device are busy.
2839  *    If the drivers want to export their busy state, they must set own
2840  *    exporting function using blk_queue_lld_busy() first.
2841  *
2842  *    Basically, this function is used only by request stacking drivers
2843  *    to stop dispatching requests to underlying devices when underlying
2844  *    devices are busy.  This behavior helps more I/O merging on the queue
2845  *    of the request stacking driver and prevents I/O throughput regression
2846  *    on burst I/O load.
2847  *
2848  * Return:
2849  *    0 - Not busy (The request stacking driver should dispatch request)
2850  *    1 - Busy (The request stacking driver should stop dispatching request)
2851  */
2852 int blk_lld_busy(struct request_queue *q)
2853 {
2854         if (q->lld_busy_fn)
2855                 return q->lld_busy_fn(q);
2856
2857         return 0;
2858 }
2859 EXPORT_SYMBOL_GPL(blk_lld_busy);
2860
2861 /**
2862  * blk_rq_unprep_clone - Helper function to free all bios in a cloned request
2863  * @rq: the clone request to be cleaned up
2864  *
2865  * Description:
2866  *     Free all bios in @rq for a cloned request.
2867  */
2868 void blk_rq_unprep_clone(struct request *rq)
2869 {
2870         struct bio *bio;
2871
2872         while ((bio = rq->bio) != NULL) {
2873                 rq->bio = bio->bi_next;
2874
2875                 bio_put(bio);
2876         }
2877 }
2878 EXPORT_SYMBOL_GPL(blk_rq_unprep_clone);
2879
2880 /*
2881  * Copy attributes of the original request to the clone request.
2882  * The actual data parts (e.g. ->cmd, ->sense) are not copied.
2883  */
2884 static void __blk_rq_prep_clone(struct request *dst, struct request *src)
2885 {
2886         dst->cpu = src->cpu;
2887         dst->cmd_flags = (src->cmd_flags & REQ_CLONE_MASK) | REQ_NOMERGE;
2888         dst->cmd_type = src->cmd_type;
2889         dst->__sector = blk_rq_pos(src);
2890         dst->__data_len = blk_rq_bytes(src);
2891         dst->nr_phys_segments = src->nr_phys_segments;
2892         dst->ioprio = src->ioprio;
2893         dst->extra_len = src->extra_len;
2894 }
2895
2896 /**
2897  * blk_rq_prep_clone - Helper function to setup clone request
2898  * @rq: the request to be setup
2899  * @rq_src: original request to be cloned
2900  * @bs: bio_set that bios for clone are allocated from
2901  * @gfp_mask: memory allocation mask for bio
2902  * @bio_ctr: setup function to be called for each clone bio.
2903  *           Returns %0 for success, non %0 for failure.
2904  * @data: private data to be passed to @bio_ctr
2905  *
2906  * Description:
2907  *     Clones bios in @rq_src to @rq, and copies attributes of @rq_src to @rq.
2908  *     The actual data parts of @rq_src (e.g. ->cmd, ->sense)
2909  *     are not copied, and copying such parts is the caller's responsibility.
2910  *     Also, pages which the original bios are pointing to are not copied
2911  *     and the cloned bios just point same pages.
2912  *     So cloned bios must be completed before original bios, which means
2913  *     the caller must complete @rq before @rq_src.
2914  */
2915 int blk_rq_prep_clone(struct request *rq, struct request *rq_src,
2916                       struct bio_set *bs, gfp_t gfp_mask,
2917                       int (*bio_ctr)(struct bio *, struct bio *, void *),
2918                       void *data)
2919 {
2920         struct bio *bio, *bio_src;
2921
2922         if (!bs)
2923                 bs = fs_bio_set;
2924
2925         blk_rq_init(NULL, rq);
2926
2927         __rq_for_each_bio(bio_src, rq_src) {
2928                 bio = bio_clone_bioset(bio_src, gfp_mask, bs);
2929                 if (!bio)
2930                         goto free_and_out;
2931
2932                 if (bio_ctr && bio_ctr(bio, bio_src, data))
2933                         goto free_and_out;
2934
2935                 if (rq->bio) {
2936                         rq->biotail->bi_next = bio;
2937                         rq->biotail = bio;
2938                 } else
2939                         rq->bio = rq->biotail = bio;
2940         }
2941
2942         __blk_rq_prep_clone(rq, rq_src);
2943
2944         return 0;
2945
2946 free_and_out:
2947         if (bio)
2948                 bio_put(bio);
2949         blk_rq_unprep_clone(rq);
2950
2951         return -ENOMEM;
2952 }
2953 EXPORT_SYMBOL_GPL(blk_rq_prep_clone);
2954
2955 int kblockd_schedule_work(struct work_struct *work)
2956 {
2957         return queue_work(kblockd_workqueue, work);
2958 }
2959 EXPORT_SYMBOL(kblockd_schedule_work);
2960
2961 int kblockd_schedule_delayed_work(struct delayed_work *dwork,
2962                                   unsigned long delay)
2963 {
2964         return queue_delayed_work(kblockd_workqueue, dwork, delay);
2965 }
2966 EXPORT_SYMBOL(kblockd_schedule_delayed_work);
2967
2968 int kblockd_schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
2969                                      unsigned long delay)
2970 {
2971         return queue_delayed_work_on(cpu, kblockd_workqueue, dwork, delay);
2972 }
2973 EXPORT_SYMBOL(kblockd_schedule_delayed_work_on);
2974
2975 /**
2976  * blk_start_plug - initialize blk_plug and track it inside the task_struct
2977  * @plug:       The &struct blk_plug that needs to be initialized
2978  *
2979  * Description:
2980  *   Tracking blk_plug inside the task_struct will help with auto-flushing the
2981  *   pending I/O should the task end up blocking between blk_start_plug() and
2982  *   blk_finish_plug(). This is important from a performance perspective, but
2983  *   also ensures that we don't deadlock. For instance, if the task is blocking
2984  *   for a memory allocation, memory reclaim could end up wanting to free a
2985  *   page belonging to that request that is currently residing in our private
2986  *   plug. By flushing the pending I/O when the process goes to sleep, we avoid
2987  *   this kind of deadlock.
2988  */
2989 void blk_start_plug(struct blk_plug *plug)
2990 {
2991         struct task_struct *tsk = current;
2992
2993         INIT_LIST_HEAD(&plug->list);
2994         INIT_LIST_HEAD(&plug->mq_list);
2995         INIT_LIST_HEAD(&plug->cb_list);
2996
2997         /*
2998          * If this is a nested plug, don't actually assign it. It will be
2999          * flushed on its own.
3000          */
3001         if (!tsk->plug) {
3002                 /*
3003                  * Store ordering should not be needed here, since a potential
3004                  * preempt will imply a full memory barrier
3005                  */
3006                 tsk->plug = plug;
3007         }
3008 }
3009 EXPORT_SYMBOL(blk_start_plug);
3010
3011 static int plug_rq_cmp(void *priv, struct list_head *a, struct list_head *b)
3012 {
3013         struct request *rqa = container_of(a, struct request, queuelist);
3014         struct request *rqb = container_of(b, struct request, queuelist);
3015
3016         return !(rqa->q < rqb->q ||
3017                 (rqa->q == rqb->q && blk_rq_pos(rqa) < blk_rq_pos(rqb)));
3018 }
3019
3020 /*
3021  * If 'from_schedule' is true, then postpone the dispatch of requests
3022  * until a safe kblockd context. We due this to avoid accidental big
3023  * additional stack usage in driver dispatch, in places where the originally
3024  * plugger did not intend it.
3025  */
3026 static void queue_unplugged(struct request_queue *q, unsigned int depth,
3027                             bool from_schedule)
3028         __releases(q->queue_lock)
3029 {
3030         trace_block_unplug(q, depth, !from_schedule);
3031
3032         if (from_schedule)
3033                 blk_run_queue_async(q);
3034         else
3035                 __blk_run_queue(q);
3036         spin_unlock(q->queue_lock);
3037 }
3038
3039 static void flush_plug_callbacks(struct blk_plug *plug, bool from_schedule)
3040 {
3041         LIST_HEAD(callbacks);
3042
3043         while (!list_empty(&plug->cb_list)) {
3044                 list_splice_init(&plug->cb_list, &callbacks);
3045
3046                 while (!list_empty(&callbacks)) {
3047                         struct blk_plug_cb *cb = list_first_entry(&callbacks,
3048                                                           struct blk_plug_cb,
3049                                                           list);
3050                         list_del(&cb->list);
3051                         cb->callback(cb, from_schedule);
3052                 }
3053         }
3054 }
3055
3056 struct blk_plug_cb *blk_check_plugged(blk_plug_cb_fn unplug, void *data,
3057                                       int size)
3058 {
3059         struct blk_plug *plug = current->plug;
3060         struct blk_plug_cb *cb;
3061
3062         if (!plug)
3063                 return NULL;
3064
3065         list_for_each_entry(cb, &plug->cb_list, list)
3066                 if (cb->callback == unplug && cb->data == data)
3067                         return cb;
3068
3069         /* Not currently on the callback list */
3070         BUG_ON(size < sizeof(*cb));
3071         cb = kzalloc(size, GFP_ATOMIC);
3072         if (cb) {
3073                 cb->data = data;
3074                 cb->callback = unplug;
3075                 list_add(&cb->list, &plug->cb_list);
3076         }
3077         return cb;
3078 }
3079 EXPORT_SYMBOL(blk_check_plugged);
3080
3081 void blk_flush_plug_list(struct blk_plug *plug, bool from_schedule)
3082 {
3083         struct request_queue *q;
3084         unsigned long flags;
3085         struct request *rq;
3086         LIST_HEAD(list);
3087         unsigned int depth;
3088
3089         flush_plug_callbacks(plug, from_schedule);
3090
3091         if (!list_empty(&plug->mq_list))
3092                 blk_mq_flush_plug_list(plug, from_schedule);
3093
3094         if (list_empty(&plug->list))
3095                 return;
3096
3097         list_splice_init(&plug->list, &list);
3098
3099         list_sort(NULL, &list, plug_rq_cmp);
3100
3101         q = NULL;
3102         depth = 0;
3103
3104         /*
3105          * Save and disable interrupts here, to avoid doing it for every
3106          * queue lock we have to take.
3107          */
3108         local_irq_save(flags);
3109         while (!list_empty(&list)) {
3110                 rq = list_entry_rq(list.next);
3111                 list_del_init(&rq->queuelist);
3112                 BUG_ON(!rq->q);
3113                 if (rq->q != q) {
3114                         /*
3115                          * This drops the queue lock
3116                          */
3117                         if (q)
3118                                 queue_unplugged(q, depth, from_schedule);
3119                         q = rq->q;
3120                         depth = 0;
3121                         spin_lock(q->queue_lock);
3122                 }
3123
3124                 /*
3125                  * Short-circuit if @q is dead
3126                  */
3127                 if (unlikely(blk_queue_dying(q))) {
3128                         __blk_end_request_all(rq, -ENODEV);
3129                         continue;
3130                 }
3131
3132                 /*
3133                  * rq is already accounted, so use raw insert
3134                  */
3135                 if (rq->cmd_flags & (REQ_FLUSH | REQ_FUA))
3136                         __elv_add_request(q, rq, ELEVATOR_INSERT_FLUSH);
3137                 else
3138                         __elv_add_request(q, rq, ELEVATOR_INSERT_SORT_MERGE);
3139
3140                 depth++;
3141         }
3142
3143         /*
3144          * This drops the queue lock
3145          */
3146         if (q)
3147                 queue_unplugged(q, depth, from_schedule);
3148
3149         local_irq_restore(flags);
3150 }
3151
3152 void blk_finish_plug(struct blk_plug *plug)
3153 {
3154         blk_flush_plug_list(plug, false);
3155
3156         if (plug == current->plug)
3157                 current->plug = NULL;
3158 }
3159 EXPORT_SYMBOL(blk_finish_plug);
3160
3161 #ifdef CONFIG_PM_RUNTIME
3162 /**
3163  * blk_pm_runtime_init - Block layer runtime PM initialization routine
3164  * @q: the queue of the device
3165  * @dev: the device the queue belongs to
3166  *
3167  * Description:
3168  *    Initialize runtime-PM-related fields for @q and start auto suspend for
3169  *    @dev. Drivers that want to take advantage of request-based runtime PM
3170  *    should call this function after @dev has been initialized, and its
3171  *    request queue @q has been allocated, and runtime PM for it can not happen
3172  *    yet(either due to disabled/forbidden or its usage_count > 0). In most
3173  *    cases, driver should call this function before any I/O has taken place.
3174  *
3175  *    This function takes care of setting up using auto suspend for the device,
3176  *    the autosuspend delay is set to -1 to make runtime suspend impossible
3177  *    until an updated value is either set by user or by driver. Drivers do
3178  *    not need to touch other autosuspend settings.
3179  *
3180  *    The block layer runtime PM is request based, so only works for drivers
3181  *    that use request as their IO unit instead of those directly use bio's.
3182  */
3183 void blk_pm_runtime_init(struct request_queue *q, struct device *dev)
3184 {
3185         q->dev = dev;
3186         q->rpm_status = RPM_ACTIVE;
3187         pm_runtime_set_autosuspend_delay(q->dev, -1);
3188         pm_runtime_use_autosuspend(q->dev);
3189 }
3190 EXPORT_SYMBOL(blk_pm_runtime_init);
3191
3192 /**
3193  * blk_pre_runtime_suspend - Pre runtime suspend check
3194  * @q: the queue of the device
3195  *
3196  * Description:
3197  *    This function will check if runtime suspend is allowed for the device
3198  *    by examining if there are any requests pending in the queue. If there
3199  *    are requests pending, the device can not be runtime suspended; otherwise,
3200  *    the queue's status will be updated to SUSPENDING and the driver can
3201  *    proceed to suspend the device.
3202  *
3203  *    For the not allowed case, we mark last busy for the device so that
3204  *    runtime PM core will try to autosuspend it some time later.
3205  *
3206  *    This function should be called near the start of the device's
3207  *    runtime_suspend callback.
3208  *
3209  * Return:
3210  *    0         - OK to runtime suspend the device
3211  *    -EBUSY    - Device should not be runtime suspended
3212  */
3213 int blk_pre_runtime_suspend(struct request_queue *q)
3214 {
3215         int ret = 0;
3216
3217         spin_lock_irq(q->queue_lock);
3218         if (q->nr_pending) {
3219                 ret = -EBUSY;
3220                 pm_runtime_mark_last_busy(q->dev);
3221         } else {
3222                 q->rpm_status = RPM_SUSPENDING;
3223         }
3224         spin_unlock_irq(q->queue_lock);
3225         return ret;
3226 }
3227 EXPORT_SYMBOL(blk_pre_runtime_suspend);
3228
3229 /**
3230  * blk_post_runtime_suspend - Post runtime suspend processing
3231  * @q: the queue of the device
3232  * @err: return value of the device's runtime_suspend function
3233  *
3234  * Description:
3235  *    Update the queue's runtime status according to the return value of the
3236  *    device's runtime suspend function and mark last busy for the device so
3237  *    that PM core will try to auto suspend the device at a later time.
3238  *
3239  *    This function should be called near the end of the device's
3240  *    runtime_suspend callback.
3241  */
3242 void blk_post_runtime_suspend(struct request_queue *q, int err)
3243 {
3244         spin_lock_irq(q->queue_lock);
3245         if (!err) {
3246                 q->rpm_status = RPM_SUSPENDED;
3247         } else {
3248                 q->rpm_status = RPM_ACTIVE;
3249                 pm_runtime_mark_last_busy(q->dev);
3250         }
3251         spin_unlock_irq(q->queue_lock);
3252 }
3253 EXPORT_SYMBOL(blk_post_runtime_suspend);
3254
3255 /**
3256  * blk_pre_runtime_resume - Pre runtime resume processing
3257  * @q: the queue of the device
3258  *
3259  * Description:
3260  *    Update the queue's runtime status to RESUMING in preparation for the
3261  *    runtime resume of the device.
3262  *
3263  *    This function should be called near the start of the device's
3264  *    runtime_resume callback.
3265  */
3266 void blk_pre_runtime_resume(struct request_queue *q)
3267 {
3268         spin_lock_irq(q->queue_lock);
3269         q->rpm_status = RPM_RESUMING;
3270         spin_unlock_irq(q->queue_lock);
3271 }
3272 EXPORT_SYMBOL(blk_pre_runtime_resume);
3273
3274 /**
3275  * blk_post_runtime_resume - Post runtime resume processing
3276  * @q: the queue of the device
3277  * @err: return value of the device's runtime_resume function
3278  *
3279  * Description:
3280  *    Update the queue's runtime status according to the return value of the
3281  *    device's runtime_resume function. If it is successfully resumed, process
3282  *    the requests that are queued into the device's queue when it is resuming
3283  *    and then mark last busy and initiate autosuspend for it.
3284  *
3285  *    This function should be called near the end of the device's
3286  *    runtime_resume callback.
3287  */
3288 void blk_post_runtime_resume(struct request_queue *q, int err)
3289 {
3290         spin_lock_irq(q->queue_lock);
3291         if (!err) {
3292                 q->rpm_status = RPM_ACTIVE;
3293                 __blk_run_queue(q);
3294                 pm_runtime_mark_last_busy(q->dev);
3295                 pm_request_autosuspend(q->dev);
3296         } else {
3297                 q->rpm_status = RPM_SUSPENDED;
3298         }
3299         spin_unlock_irq(q->queue_lock);
3300 }
3301 EXPORT_SYMBOL(blk_post_runtime_resume);
3302 #endif
3303
3304 int __init blk_dev_init(void)
3305 {
3306         BUILD_BUG_ON(__REQ_NR_BITS > 8 *
3307                         sizeof(((struct request *)0)->cmd_flags));
3308
3309         /* used for unplugging and affects IO latency/throughput - HIGHPRI */
3310         kblockd_workqueue = alloc_workqueue("kblockd",
3311                                             WQ_MEM_RECLAIM | WQ_HIGHPRI, 0);
3312         if (!kblockd_workqueue)
3313                 panic("Failed to create kblockd\n");
3314
3315         request_cachep = kmem_cache_create("blkdev_requests",
3316                         sizeof(struct request), 0, SLAB_PANIC, NULL);
3317
3318         blk_requestq_cachep = kmem_cache_create("blkdev_queue",
3319                         sizeof(struct request_queue), 0, SLAB_PANIC, NULL);
3320
3321         return 0;
3322 }