OSDN Git Service

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