blob: 468be242db90cd398cd4d1a13443ddf245482bec [file] [log] [blame]
Jens Axboe320ae512013-10-24 09:20:05 +01001#ifndef BLK_MQ_H
2#define BLK_MQ_H
3
4#include <linux/blkdev.h>
5
6struct blk_mq_tags;
7
8struct blk_mq_cpu_notifier {
9 struct list_head list;
10 void *data;
11 void (*notify)(void *data, unsigned long action, unsigned int cpu);
12};
13
14struct blk_mq_hw_ctx {
15 struct {
16 spinlock_t lock;
17 struct list_head dispatch;
18 } ____cacheline_aligned_in_smp;
19
20 unsigned long state; /* BLK_MQ_S_* flags */
21 struct delayed_work delayed_work;
22
23 unsigned long flags; /* BLK_MQ_F_* flags */
24
25 struct request_queue *queue;
26 unsigned int queue_num;
27
28 void *driver_data;
29
30 unsigned int nr_ctx;
31 struct blk_mq_ctx **ctxs;
32 unsigned int nr_ctx_map;
33 unsigned long *ctx_map;
34
35 struct request **rqs;
36 struct list_head page_list;
37 struct blk_mq_tags *tags;
38
Shaohua Lif0276922013-12-31 11:38:50 +080039 atomic_t pending_flush;
40
Jens Axboe320ae512013-10-24 09:20:05 +010041 unsigned long queued;
42 unsigned long run;
43#define BLK_MQ_MAX_DISPATCH_ORDER 10
44 unsigned long dispatched[BLK_MQ_MAX_DISPATCH_ORDER];
45
46 unsigned int queue_depth;
Shaohua Lif0276922013-12-31 11:38:50 +080047 unsigned int reserved_tags;
Jens Axboe320ae512013-10-24 09:20:05 +010048 unsigned int numa_node;
49 unsigned int cmd_size; /* per-request extra data */
50
51 struct blk_mq_cpu_notifier cpu_notifier;
52 struct kobject kobj;
53};
54
55struct blk_mq_reg {
56 struct blk_mq_ops *ops;
57 unsigned int nr_hw_queues;
58 unsigned int queue_depth;
59 unsigned int reserved_tags;
60 unsigned int cmd_size; /* per-request extra data */
61 int numa_node;
62 unsigned int timeout;
63 unsigned int flags; /* BLK_MQ_F_* */
64};
65
66typedef int (queue_rq_fn)(struct blk_mq_hw_ctx *, struct request *);
67typedef struct blk_mq_hw_ctx *(map_queue_fn)(struct request_queue *, const int);
68typedef struct blk_mq_hw_ctx *(alloc_hctx_fn)(struct blk_mq_reg *,unsigned int);
69typedef void (free_hctx_fn)(struct blk_mq_hw_ctx *, unsigned int);
70typedef int (init_hctx_fn)(struct blk_mq_hw_ctx *, void *, unsigned int);
71typedef void (exit_hctx_fn)(struct blk_mq_hw_ctx *, unsigned int);
72
73struct blk_mq_ops {
74 /*
75 * Queue request
76 */
77 queue_rq_fn *queue_rq;
78
79 /*
80 * Map to specific hardware queue
81 */
82 map_queue_fn *map_queue;
83
84 /*
85 * Called on request timeout
86 */
87 rq_timed_out_fn *timeout;
88
Christoph Hellwig30a91cb2014-02-10 03:24:38 -080089 softirq_done_fn *complete;
90
Jens Axboe320ae512013-10-24 09:20:05 +010091 /*
92 * Override for hctx allocations (should probably go)
93 */
94 alloc_hctx_fn *alloc_hctx;
95 free_hctx_fn *free_hctx;
96
97 /*
98 * Called when the block layer side of a hardware queue has been
99 * set up, allowing the driver to allocate/init matching structures.
100 * Ditto for exit/teardown.
101 */
102 init_hctx_fn *init_hctx;
103 exit_hctx_fn *exit_hctx;
104};
105
106enum {
107 BLK_MQ_RQ_QUEUE_OK = 0, /* queued fine */
108 BLK_MQ_RQ_QUEUE_BUSY = 1, /* requeue IO for later */
109 BLK_MQ_RQ_QUEUE_ERROR = 2, /* end IO with error */
110
111 BLK_MQ_F_SHOULD_MERGE = 1 << 0,
112 BLK_MQ_F_SHOULD_SORT = 1 << 1,
113 BLK_MQ_F_SHOULD_IPI = 1 << 2,
114
115 BLK_MQ_S_STOPPED = 1 << 0,
116
117 BLK_MQ_MAX_DEPTH = 2048,
118};
119
120struct request_queue *blk_mq_init_queue(struct blk_mq_reg *, void *);
Jens Axboe320ae512013-10-24 09:20:05 +0100121int blk_mq_register_disk(struct gendisk *);
122void blk_mq_unregister_disk(struct gendisk *);
123void blk_mq_init_commands(struct request_queue *, void (*init)(void *data, struct blk_mq_hw_ctx *, struct request *, unsigned int), void *data);
124
125void blk_mq_flush_plug_list(struct blk_plug *plug, bool from_schedule);
126
Christoph Hellwig72a0a362014-02-07 10:22:36 -0800127void blk_mq_insert_request(struct request_queue *, struct request *,
128 bool, bool);
Jens Axboe320ae512013-10-24 09:20:05 +0100129void blk_mq_run_queues(struct request_queue *q, bool async);
130void blk_mq_free_request(struct request *rq);
131bool blk_mq_can_queue(struct blk_mq_hw_ctx *);
Christoph Hellwig3228f482013-10-28 13:33:58 -0600132struct request *blk_mq_alloc_request(struct request_queue *q, int rw, gfp_t gfp, bool reserved);
Jens Axboe320ae512013-10-24 09:20:05 +0100133struct request *blk_mq_alloc_reserved_request(struct request_queue *q, int rw, gfp_t gfp);
134struct request *blk_mq_rq_from_tag(struct request_queue *q, unsigned int tag);
135
136struct blk_mq_hw_ctx *blk_mq_map_queue(struct request_queue *, const int ctx_index);
137struct blk_mq_hw_ctx *blk_mq_alloc_single_hw_queue(struct blk_mq_reg *, unsigned int);
138void blk_mq_free_single_hw_queue(struct blk_mq_hw_ctx *, unsigned int);
139
140void blk_mq_end_io(struct request *rq, int error);
141
Christoph Hellwig30a91cb2014-02-10 03:24:38 -0800142void blk_mq_complete_request(struct request *rq);
143
Jens Axboe320ae512013-10-24 09:20:05 +0100144void blk_mq_stop_hw_queue(struct blk_mq_hw_ctx *hctx);
145void blk_mq_start_hw_queue(struct blk_mq_hw_ctx *hctx);
Christoph Hellwig280d45f2013-10-25 14:45:58 +0100146void blk_mq_stop_hw_queues(struct request_queue *q);
Jens Axboe320ae512013-10-24 09:20:05 +0100147void blk_mq_start_stopped_hw_queues(struct request_queue *q);
148
149/*
150 * Driver command data is immediately after the request. So subtract request
151 * size to get back to the original request.
152 */
153static inline struct request *blk_mq_rq_from_pdu(void *pdu)
154{
155 return pdu - sizeof(struct request);
156}
157static inline void *blk_mq_rq_to_pdu(struct request *rq)
158{
159 return (void *) rq + sizeof(*rq);
160}
161
162static inline struct request *blk_mq_tag_to_rq(struct blk_mq_hw_ctx *hctx,
163 unsigned int tag)
164{
165 return hctx->rqs[tag];
166}
167
168#define queue_for_each_hw_ctx(q, hctx, i) \
Jose Alonso0d0b7d42014-01-28 08:09:46 -0700169 for ((i) = 0; (i) < (q)->nr_hw_queues && \
170 ({ hctx = (q)->queue_hw_ctx[i]; 1; }); (i)++)
Jens Axboe320ae512013-10-24 09:20:05 +0100171
172#define queue_for_each_ctx(q, ctx, i) \
Jose Alonso0d0b7d42014-01-28 08:09:46 -0700173 for ((i) = 0; (i) < (q)->nr_queues && \
174 ({ ctx = per_cpu_ptr((q)->queue_ctx, (i)); 1; }); (i)++)
Jens Axboe320ae512013-10-24 09:20:05 +0100175
176#define hctx_for_each_ctx(hctx, ctx, i) \
Jose Alonso0d0b7d42014-01-28 08:09:46 -0700177 for ((i) = 0; (i) < (hctx)->nr_ctx && \
178 ({ ctx = (hctx)->ctxs[(i)]; 1; }); (i)++)
Jens Axboe320ae512013-10-24 09:20:05 +0100179
180#define blk_ctx_sum(q, sum) \
181({ \
182 struct blk_mq_ctx *__x; \
183 unsigned int __ret = 0, __i; \
184 \
185 queue_for_each_ctx((q), __x, __i) \
186 __ret += sum; \
187 __ret; \
188})
189
190#endif