[mirror_ubuntu-bionic-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	delayed_work;

	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 request		**rqs;
	struct list_head	page_list;
	struct blk_mq_tags	*tags;

	atomic_t		pending_flush;

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

	unsigned int		queue_depth;
	unsigned int		reserved_tags;
	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_reg {
	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_* */
};

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_reg *,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);

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;

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

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	= 1 << 0,

	BLK_MQ_MAX_DEPTH	= 2048,
};

struct request_queue *blk_mq_init_queue(struct blk_mq_reg *, void *);
int blk_mq_register_disk(struct gendisk *);
void blk_mq_unregister_disk(struct gendisk *);
void blk_mq_init_commands(struct request_queue *, void (*init)(void *data, struct blk_mq_hw_ctx *, struct request *, unsigned int), void *data);

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

void blk_mq_insert_request(struct request_queue *, struct request *, 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, bool reserved);
struct request *blk_mq_alloc_reserved_request(struct request_queue *q, int rw, gfp_t gfp);
struct request *blk_mq_rq_from_tag(struct request_queue *q, 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_reg *, 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_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_stopped_hw_queues(struct request_queue *q);

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

static inline struct request *blk_mq_tag_to_rq(struct blk_mq_hw_ctx *hctx,
					       unsigned int tag)
{
	return hctx->rqs[tag];
}

#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 */
	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
f0276924 SL	39	atomic_t pending_flush;
f0276924 SL	40
320ae51f JA	41	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;
f0276924	47	unsigned int reserved_tags;
320ae51f JA	48	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
	55	struct 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
	66	typedef int (queue_rq_fn)(struct blk_mq_hw_ctx , struct request );
	67	typedef struct blk_mq_hw_ctx (map_queue_fn)(struct request_queue , const int);
	68	typedef struct blk_mq_hw_ctx (alloc_hctx_fn)(struct blk_mq_reg ,unsigned int);
	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);
	72
	73	struct 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
	89	/*
	90	* Override for hctx allocations (should probably go)
	91	*/
	92	alloc_hctx_fn *alloc_hctx;
	93	free_hctx_fn *free_hctx;
	94
	95	/*
	96	* Called when the block layer side of a hardware queue has been
	97	* set up, allowing the driver to allocate/init matching structures.
	98	* Ditto for exit/teardown.
	99	*/
	100	init_hctx_fn *init_hctx;
	101	exit_hctx_fn *exit_hctx;
	102	};
	103
	104	enum {
	105	BLK_MQ_RQ_QUEUE_OK = 0, /* queued fine */
	106	BLK_MQ_RQ_QUEUE_BUSY = 1, /* requeue IO for later */
	107	BLK_MQ_RQ_QUEUE_ERROR = 2, /* end IO with error */
	108
	109	BLK_MQ_F_SHOULD_MERGE = 1 << 0,
	110	BLK_MQ_F_SHOULD_SORT = 1 << 1,
	111	BLK_MQ_F_SHOULD_IPI = 1 << 2,
112
113	BLK_MQ_S_STOPPED = 1 << 0,
114
115	BLK_MQ_MAX_DEPTH = 2048,
116	};
117
118	struct request_queue blk_mq_init_queue(struct blk_mq_reg , void *);
320ae51f JA	119	int blk_mq_register_disk(struct gendisk *);
	120	void blk_mq_unregister_disk(struct gendisk *);
	121	void blk_mq_init_commands(struct request_queue , void (init)(void data, struct blk_mq_hw_ctx , struct request , unsigned int), void data);
	122
	123	void blk_mq_flush_plug_list(struct blk_plug *plug, bool from_schedule);
	124
	125	void blk_mq_insert_request(struct request_queue , struct request , bool);
	126	void blk_mq_run_queues(struct request_queue *q, bool async);
	127	void blk_mq_free_request(struct request *rq);
	128	bool blk_mq_can_queue(struct blk_mq_hw_ctx *);
3228f48b	129	struct request blk_mq_alloc_request(struct request_queue q, int rw, gfp_t gfp, bool reserved);
320ae51f JA	130	struct request blk_mq_alloc_reserved_request(struct request_queue q, int rw, gfp_t gfp);
	131	struct request blk_mq_rq_from_tag(struct request_queue q, unsigned int tag);
	132
	133	struct blk_mq_hw_ctx blk_mq_map_queue(struct request_queue , const int ctx_index);
	134	struct blk_mq_hw_ctx blk_mq_alloc_single_hw_queue(struct blk_mq_reg , unsigned int);
	135	void blk_mq_free_single_hw_queue(struct blk_mq_hw_ctx *, unsigned int);
	136
	137	void blk_mq_end_io(struct request *rq, int error);
	138
	139	void blk_mq_stop_hw_queue(struct blk_mq_hw_ctx *hctx);
	140	void blk_mq_start_hw_queue(struct blk_mq_hw_ctx *hctx);
280d45f6	141	void blk_mq_stop_hw_queues(struct request_queue *q);
320ae51f JA	142	void blk_mq_start_stopped_hw_queues(struct request_queue *q);
	143
	144	/*
	145	* Driver command data is immediately after the request. So subtract request
	146	* size to get back to the original request.
	147	*/
	148	static inline struct request blk_mq_rq_from_pdu(void pdu)
	149	{
	150	return pdu - sizeof(struct request);
	151	}
	152	static inline void blk_mq_rq_to_pdu(struct request rq)
	153	{
	154	return (void ) rq + sizeof(rq);
	155	}
	156
	157	static inline struct request blk_mq_tag_to_rq(struct blk_mq_hw_ctx hctx,
	158	unsigned int tag)
	159	{
	160	return hctx->rqs[tag];
	161	}
	162
	163	#define queue_for_each_hw_ctx(q, hctx, i) \
0d0b7d42 JA	164	for ((i) = 0; (i) < (q)->nr_hw_queues && \
0d0b7d42 JA	165	({ hctx = (q)->queue_hw_ctx[i]; 1; }); (i)++)
320ae51f JA	166
320ae51f JA	167	#define queue_for_each_ctx(q, ctx, i) \
0d0b7d42 JA	168	for ((i) = 0; (i) < (q)->nr_queues && \
0d0b7d42 JA	169	({ ctx = per_cpu_ptr((q)->queue_ctx, (i)); 1; }); (i)++)
320ae51f JA	170
320ae51f JA	171	#define hctx_for_each_ctx(hctx, ctx, i) \
0d0b7d42 JA	172	for ((i) = 0; (i) < (hctx)->nr_ctx && \
0d0b7d42 JA	173	({ ctx = (hctx)->ctxs[(i)]; 1; }); (i)++)
320ae51f JA	174
	175	#define blk_ctx_sum(q, sum) \
	176	({ \
	177	struct blk_mq_ctx *__x; \
	178	unsigned int __ret = 0, __i; \
	179	\
	180	queue_for_each_ctx((q), __x, __i) \
	181	__ret += sum; \
	182	__ret; \
	183	})
	184
	185	#endif