[mirror_ubuntu-artful-kernel.git] / include / linux / blk-mq.h

#ifndef BLK_MQ_H
#define BLK_MQ_H

#include <linux/blkdev.h>

struct blk_mq_tags;

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

struct blk_mq_hw_ctx {
	struct {
		spinlock_t		lock;
		struct list_head	dispatch;
	} ____cacheline_aligned_in_smp;

	unsigned long		state;		/* BLK_MQ_S_* flags */
	struct delayed_work	run_work;
	struct delayed_work	delay_work;
	cpumask_var_t		cpumask;

	unsigned long		flags;		/* BLK_MQ_F_* flags */

	struct request_queue	*queue;
	unsigned int		queue_num;

	void			*driver_data;

	unsigned int		nr_ctx;
	struct blk_mq_ctx	**ctxs;
	unsigned int 		nr_ctx_map;
	unsigned long		*ctx_map;

	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 */

	struct blk_mq_cpu_notifier	cpu_notifier;
	struct kobject		kobj;
};

struct blk_mq_tag_set {
	struct blk_mq_ops	*ops;
	unsigned int		nr_hw_queues;
	unsigned int		queue_depth;
	unsigned int		reserved_tags;
	unsigned int		cmd_size;	/* per-request extra data */
	int			numa_node;
	unsigned int		timeout;
	unsigned int		flags;		/* BLK_MQ_F_* */
	void			*driver_data;

	struct blk_mq_tags	**tags;
};

typedef int (queue_rq_fn)(struct blk_mq_hw_ctx *, struct request *);
typedef struct blk_mq_hw_ctx *(map_queue_fn)(struct request_queue *, const int);
typedef struct blk_mq_hw_ctx *(alloc_hctx_fn)(struct blk_mq_tag_set *,
		unsigned int);
typedef void (free_hctx_fn)(struct blk_mq_hw_ctx *, unsigned int);
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);
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);

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
	 */
	rq_timed_out_fn		*timeout;

	softirq_done_fn		*complete;

	/*
	 * Override for hctx allocations (should probably go)
	 */
	alloc_hctx_fn		*alloc_hctx;
	free_hctx_fn		*free_hctx;

	/*
	 * 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;

	/*
	 * Called for every command allocated by the block layer to allow
	 * the driver to set up driver specific data.
	 * Ditto for exit/teardown.
	 */
	init_request_fn		*init_request;
	exit_request_fn		*exit_request;
};

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,
	BLK_MQ_F_SHOULD_SORT	= 1 << 1,
	BLK_MQ_F_SHOULD_IPI	= 1 << 2,

	BLK_MQ_S_STOPPED	= 0,

	BLK_MQ_MAX_DEPTH	= 2048,
};

struct request_queue *blk_mq_init_queue(struct blk_mq_tag_set *);
int blk_mq_register_disk(struct gendisk *);
void blk_mq_unregister_disk(struct gendisk *);

int blk_mq_alloc_tag_set(struct blk_mq_tag_set *set);
void blk_mq_free_tag_set(struct blk_mq_tag_set *set);

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

void blk_mq_insert_request(struct request *, bool, bool, bool);
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 *);
struct request *blk_mq_alloc_request(struct request_queue *q, int rw, gfp_t gfp);
struct request *blk_mq_alloc_reserved_request(struct request_queue *q, int rw, gfp_t gfp);
struct request *blk_mq_tag_to_rq(struct blk_mq_tags *tags, unsigned int tag);

struct blk_mq_hw_ctx *blk_mq_map_queue(struct request_queue *, const int ctx_index);
struct blk_mq_hw_ctx *blk_mq_alloc_single_hw_queue(struct blk_mq_tag_set *, unsigned int);
void blk_mq_free_single_hw_queue(struct blk_mq_hw_ctx *, unsigned int);

void blk_mq_end_io(struct request *rq, int error);
void __blk_mq_end_io(struct request *rq, int error);

void blk_mq_complete_request(struct request *rq);

void blk_mq_stop_hw_queue(struct blk_mq_hw_ctx *hctx);
void blk_mq_start_hw_queue(struct blk_mq_hw_ctx *hctx);
void blk_mq_stop_hw_queues(struct request_queue *q);
void blk_mq_start_hw_queues(struct request_queue *q);
void blk_mq_start_stopped_hw_queues(struct request_queue *q, bool async);
void blk_mq_delay_queue(struct blk_mq_hw_ctx *hctx, unsigned long msecs);

/*
 * 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)				\
	for ((i) = 0; (i) < (q)->nr_hw_queues &&			\
	     ({ hctx = (q)->queue_hw_ctx[i]; 1; }); (i)++)

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

#define hctx_for_each_ctx(hctx, ctx, i)					\
	for ((i) = 0; (i) < (hctx)->nr_ctx &&				\
	     ({ ctx = (hctx)->ctxs[(i)]; 1; }); (i)++)

#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
Commit	Line	Data
320ae51f JA	1	#ifndef BLK_MQ_H
	2	#define BLK_MQ_H
	3
	4	#include <linux/blkdev.h>
	5
	6	struct blk_mq_tags;
	7
	8	struct 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
	14	struct 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 */
70f4db63 CH	21	struct delayed_work run_work;
70f4db63 CH	22	struct delayed_work delay_work;
e4043dcf	23	cpumask_var_t cpumask;
320ae51f JA	24
	25	unsigned long flags; /* BLK_MQ_F_* flags */
	26
	27	struct request_queue *queue;
	28	unsigned int queue_num;
	29
	30	void *driver_data;
	31
	32	unsigned int nr_ctx;
	33	struct blk_mq_ctx **ctxs;
	34	unsigned int nr_ctx_map;
	35	unsigned long *ctx_map;
	36
320ae51f JA	37	struct blk_mq_tags *tags;
	38
	39	unsigned long queued;
	40	unsigned long run;
	41	#define BLK_MQ_MAX_DISPATCH_ORDER 10
	42	unsigned long dispatched[BLK_MQ_MAX_DISPATCH_ORDER];
	43
320ae51f JA	44	unsigned int numa_node;
	45	unsigned int cmd_size; /* per-request extra data */
	46
	47	struct blk_mq_cpu_notifier cpu_notifier;
	48	struct kobject kobj;
	49	};
	50
24d2f903	51	struct blk_mq_tag_set {
320ae51f JA	52	struct blk_mq_ops *ops;
	53	unsigned int nr_hw_queues;
	54	unsigned int queue_depth;
	55	unsigned int reserved_tags;
	56	unsigned int cmd_size; /* per-request extra data */
	57	int numa_node;
	58	unsigned int timeout;
	59	unsigned int flags; /* BLK_MQ_F_* */
24d2f903 CH	60	void *driver_data;
	61
	62	struct blk_mq_tags **tags;
320ae51f JA	63	};
	64
	65	typedef int (queue_rq_fn)(struct blk_mq_hw_ctx , struct request );
	66	typedef struct blk_mq_hw_ctx (map_queue_fn)(struct request_queue , const int);
24d2f903 CH	67	typedef struct blk_mq_hw_ctx (alloc_hctx_fn)(struct blk_mq_tag_set ,
24d2f903 CH	68	unsigned int);
320ae51f JA	69	typedef void (free_hctx_fn)(struct blk_mq_hw_ctx *, unsigned int);
	70	typedef int (init_hctx_fn)(struct blk_mq_hw_ctx , void , unsigned int);
	71	typedef void (exit_hctx_fn)(struct blk_mq_hw_ctx *, unsigned int);
24d2f903 CH	72	typedef int (init_request_fn)(void , struct request , unsigned int,
	73	unsigned int, unsigned int);
	74	typedef void (exit_request_fn)(void , struct request , unsigned int,
	75	unsigned int);
320ae51f JA	76
	77	struct blk_mq_ops {
	78	/*
	79	* Queue request
	80	*/
	81	queue_rq_fn *queue_rq;
	82
	83	/*
	84	* Map to specific hardware queue
	85	*/
	86	map_queue_fn *map_queue;
	87
	88	/*
	89	* Called on request timeout
	90	*/
	91	rq_timed_out_fn *timeout;
	92
30a91cb4 CH	93	softirq_done_fn *complete;
30a91cb4 CH	94
320ae51f JA	95	/*
	96	* Override for hctx allocations (should probably go)
	97	*/
	98	alloc_hctx_fn *alloc_hctx;
	99	free_hctx_fn *free_hctx;
	100
	101	/*
	102	* Called when the block layer side of a hardware queue has been
	103	* set up, allowing the driver to allocate/init matching structures.
	104	* Ditto for exit/teardown.
	105	*/
	106	init_hctx_fn *init_hctx;
	107	exit_hctx_fn *exit_hctx;
e9b267d9 CH	108
	109	/*
	110	* Called for every command allocated by the block layer to allow
	111	* the driver to set up driver specific data.
	112	* Ditto for exit/teardown.
	113	*/
	114	init_request_fn *init_request;
	115	exit_request_fn *exit_request;
320ae51f JA	116	};
	117
	118	enum {
	119	BLK_MQ_RQ_QUEUE_OK = 0, /* queued fine */
	120	BLK_MQ_RQ_QUEUE_BUSY = 1, /* requeue IO for later */
	121	BLK_MQ_RQ_QUEUE_ERROR = 2, /* end IO with error */
	122
	123	BLK_MQ_F_SHOULD_MERGE = 1 << 0,
	124	BLK_MQ_F_SHOULD_SORT = 1 << 1,
	125	BLK_MQ_F_SHOULD_IPI = 1 << 2,
	126
5d12f905	127	BLK_MQ_S_STOPPED = 0,
320ae51f JA	128
	129	BLK_MQ_MAX_DEPTH = 2048,
	130	};
	131
24d2f903	132	struct request_queue blk_mq_init_queue(struct blk_mq_tag_set );
320ae51f JA	133	int blk_mq_register_disk(struct gendisk *);
320ae51f JA	134	void blk_mq_unregister_disk(struct gendisk *);
320ae51f	135
24d2f903 CH	136	int blk_mq_alloc_tag_set(struct blk_mq_tag_set *set);
	137	void blk_mq_free_tag_set(struct blk_mq_tag_set *set);
	138
320ae51f JA	139	void blk_mq_flush_plug_list(struct blk_plug *plug, bool from_schedule);
320ae51f JA	140
feb71dae	141	void blk_mq_insert_request(struct request *, bool, bool, bool);
320ae51f JA	142	void blk_mq_run_queues(struct request_queue *q, bool async);
	143	void blk_mq_free_request(struct request *rq);
	144	bool blk_mq_can_queue(struct blk_mq_hw_ctx *);
18741986	145	struct request blk_mq_alloc_request(struct request_queue q, int rw, gfp_t gfp);
320ae51f	146	struct request blk_mq_alloc_reserved_request(struct request_queue q, int rw, gfp_t gfp);
24d2f903	147	struct request blk_mq_tag_to_rq(struct blk_mq_tags tags, unsigned int tag);
320ae51f JA	148
320ae51f JA	149	struct blk_mq_hw_ctx blk_mq_map_queue(struct request_queue , const int ctx_index);
24d2f903	150	struct blk_mq_hw_ctx blk_mq_alloc_single_hw_queue(struct blk_mq_tag_set , unsigned int);
320ae51f JA	151	void blk_mq_free_single_hw_queue(struct blk_mq_hw_ctx *, unsigned int);
320ae51f JA	152
63151a44 CH	153	void blk_mq_end_io(struct request *rq, int error);
63151a44 CH	154	void __blk_mq_end_io(struct request *rq, int error);
320ae51f	155
30a91cb4 CH	156	void blk_mq_complete_request(struct request *rq);
30a91cb4 CH	157
320ae51f JA	158	void blk_mq_stop_hw_queue(struct blk_mq_hw_ctx *hctx);
320ae51f JA	159	void blk_mq_start_hw_queue(struct blk_mq_hw_ctx *hctx);
280d45f6	160	void blk_mq_stop_hw_queues(struct request_queue *q);
2f268556	161	void blk_mq_start_hw_queues(struct request_queue *q);
1b4a3258	162	void blk_mq_start_stopped_hw_queues(struct request_queue *q, bool async);
70f4db63	163	void blk_mq_delay_queue(struct blk_mq_hw_ctx *hctx, unsigned long msecs);
320ae51f JA	164
	165	/*
	166	* Driver command data is immediately after the request. So subtract request
	167	* size to get back to the original request.
	168	*/
	169	static inline struct request blk_mq_rq_from_pdu(void pdu)
	170	{
	171	return pdu - sizeof(struct request);
	172	}
	173	static inline void blk_mq_rq_to_pdu(struct request rq)
	174	{
	175	return (void ) rq + sizeof(rq);
	176	}
	177
320ae51f	178	#define queue_for_each_hw_ctx(q, hctx, i) \
0d0b7d42 JA	179	for ((i) = 0; (i) < (q)->nr_hw_queues && \
0d0b7d42 JA	180	({ hctx = (q)->queue_hw_ctx[i]; 1; }); (i)++)
320ae51f JA	181
320ae51f JA	182	#define queue_for_each_ctx(q, ctx, i) \
0d0b7d42 JA	183	for ((i) = 0; (i) < (q)->nr_queues && \
0d0b7d42 JA	184	({ ctx = per_cpu_ptr((q)->queue_ctx, (i)); 1; }); (i)++)
320ae51f JA	185
320ae51f JA	186	#define hctx_for_each_ctx(hctx, ctx, i) \
0d0b7d42 JA	187	for ((i) = 0; (i) < (hctx)->nr_ctx && \
0d0b7d42 JA	188	({ ctx = (hctx)->ctxs[(i)]; 1; }); (i)++)
320ae51f JA	189
	190	#define blk_ctx_sum(q, sum) \
	191	({ \
	192	struct blk_mq_ctx *__x; \
	193	unsigned int __ret = 0, __i; \
	194	\
	195	queue_for_each_ctx((q), __x, __i) \
	196	__ret += sum; \
	197	__ret; \
	198	})
	199
	200	#endif