blob: a002cf1914270631a625aec015cc472f248f21cc [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;
Jens Axboee814e712014-05-21 13:59:08 -060011 int (*notify)(void *data, unsigned long action, unsigned int cpu);
Jens Axboe320ae512013-10-24 09:20:05 +010012};
13
Jens Axboe1429d7c2014-05-19 09:23:55 -060014struct blk_mq_ctxmap {
15 unsigned int map_size;
16 unsigned int bits_per_word;
17 struct blk_align_bitmap *map;
18};
19
Jens Axboe320ae512013-10-24 09:20:05 +010020struct blk_mq_hw_ctx {
21 struct {
22 spinlock_t lock;
23 struct list_head dispatch;
24 } ____cacheline_aligned_in_smp;
25
26 unsigned long state; /* BLK_MQ_S_* flags */
Christoph Hellwig70f4db62014-04-16 10:48:08 -060027 struct delayed_work run_work;
28 struct delayed_work delay_work;
Jens Axboee4043dc2014-04-09 10:18:23 -060029 cpumask_var_t cpumask;
Jens Axboe506e9312014-05-07 10:26:44 -060030 int next_cpu;
31 int next_cpu_batch;
Jens Axboe320ae512013-10-24 09:20:05 +010032
33 unsigned long flags; /* BLK_MQ_F_* flags */
34
35 struct request_queue *queue;
36 unsigned int queue_num;
37
38 void *driver_data;
39
Jens Axboe1429d7c2014-05-19 09:23:55 -060040 struct blk_mq_ctxmap ctx_map;
41
Jens Axboe4bb659b2014-05-09 09:36:49 -060042 unsigned int nr_ctx;
43 struct blk_mq_ctx **ctxs;
44
45 unsigned int wait_index;
Jens Axboe320ae512013-10-24 09:20:05 +010046
Jens Axboe320ae512013-10-24 09:20:05 +010047 struct blk_mq_tags *tags;
48
49 unsigned long queued;
50 unsigned long run;
51#define BLK_MQ_MAX_DISPATCH_ORDER 10
52 unsigned long dispatched[BLK_MQ_MAX_DISPATCH_ORDER];
53
Jens Axboe320ae512013-10-24 09:20:05 +010054 unsigned int numa_node;
55 unsigned int cmd_size; /* per-request extra data */
56
Jens Axboe0d2602c2014-05-13 15:10:52 -060057 atomic_t nr_active;
58
Jens Axboe320ae512013-10-24 09:20:05 +010059 struct blk_mq_cpu_notifier cpu_notifier;
60 struct kobject kobj;
61};
62
Christoph Hellwig24d2f902014-04-15 14:14:00 -060063struct blk_mq_tag_set {
Jens Axboe320ae512013-10-24 09:20:05 +010064 struct blk_mq_ops *ops;
65 unsigned int nr_hw_queues;
Jens Axboee3a2b3f2014-05-20 11:49:02 -060066 unsigned int queue_depth; /* max hw supported */
Jens Axboe320ae512013-10-24 09:20:05 +010067 unsigned int reserved_tags;
68 unsigned int cmd_size; /* per-request extra data */
69 int numa_node;
70 unsigned int timeout;
71 unsigned int flags; /* BLK_MQ_F_* */
Christoph Hellwig24d2f902014-04-15 14:14:00 -060072 void *driver_data;
73
74 struct blk_mq_tags **tags;
Jens Axboe0d2602c2014-05-13 15:10:52 -060075
76 struct mutex tag_list_lock;
77 struct list_head tag_list;
Jens Axboe320ae512013-10-24 09:20:05 +010078};
79
80typedef int (queue_rq_fn)(struct blk_mq_hw_ctx *, struct request *);
81typedef struct blk_mq_hw_ctx *(map_queue_fn)(struct request_queue *, const int);
Jens Axboe320ae512013-10-24 09:20:05 +010082typedef int (init_hctx_fn)(struct blk_mq_hw_ctx *, void *, unsigned int);
83typedef void (exit_hctx_fn)(struct blk_mq_hw_ctx *, unsigned int);
Christoph Hellwig24d2f902014-04-15 14:14:00 -060084typedef int (init_request_fn)(void *, struct request *, unsigned int,
85 unsigned int, unsigned int);
86typedef void (exit_request_fn)(void *, struct request *, unsigned int,
87 unsigned int);
Jens Axboe320ae512013-10-24 09:20:05 +010088
89struct blk_mq_ops {
90 /*
91 * Queue request
92 */
93 queue_rq_fn *queue_rq;
94
95 /*
96 * Map to specific hardware queue
97 */
98 map_queue_fn *map_queue;
99
100 /*
101 * Called on request timeout
102 */
103 rq_timed_out_fn *timeout;
104
Christoph Hellwig30a91cb2014-02-10 03:24:38 -0800105 softirq_done_fn *complete;
106
Jens Axboe320ae512013-10-24 09:20:05 +0100107 /*
Jens Axboe320ae512013-10-24 09:20:05 +0100108 * Called when the block layer side of a hardware queue has been
109 * set up, allowing the driver to allocate/init matching structures.
110 * Ditto for exit/teardown.
111 */
112 init_hctx_fn *init_hctx;
113 exit_hctx_fn *exit_hctx;
Christoph Hellwige9b267d2014-04-15 13:59:10 -0600114
115 /*
116 * Called for every command allocated by the block layer to allow
117 * the driver to set up driver specific data.
118 * Ditto for exit/teardown.
119 */
120 init_request_fn *init_request;
121 exit_request_fn *exit_request;
Jens Axboe320ae512013-10-24 09:20:05 +0100122};
123
124enum {
125 BLK_MQ_RQ_QUEUE_OK = 0, /* queued fine */
126 BLK_MQ_RQ_QUEUE_BUSY = 1, /* requeue IO for later */
127 BLK_MQ_RQ_QUEUE_ERROR = 2, /* end IO with error */
128
129 BLK_MQ_F_SHOULD_MERGE = 1 << 0,
130 BLK_MQ_F_SHOULD_SORT = 1 << 1,
Jens Axboe0d2602c2014-05-13 15:10:52 -0600131 BLK_MQ_F_TAG_SHARED = 1 << 2,
Jens Axboe05f1dd52014-05-29 09:53:32 -0600132 BLK_MQ_F_SG_MERGE = 1 << 3,
Jens Axboe67aec142014-05-30 08:25:36 -0600133 BLK_MQ_F_SYSFS_UP = 1 << 4,
Jens Axboe320ae512013-10-24 09:20:05 +0100134
Jens Axboe5d12f902014-03-19 15:25:02 -0600135 BLK_MQ_S_STOPPED = 0,
Jens Axboe0d2602c2014-05-13 15:10:52 -0600136 BLK_MQ_S_TAG_ACTIVE = 1,
Jens Axboe320ae512013-10-24 09:20:05 +0100137
Jens Axboea4391c62014-06-05 15:21:56 -0600138 BLK_MQ_MAX_DEPTH = 10240,
Jens Axboe506e9312014-05-07 10:26:44 -0600139
140 BLK_MQ_CPU_WORK_BATCH = 8,
Jens Axboe320ae512013-10-24 09:20:05 +0100141};
142
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600143struct request_queue *blk_mq_init_queue(struct blk_mq_tag_set *);
Jens Axboe320ae512013-10-24 09:20:05 +0100144int blk_mq_register_disk(struct gendisk *);
145void blk_mq_unregister_disk(struct gendisk *);
Jens Axboe320ae512013-10-24 09:20:05 +0100146
Christoph Hellwig24d2f902014-04-15 14:14:00 -0600147int blk_mq_alloc_tag_set(struct blk_mq_tag_set *set);
148void blk_mq_free_tag_set(struct blk_mq_tag_set *set);
149
Jens Axboe320ae512013-10-24 09:20:05 +0100150void blk_mq_flush_plug_list(struct blk_plug *plug, bool from_schedule);
151
Christoph Hellwigfeb71da2014-02-20 15:32:37 -0800152void blk_mq_insert_request(struct request *, bool, bool, bool);
Jens Axboe320ae512013-10-24 09:20:05 +0100153void blk_mq_run_queues(struct request_queue *q, bool async);
154void blk_mq_free_request(struct request *rq);
155bool blk_mq_can_queue(struct blk_mq_hw_ctx *);
Christoph Hellwig4ce01dd2014-05-27 20:59:46 +0200156struct request *blk_mq_alloc_request(struct request_queue *q, int rw,
157 gfp_t gfp, bool reserved);
Jens Axboe0e62f512014-06-04 10:23:49 -0600158struct request *blk_mq_tag_to_rq(struct blk_mq_tags *tags, unsigned int tag);
Jens Axboe320ae512013-10-24 09:20:05 +0100159
160struct blk_mq_hw_ctx *blk_mq_map_queue(struct request_queue *, const int ctx_index);
Jens Axboef14bbe72014-05-27 12:06:53 -0600161struct blk_mq_hw_ctx *blk_mq_alloc_single_hw_queue(struct blk_mq_tag_set *, unsigned int, int);
Jens Axboe320ae512013-10-24 09:20:05 +0100162
Christoph Hellwig63151a42014-04-16 09:44:52 +0200163void blk_mq_end_io(struct request *rq, int error);
164void __blk_mq_end_io(struct request *rq, int error);
Jens Axboe320ae512013-10-24 09:20:05 +0100165
Christoph Hellwiged0791b2014-04-16 09:44:57 +0200166void blk_mq_requeue_request(struct request *rq);
Christoph Hellwig6fca6a62014-05-28 08:08:02 -0600167void blk_mq_add_to_requeue_list(struct request *rq, bool at_head);
168void blk_mq_kick_requeue_list(struct request_queue *q);
Christoph Hellwig30a91cb2014-02-10 03:24:38 -0800169void blk_mq_complete_request(struct request *rq);
170
Jens Axboe320ae512013-10-24 09:20:05 +0100171void blk_mq_stop_hw_queue(struct blk_mq_hw_ctx *hctx);
172void blk_mq_start_hw_queue(struct blk_mq_hw_ctx *hctx);
Christoph Hellwig280d45f2013-10-25 14:45:58 +0100173void blk_mq_stop_hw_queues(struct request_queue *q);
Christoph Hellwig2f268552014-04-16 09:44:56 +0200174void blk_mq_start_hw_queues(struct request_queue *q);
Christoph Hellwig1b4a3252014-04-16 09:44:54 +0200175void blk_mq_start_stopped_hw_queues(struct request_queue *q, bool async);
Christoph Hellwig70f4db62014-04-16 10:48:08 -0600176void blk_mq_delay_queue(struct blk_mq_hw_ctx *hctx, unsigned long msecs);
Sam Bradshawedf866b2014-05-23 13:30:16 -0600177void blk_mq_tag_busy_iter(struct blk_mq_tags *tags, void (*fn)(void *data, unsigned long *), void *data);
Jens Axboe320ae512013-10-24 09:20:05 +0100178
179/*
180 * Driver command data is immediately after the request. So subtract request
181 * size to get back to the original request.
182 */
183static inline struct request *blk_mq_rq_from_pdu(void *pdu)
184{
185 return pdu - sizeof(struct request);
186}
187static inline void *blk_mq_rq_to_pdu(struct request *rq)
188{
189 return (void *) rq + sizeof(*rq);
190}
191
Jens Axboe320ae512013-10-24 09:20:05 +0100192#define queue_for_each_hw_ctx(q, hctx, i) \
Jose Alonso0d0b7d42014-01-28 08:09:46 -0700193 for ((i) = 0; (i) < (q)->nr_hw_queues && \
194 ({ hctx = (q)->queue_hw_ctx[i]; 1; }); (i)++)
Jens Axboe320ae512013-10-24 09:20:05 +0100195
196#define queue_for_each_ctx(q, ctx, i) \
Jose Alonso0d0b7d42014-01-28 08:09:46 -0700197 for ((i) = 0; (i) < (q)->nr_queues && \
198 ({ ctx = per_cpu_ptr((q)->queue_ctx, (i)); 1; }); (i)++)
Jens Axboe320ae512013-10-24 09:20:05 +0100199
200#define hctx_for_each_ctx(hctx, ctx, i) \
Jose Alonso0d0b7d42014-01-28 08:09:46 -0700201 for ((i) = 0; (i) < (hctx)->nr_ctx && \
202 ({ ctx = (hctx)->ctxs[(i)]; 1; }); (i)++)
Jens Axboe320ae512013-10-24 09:20:05 +0100203
204#define blk_ctx_sum(q, sum) \
205({ \
206 struct blk_mq_ctx *__x; \
207 unsigned int __ret = 0, __i; \
208 \
209 queue_for_each_ctx((q), __x, __i) \
210 __ret += sum; \
211 __ret; \
212})
213
214#endif