blob: 74444c49078fc7911289f9d8a65939399d8cb126 [file] [log] [blame]
Jens Axboe8324aa92008-01-29 14:51:59 +01001#ifndef BLK_INTERNAL_H
2#define BLK_INTERNAL_H
3
Tejun Heoa73f7302011-12-14 00:33:37 +01004#include <linux/idr.h>
Ming Leif70ced02014-09-25 23:23:47 +08005#include <linux/blk-mq.h>
6#include "blk-mq.h"
Tejun Heoa73f7302011-12-14 00:33:37 +01007
Jens Axboe86db1e22008-01-29 14:53:40 +01008/* Amount of time in which a process may batch requests */
9#define BLK_BATCH_TIME (HZ/50UL)
10
11/* Number of requests a "batching" process may submit */
12#define BLK_BATCH_REQ 32
13
Jens Axboe0d2602c2014-05-13 15:10:52 -060014/* Max future timer expiry for timeouts */
15#define BLK_MAX_TIMEOUT (5 * HZ)
16
Ming Lei7c94e1c2014-09-25 23:23:43 +080017struct blk_flush_queue {
18 unsigned int flush_queue_delayed:1;
19 unsigned int flush_pending_idx:1;
20 unsigned int flush_running_idx:1;
21 unsigned long flush_pending_since;
22 struct list_head flush_queue[2];
23 struct list_head flush_data_in_flight;
24 struct request *flush_rq;
Ming Lei0048b482015-08-09 03:41:51 -040025
26 /*
27 * flush_rq shares tag with this rq, both can't be active
28 * at the same time
29 */
30 struct request *orig_rq;
Ming Lei7c94e1c2014-09-25 23:23:43 +080031 spinlock_t mq_flush_lock;
32};
33
Jens Axboe8324aa92008-01-29 14:51:59 +010034extern struct kmem_cache *blk_requestq_cachep;
Jens Axboe320ae512013-10-24 09:20:05 +010035extern struct kmem_cache *request_cachep;
Jens Axboe8324aa92008-01-29 14:51:59 +010036extern struct kobj_type blk_queue_ktype;
Tejun Heoa73f7302011-12-14 00:33:37 +010037extern struct ida blk_queue_ida;
Jens Axboe8324aa92008-01-29 14:51:59 +010038
Ming Lei7c94e1c2014-09-25 23:23:43 +080039static inline struct blk_flush_queue *blk_get_flush_queue(
Ming Leie97c2932014-09-25 23:23:46 +080040 struct request_queue *q, struct blk_mq_ctx *ctx)
Ming Lei7c94e1c2014-09-25 23:23:43 +080041{
Christoph Hellwig7d7e0f92016-09-14 16:18:54 +020042 if (q->mq_ops)
43 return blk_mq_map_queue(q, ctx->cpu)->fq;
44 return q->fq;
Ming Lei7c94e1c2014-09-25 23:23:43 +080045}
46
Tejun Heo09ac46c2011-12-14 00:33:38 +010047static inline void __blk_get_queue(struct request_queue *q)
48{
49 kobject_get(&q->kobj);
50}
51
Ming Leif70ced02014-09-25 23:23:47 +080052struct blk_flush_queue *blk_alloc_flush_queue(struct request_queue *q,
53 int node, int cmd_size);
54void blk_free_flush_queue(struct blk_flush_queue *q);
Ming Leif3552652014-09-25 23:23:40 +080055
Tejun Heo5b788ce2012-06-04 20:40:59 -070056int blk_init_rl(struct request_list *rl, struct request_queue *q,
57 gfp_t gfp_mask);
58void blk_exit_rl(struct request_list *rl);
Jens Axboe86db1e22008-01-29 14:53:40 +010059void init_request_from_bio(struct request *req, struct bio *bio);
60void blk_rq_bio_prep(struct request_queue *q, struct request *rq,
61 struct bio *bio);
Tejun Heod7325802012-03-05 13:14:58 -080062void blk_queue_bypass_start(struct request_queue *q);
63void blk_queue_bypass_end(struct request_queue *q);
Tejun Heo9934c8c2009-05-08 11:54:16 +090064void blk_dequeue_request(struct request *rq);
Jens Axboe8324aa92008-01-29 14:51:59 +010065void __blk_queue_free_tags(struct request_queue *q);
Jeff Moyer4853aba2011-08-15 21:37:25 +020066bool __blk_end_bidi_request(struct request *rq, int error,
67 unsigned int nr_bytes, unsigned int bidi_bytes);
Dan Williams3ef28e82015-10-21 13:20:12 -040068void blk_freeze_queue(struct request_queue *q);
69
70static inline void blk_queue_enter_live(struct request_queue *q)
71{
72 /*
73 * Given that running in generic_make_request() context
74 * guarantees that a live reference against q_usage_counter has
75 * been established, further references under that same context
76 * need not check that the queue has been frozen (marked dead).
77 */
78 percpu_ref_get(&q->q_usage_counter);
79}
Jens Axboe8324aa92008-01-29 14:51:59 +010080
Dan Williams5a48fc12015-10-21 13:20:23 -040081#ifdef CONFIG_BLK_DEV_INTEGRITY
82void blk_flush_integrity(void);
83#else
84static inline void blk_flush_integrity(void)
85{
86}
87#endif
Jens Axboe8324aa92008-01-29 14:51:59 +010088
Christoph Hellwig287922eb2015-10-30 20:57:30 +080089void blk_timeout_work(struct work_struct *work);
Jens Axboe0d2602c2014-05-13 15:10:52 -060090unsigned long blk_rq_timeout(unsigned long timeout);
Jens Axboe87ee7b12014-04-24 08:51:47 -060091void blk_add_timer(struct request *req);
Jens Axboe242f9dc2008-09-14 05:55:09 -070092void blk_delete_timer(struct request *);
Jens Axboe242f9dc2008-09-14 05:55:09 -070093
Jens Axboe320ae512013-10-24 09:20:05 +010094
95bool bio_attempt_front_merge(struct request_queue *q, struct request *req,
96 struct bio *bio);
97bool bio_attempt_back_merge(struct request_queue *q, struct request *req,
98 struct bio *bio);
99bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
Shaohua Li5b3f3412015-05-08 10:51:33 -0700100 unsigned int *request_count,
101 struct request **same_queue_rq);
Jeff Moyer0809e3a2015-10-20 23:13:51 +0800102unsigned int blk_plug_queued_count(struct request_queue *q);
Jens Axboe320ae512013-10-24 09:20:05 +0100103
104void blk_account_io_start(struct request *req, bool new_io);
105void blk_account_io_completion(struct request *req, unsigned int bytes);
106void blk_account_io_done(struct request *req);
107
Jens Axboe242f9dc2008-09-14 05:55:09 -0700108/*
109 * Internal atomic flags for request handling
110 */
111enum rq_atomic_flags {
112 REQ_ATOM_COMPLETE = 0,
Jens Axboe320ae512013-10-24 09:20:05 +0100113 REQ_ATOM_STARTED,
Jens Axboe242f9dc2008-09-14 05:55:09 -0700114};
115
116/*
117 * EH timer and IO completion will both attempt to 'grab' the request, make
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300118 * sure that only one of them succeeds
Jens Axboe242f9dc2008-09-14 05:55:09 -0700119 */
120static inline int blk_mark_rq_complete(struct request *rq)
121{
122 return test_and_set_bit(REQ_ATOM_COMPLETE, &rq->atomic_flags);
123}
124
125static inline void blk_clear_rq_complete(struct request *rq)
126{
127 clear_bit(REQ_ATOM_COMPLETE, &rq->atomic_flags);
128}
Jens Axboe86db1e22008-01-29 14:53:40 +0100129
Tejun Heo158dbda2009-04-23 11:05:18 +0900130/*
131 * Internal elevator interface
132 */
Jens Axboe360f92c2014-04-09 20:27:01 -0600133#define ELV_ON_HASH(rq) ((rq)->cmd_flags & REQ_HASHED)
Tejun Heo158dbda2009-04-23 11:05:18 +0900134
Tejun Heoae1b1532011-01-25 12:43:54 +0100135void blk_insert_flush(struct request *rq);
Tejun Heodd831002010-09-03 11:56:16 +0200136
Tejun Heo158dbda2009-04-23 11:05:18 +0900137static inline struct request *__elv_next_request(struct request_queue *q)
138{
139 struct request *rq;
Ming Leie97c2932014-09-25 23:23:46 +0800140 struct blk_flush_queue *fq = blk_get_flush_queue(q, NULL);
Tejun Heo158dbda2009-04-23 11:05:18 +0900141
142 while (1) {
Tejun Heoae1b1532011-01-25 12:43:54 +0100143 if (!list_empty(&q->queue_head)) {
Tejun Heo158dbda2009-04-23 11:05:18 +0900144 rq = list_entry_rq(q->queue_head.next);
Tejun Heoae1b1532011-01-25 12:43:54 +0100145 return rq;
Tejun Heo158dbda2009-04-23 11:05:18 +0900146 }
147
shaohua.li@intel.com3ac0cc42011-05-06 11:34:41 -0600148 /*
149 * Flush request is running and flush request isn't queueable
150 * in the drive, we can hold the queue till flush request is
151 * finished. Even we don't do this, driver can't dispatch next
152 * requests and will requeue them. And this can improve
153 * throughput too. For example, we have request flush1, write1,
154 * flush 2. flush1 is dispatched, then queue is hold, write1
155 * isn't inserted to queue. After flush1 is finished, flush2
156 * will be dispatched. Since disk cache is already clean,
157 * flush2 will be finished very soon, so looks like flush2 is
158 * folded to flush1.
159 * Since the queue is hold, a flag is set to indicate the queue
160 * should be restarted later. Please see flush_end_io() for
161 * details.
162 */
Ming Lei7c94e1c2014-09-25 23:23:43 +0800163 if (fq->flush_pending_idx != fq->flush_running_idx &&
shaohua.li@intel.com3ac0cc42011-05-06 11:34:41 -0600164 !queue_flush_queueable(q)) {
Ming Lei7c94e1c2014-09-25 23:23:43 +0800165 fq->flush_queue_delayed = 1;
shaohua.li@intel.com3ac0cc42011-05-06 11:34:41 -0600166 return NULL;
167 }
Tejun Heo556ee812014-01-29 14:56:16 -0700168 if (unlikely(blk_queue_bypass(q)) ||
Tejun Heo22f746e2011-12-14 00:33:41 +0100169 !q->elevator->type->ops.elevator_dispatch_fn(q, 0))
Tejun Heo158dbda2009-04-23 11:05:18 +0900170 return NULL;
171 }
172}
173
174static inline void elv_activate_rq(struct request_queue *q, struct request *rq)
175{
176 struct elevator_queue *e = q->elevator;
177
Tejun Heo22f746e2011-12-14 00:33:41 +0100178 if (e->type->ops.elevator_activate_req_fn)
179 e->type->ops.elevator_activate_req_fn(q, rq);
Tejun Heo158dbda2009-04-23 11:05:18 +0900180}
181
182static inline void elv_deactivate_rq(struct request_queue *q, struct request *rq)
183{
184 struct elevator_queue *e = q->elevator;
185
Tejun Heo22f746e2011-12-14 00:33:41 +0100186 if (e->type->ops.elevator_deactivate_req_fn)
187 e->type->ops.elevator_deactivate_req_fn(q, rq);
Tejun Heo158dbda2009-04-23 11:05:18 +0900188}
189
Jens Axboe581d4e22008-09-14 05:56:33 -0700190#ifdef CONFIG_FAIL_IO_TIMEOUT
191int blk_should_fake_timeout(struct request_queue *);
192ssize_t part_timeout_show(struct device *, struct device_attribute *, char *);
193ssize_t part_timeout_store(struct device *, struct device_attribute *,
194 const char *, size_t);
195#else
196static inline int blk_should_fake_timeout(struct request_queue *q)
197{
198 return 0;
199}
200#endif
201
Jens Axboed6d48192008-01-29 14:04:06 +0100202int ll_back_merge_fn(struct request_queue *q, struct request *req,
203 struct bio *bio);
204int ll_front_merge_fn(struct request_queue *q, struct request *req,
205 struct bio *bio);
206int attempt_back_merge(struct request_queue *q, struct request *rq);
207int attempt_front_merge(struct request_queue *q, struct request *rq);
Jens Axboe5e84ea32011-03-21 10:14:27 +0100208int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
209 struct request *next);
Jens Axboed6d48192008-01-29 14:04:06 +0100210void blk_recalc_rq_segments(struct request *rq);
Tejun Heo80a761f2009-07-03 17:48:17 +0900211void blk_rq_set_mixed_merge(struct request *rq);
Tejun Heo050c8ea2012-02-08 09:19:38 +0100212bool blk_rq_merge_ok(struct request *rq, struct bio *bio);
213int blk_try_merge(struct request *rq, struct bio *bio);
Jens Axboed6d48192008-01-29 14:04:06 +0100214
Jens Axboe8324aa92008-01-29 14:51:59 +0100215void blk_queue_congestion_threshold(struct request_queue *q);
216
Adrian Bunkff889722008-03-04 11:23:45 +0100217int blk_dev_init(void);
218
Jens Axboef253b862010-10-24 22:06:02 +0200219
Jens Axboe8324aa92008-01-29 14:51:59 +0100220/*
221 * Return the threshold (number of used requests) at which the queue is
222 * considered to be congested. It include a little hysteresis to keep the
223 * context switch rate down.
224 */
225static inline int queue_congestion_on_threshold(struct request_queue *q)
226{
227 return q->nr_congestion_on;
228}
229
230/*
231 * The threshold at which a queue is considered to be uncongested
232 */
233static inline int queue_congestion_off_threshold(struct request_queue *q)
234{
235 return q->nr_congestion_off;
236}
237
Jens Axboee3a2b3f2014-05-20 11:49:02 -0600238extern int blk_update_nr_requests(struct request_queue *, unsigned int);
239
Jens Axboec2553b52009-04-24 08:10:11 +0200240/*
241 * Contribute to IO statistics IFF:
242 *
243 * a) it's attached to a gendisk, and
244 * b) the queue had IO stats enabled when this request was started, and
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400245 * c) it's a file system request
Jens Axboec2553b52009-04-24 08:10:11 +0200246 */
Jerome Marchand26308ea2009-03-27 10:31:51 +0100247static inline int blk_do_io_stat(struct request *rq)
Jens Axboefb8ec182009-02-02 08:42:32 +0100248{
Christoph Hellwig33659eb2010-08-07 18:17:56 +0200249 return rq->rq_disk &&
250 (rq->cmd_flags & REQ_IO_STAT) &&
Martin K. Petersene2a60da2012-09-18 12:19:25 -0400251 (rq->cmd_type == REQ_TYPE_FS);
Jens Axboefb8ec182009-02-02 08:42:32 +0100252}
253
Tejun Heof2dbd762011-12-14 00:33:40 +0100254/*
255 * Internal io_context interface
256 */
257void get_io_context(struct io_context *ioc);
Tejun Heo47fdd4c2011-12-14 00:33:42 +0100258struct io_cq *ioc_lookup_icq(struct io_context *ioc, struct request_queue *q);
Tejun Heo24acfc32012-03-05 13:15:24 -0800259struct io_cq *ioc_create_icq(struct io_context *ioc, struct request_queue *q,
260 gfp_t gfp_mask);
Tejun Heo7e5a8792011-12-14 00:33:42 +0100261void ioc_clear_queue(struct request_queue *q);
Tejun Heof2dbd762011-12-14 00:33:40 +0100262
Tejun Heo24acfc32012-03-05 13:15:24 -0800263int create_task_io_context(struct task_struct *task, gfp_t gfp_mask, int node);
Tejun Heof2dbd762011-12-14 00:33:40 +0100264
265/**
266 * create_io_context - try to create task->io_context
Tejun Heof2dbd762011-12-14 00:33:40 +0100267 * @gfp_mask: allocation mask
268 * @node: allocation node
269 *
Tejun Heo24acfc32012-03-05 13:15:24 -0800270 * If %current->io_context is %NULL, allocate a new io_context and install
271 * it. Returns the current %current->io_context which may be %NULL if
272 * allocation failed.
Tejun Heof2dbd762011-12-14 00:33:40 +0100273 *
274 * Note that this function can't be called with IRQ disabled because
Tejun Heo24acfc32012-03-05 13:15:24 -0800275 * task_lock which protects %current->io_context is IRQ-unsafe.
Tejun Heof2dbd762011-12-14 00:33:40 +0100276 */
Tejun Heo24acfc32012-03-05 13:15:24 -0800277static inline struct io_context *create_io_context(gfp_t gfp_mask, int node)
Tejun Heof2dbd762011-12-14 00:33:40 +0100278{
279 WARN_ON_ONCE(irqs_disabled());
Tejun Heo24acfc32012-03-05 13:15:24 -0800280 if (unlikely(!current->io_context))
281 create_task_io_context(current, gfp_mask, node);
282 return current->io_context;
Tejun Heof2dbd762011-12-14 00:33:40 +0100283}
284
285/*
286 * Internal throttling interface
287 */
Tejun Heobc9fcbf2011-10-19 14:31:18 +0200288#ifdef CONFIG_BLK_DEV_THROTTLING
Tejun Heoc9a929d2011-10-19 14:42:16 +0200289extern void blk_throtl_drain(struct request_queue *q);
Tejun Heobc9fcbf2011-10-19 14:31:18 +0200290extern int blk_throtl_init(struct request_queue *q);
291extern void blk_throtl_exit(struct request_queue *q);
292#else /* CONFIG_BLK_DEV_THROTTLING */
Tejun Heoc9a929d2011-10-19 14:42:16 +0200293static inline void blk_throtl_drain(struct request_queue *q) { }
Tejun Heobc9fcbf2011-10-19 14:31:18 +0200294static inline int blk_throtl_init(struct request_queue *q) { return 0; }
295static inline void blk_throtl_exit(struct request_queue *q) { }
296#endif /* CONFIG_BLK_DEV_THROTTLING */
297
298#endif /* BLK_INTERNAL_H */