blk-mq.h 6.2 KB
Newer Older
1 2 3 4 5 6
#ifndef BLK_MQ_H
#define BLK_MQ_H

#include <linux/blkdev.h>

struct blk_mq_tags;
7
struct blk_flush_queue;
8 9 10 11

struct blk_mq_cpu_notifier {
	struct list_head list;
	void *data;
12
	int (*notify)(void *data, unsigned long action, unsigned int cpu);
13 14
};

15 16 17 18 19 20
struct blk_mq_ctxmap {
	unsigned int map_size;
	unsigned int bits_per_word;
	struct blk_align_bitmap *map;
};

21 22 23 24 25 26 27
struct blk_mq_hw_ctx {
	struct {
		spinlock_t		lock;
		struct list_head	dispatch;
	} ____cacheline_aligned_in_smp;

	unsigned long		state;		/* BLK_MQ_S_* flags */
28 29
	struct delayed_work	run_work;
	struct delayed_work	delay_work;
30
	cpumask_var_t		cpumask;
31 32
	int			next_cpu;
	int			next_cpu_batch;
33 34 35 36 37

	unsigned long		flags;		/* BLK_MQ_F_* flags */

	struct request_queue	*queue;
	unsigned int		queue_num;
38
	struct blk_flush_queue	*fq;
39 40 41

	void			*driver_data;

42 43
	struct blk_mq_ctxmap	ctx_map;

44 45 46
	unsigned int		nr_ctx;
	struct blk_mq_ctx	**ctxs;

47
	atomic_t		wait_index;
48 49 50 51 52 53 54 55 56 57 58

	struct blk_mq_tags	*tags;

	unsigned long		queued;
	unsigned long		run;
#define BLK_MQ_MAX_DISPATCH_ORDER	10
	unsigned long		dispatched[BLK_MQ_MAX_DISPATCH_ORDER];

	unsigned int		numa_node;
	unsigned int		cmd_size;	/* per-request extra data */

59 60
	atomic_t		nr_active;

61 62 63 64
	struct blk_mq_cpu_notifier	cpu_notifier;
	struct kobject		kobj;
};

65
struct blk_mq_tag_set {
66 67
	struct blk_mq_ops	*ops;
	unsigned int		nr_hw_queues;
68
	unsigned int		queue_depth;	/* max hw supported */
69 70 71 72 73
	unsigned int		reserved_tags;
	unsigned int		cmd_size;	/* per-request extra data */
	int			numa_node;
	unsigned int		timeout;
	unsigned int		flags;		/* BLK_MQ_F_* */
74 75 76
	void			*driver_data;

	struct blk_mq_tags	**tags;
77 78 79

	struct mutex		tag_list_lock;
	struct list_head	tag_list;
80 81
};

82 83 84 85 86 87 88
struct blk_mq_queue_data {
	struct request *rq;
	struct list_head *list;
	bool last;
};

typedef int (queue_rq_fn)(struct blk_mq_hw_ctx *, const struct blk_mq_queue_data *);
89
typedef struct blk_mq_hw_ctx *(map_queue_fn)(struct request_queue *, const int);
90
typedef enum blk_eh_timer_return (timeout_fn)(struct request *, bool);
91 92
typedef int (init_hctx_fn)(struct blk_mq_hw_ctx *, void *, unsigned int);
typedef void (exit_hctx_fn)(struct blk_mq_hw_ctx *, unsigned int);
93 94 95 96
typedef int (init_request_fn)(void *, struct request *, unsigned int,
		unsigned int, unsigned int);
typedef void (exit_request_fn)(void *, struct request *, unsigned int,
		unsigned int);
97

98 99 100
typedef void (busy_iter_fn)(struct blk_mq_hw_ctx *, struct request *, void *,
		bool);

101 102 103 104 105 106 107 108 109 110 111 112 113 114
struct blk_mq_ops {
	/*
	 * Queue request
	 */
	queue_rq_fn		*queue_rq;

	/*
	 * Map to specific hardware queue
	 */
	map_queue_fn		*map_queue;

	/*
	 * Called on request timeout
	 */
115
	timeout_fn		*timeout;
116

117 118
	softirq_done_fn		*complete;

119 120 121 122 123 124 125
	/*
	 * Called when the block layer side of a hardware queue has been
	 * set up, allowing the driver to allocate/init matching structures.
	 * Ditto for exit/teardown.
	 */
	init_hctx_fn		*init_hctx;
	exit_hctx_fn		*exit_hctx;
126 127 128 129

	/*
	 * Called for every command allocated by the block layer to allow
	 * the driver to set up driver specific data.
130 131 132 133
	 *
	 * Tag greater than or equal to queue_depth is for setting up
	 * flush request.
	 *
134 135 136 137
	 * Ditto for exit/teardown.
	 */
	init_request_fn		*init_request;
	exit_request_fn		*exit_request;
138 139 140 141 142 143 144 145
};

enum {
	BLK_MQ_RQ_QUEUE_OK	= 0,	/* queued fine */
	BLK_MQ_RQ_QUEUE_BUSY	= 1,	/* requeue IO for later */
	BLK_MQ_RQ_QUEUE_ERROR	= 2,	/* end IO with error */

	BLK_MQ_F_SHOULD_MERGE	= 1 << 0,
146 147 148
	BLK_MQ_F_TAG_SHARED	= 1 << 1,
	BLK_MQ_F_SG_MERGE	= 1 << 2,
	BLK_MQ_F_SYSFS_UP	= 1 << 3,
149
	BLK_MQ_F_DEFER_ISSUE	= 1 << 4,
150

151
	BLK_MQ_S_STOPPED	= 0,
152
	BLK_MQ_S_TAG_ACTIVE	= 1,
153

154
	BLK_MQ_MAX_DEPTH	= 10240,
155 156

	BLK_MQ_CPU_WORK_BATCH	= 8,
157 158
};

159
struct request_queue *blk_mq_init_queue(struct blk_mq_tag_set *);
160
void blk_mq_finish_init(struct request_queue *q);
161 162 163
int blk_mq_register_disk(struct gendisk *);
void blk_mq_unregister_disk(struct gendisk *);

164 165 166
int blk_mq_alloc_tag_set(struct blk_mq_tag_set *set);
void blk_mq_free_tag_set(struct blk_mq_tag_set *set);

167 168
void blk_mq_flush_plug_list(struct blk_plug *plug, bool from_schedule);

169
void blk_mq_insert_request(struct request *, bool, bool, bool);
170 171 172
void blk_mq_run_queues(struct request_queue *q, bool async);
void blk_mq_free_request(struct request *rq);
bool blk_mq_can_queue(struct blk_mq_hw_ctx *);
173 174
struct request *blk_mq_alloc_request(struct request_queue *q, int rw,
		gfp_t gfp, bool reserved);
175
struct request *blk_mq_tag_to_rq(struct blk_mq_tags *tags, unsigned int tag);
176 177

struct blk_mq_hw_ctx *blk_mq_map_queue(struct request_queue *, const int ctx_index);
178
struct blk_mq_hw_ctx *blk_mq_alloc_single_hw_queue(struct blk_mq_tag_set *, unsigned int, int);
179

180
void blk_mq_start_request(struct request *rq);
181 182
void blk_mq_end_request(struct request *rq, int error);
void __blk_mq_end_request(struct request *rq, int error);
183

184
void blk_mq_requeue_request(struct request *rq);
185 186
void blk_mq_add_to_requeue_list(struct request *rq, bool at_head);
void blk_mq_kick_requeue_list(struct request_queue *q);
187 188
void blk_mq_complete_request(struct request *rq);

189 190
void blk_mq_stop_hw_queue(struct blk_mq_hw_ctx *hctx);
void blk_mq_start_hw_queue(struct blk_mq_hw_ctx *hctx);
191
void blk_mq_stop_hw_queues(struct request_queue *q);
192
void blk_mq_start_hw_queues(struct request_queue *q);
193
void blk_mq_start_stopped_hw_queues(struct request_queue *q, bool async);
194
void blk_mq_delay_queue(struct blk_mq_hw_ctx *hctx, unsigned long msecs);
195 196
void blk_mq_tag_busy_iter(struct blk_mq_hw_ctx *hctx, busy_iter_fn *fn,
		void *priv);
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211

/*
 * Driver command data is immediately after the request. So subtract request
 * size to get back to the original request.
 */
static inline struct request *blk_mq_rq_from_pdu(void *pdu)
{
	return pdu - sizeof(struct request);
}
static inline void *blk_mq_rq_to_pdu(struct request *rq)
{
	return (void *) rq + sizeof(*rq);
}

#define queue_for_each_hw_ctx(q, hctx, i)				\
212 213
	for ((i) = 0; (i) < (q)->nr_hw_queues &&			\
	     ({ hctx = (q)->queue_hw_ctx[i]; 1; }); (i)++)
214 215

#define queue_for_each_ctx(q, ctx, i)					\
216 217
	for ((i) = 0; (i) < (q)->nr_queues &&				\
	     ({ ctx = per_cpu_ptr((q)->queue_ctx, (i)); 1; }); (i)++)
218 219

#define hctx_for_each_ctx(hctx, ctx, i)					\
220 221
	for ((i) = 0; (i) < (hctx)->nr_ctx &&				\
	     ({ ctx = (hctx)->ctxs[(i)]; 1; }); (i)++)
222 223 224 225 226 227 228 229 230 231 232 233

#define blk_ctx_sum(q, sum)						\
({									\
	struct blk_mq_ctx *__x;						\
	unsigned int __ret = 0, __i;					\
									\
	queue_for_each_ctx((q), __x, __i)				\
		__ret += sum;						\
	__ret;								\
})

#endif