[mirror_ubuntu-bionic-kernel.git] / block / blk-mq.h

#ifndef INT_BLK_MQ_H
#define INT_BLK_MQ_H

#include "blk-stat.h"

struct blk_mq_tag_set;

struct blk_mq_ctx {
	struct {
		spinlock_t		lock;
		struct list_head	rq_list;
	}  ____cacheline_aligned_in_smp;

	unsigned int		cpu;
	unsigned int		index_hw;

	/* incremented at dispatch time */
	unsigned long		rq_dispatched[2];
	unsigned long		rq_merged;

	/* incremented at completion time */
	unsigned long		____cacheline_aligned_in_smp rq_completed[2];
	struct blk_rq_stat	stat[2];

	struct request_queue	*queue;
	struct kobject		kobj;
} ____cacheline_aligned_in_smp;

void blk_mq_run_hw_queue(struct blk_mq_hw_ctx *hctx, bool async);
void blk_mq_freeze_queue(struct request_queue *q);
void blk_mq_free_queue(struct request_queue *q);
int blk_mq_update_nr_requests(struct request_queue *q, unsigned int nr);
void blk_mq_wake_waiters(struct request_queue *q);
bool blk_mq_dispatch_rq_list(struct blk_mq_hw_ctx *, struct list_head *);
void blk_mq_flush_busy_ctxs(struct blk_mq_hw_ctx *hctx, struct list_head *list);
bool blk_mq_hctx_has_pending(struct blk_mq_hw_ctx *hctx);
bool blk_mq_get_driver_tag(struct request *rq, struct blk_mq_hw_ctx **hctx,
				bool wait);

/*
 * Internal helpers for allocating/freeing the request map
 */
void blk_mq_free_rqs(struct blk_mq_tag_set *set, struct blk_mq_tags *tags,
		     unsigned int hctx_idx);
void blk_mq_free_rq_map(struct blk_mq_tags *tags);
struct blk_mq_tags *blk_mq_alloc_rq_map(struct blk_mq_tag_set *set,
					unsigned int hctx_idx,
					unsigned int nr_tags,
					unsigned int reserved_tags);
int blk_mq_alloc_rqs(struct blk_mq_tag_set *set, struct blk_mq_tags *tags,
		     unsigned int hctx_idx, unsigned int depth);

/*
 * Internal helpers for request insertion into sw queues
 */
void __blk_mq_insert_request(struct blk_mq_hw_ctx *hctx, struct request *rq,
				bool at_head);
void blk_mq_insert_requests(struct blk_mq_hw_ctx *hctx, struct blk_mq_ctx *ctx,
				struct list_head *list);
/*
 * CPU hotplug helpers
 */
void blk_mq_enable_hotplug(void);
void blk_mq_disable_hotplug(void);

/*
 * CPU -> queue mappings
 */
extern int blk_mq_hw_queue_to_node(unsigned int *map, unsigned int);

static inline struct blk_mq_hw_ctx *blk_mq_map_queue(struct request_queue *q,
		int cpu)
{
	return q->queue_hw_ctx[q->mq_map[cpu]];
}

/*
 * sysfs helpers
 */
extern int blk_mq_sysfs_register(struct request_queue *q);
extern void blk_mq_sysfs_unregister(struct request_queue *q);
extern void blk_mq_hctx_kobj_init(struct blk_mq_hw_ctx *hctx);

/*
 * debugfs helpers
 */
#ifdef CONFIG_BLK_DEBUG_FS
int blk_mq_debugfs_register(struct request_queue *q, const char *name);
void blk_mq_debugfs_unregister(struct request_queue *q);
int blk_mq_debugfs_register_hctxs(struct request_queue *q);
void blk_mq_debugfs_unregister_hctxs(struct request_queue *q);
#else
static inline int blk_mq_debugfs_register(struct request_queue *q,
					  const char *name)
{
	return 0;
}

static inline void blk_mq_debugfs_unregister(struct request_queue *q)
{
}

static inline int blk_mq_debugfs_register_hctxs(struct request_queue *q)
{
	return 0;
}

static inline void blk_mq_debugfs_unregister_hctxs(struct request_queue *q)
{
}
#endif

extern void blk_mq_rq_timed_out(struct request *req, bool reserved);

void blk_mq_release(struct request_queue *q);

static inline struct blk_mq_ctx *__blk_mq_get_ctx(struct request_queue *q,
					   unsigned int cpu)
{
	return per_cpu_ptr(q->queue_ctx, cpu);
}

/*
 * This assumes per-cpu software queueing queues. They could be per-node
 * as well, for instance. For now this is hardcoded as-is. Note that we don't
 * care about preemption, since we know the ctx's are persistent. This does
 * mean that we can't rely on ctx always matching the currently running CPU.
 */
static inline struct blk_mq_ctx *blk_mq_get_ctx(struct request_queue *q)
{
	return __blk_mq_get_ctx(q, get_cpu());
}

static inline void blk_mq_put_ctx(struct blk_mq_ctx *ctx)
{
	put_cpu();
}

struct blk_mq_alloc_data {
	/* input parameter */
	struct request_queue *q;
	unsigned int flags;

	/* input & output parameter */
	struct blk_mq_ctx *ctx;
	struct blk_mq_hw_ctx *hctx;
};

static inline struct blk_mq_tags *blk_mq_tags_from_data(struct blk_mq_alloc_data *data)
{
	if (data->flags & BLK_MQ_REQ_INTERNAL)
		return data->hctx->sched_tags;

	return data->hctx->tags;
}

/*
 * Internal helpers for request allocation/init/free
 */
void blk_mq_rq_ctx_init(struct request_queue *q, struct blk_mq_ctx *ctx,
			struct request *rq, unsigned int op);
void __blk_mq_finish_request(struct blk_mq_hw_ctx *hctx, struct blk_mq_ctx *ctx,
				struct request *rq);
void blk_mq_finish_request(struct request *rq);
struct request *__blk_mq_alloc_request(struct blk_mq_alloc_data *data,
					unsigned int op);

static inline bool blk_mq_hctx_stopped(struct blk_mq_hw_ctx *hctx)
{
	return test_bit(BLK_MQ_S_STOPPED, &hctx->state);
}

static inline bool blk_mq_hw_queue_mapped(struct blk_mq_hw_ctx *hctx)
{
	return hctx->nr_ctx && hctx->tags;
}

#endif
Commit	Line	Data
320ae51f JA	1	#ifndef INT_BLK_MQ_H
	2	#define INT_BLK_MQ_H
	3
cf43e6be JA	4	#include "blk-stat.h"
cf43e6be JA	5
24d2f903 CH	6	struct blk_mq_tag_set;
24d2f903 CH	7
320ae51f JA	8	struct blk_mq_ctx {
	9	struct {
	10	spinlock_t lock;
	11	struct list_head rq_list;
	12	} ____cacheline_aligned_in_smp;
	13
	14	unsigned int cpu;
	15	unsigned int index_hw;
320ae51f JA	16
	17	/* incremented at dispatch time */
	18	unsigned long rq_dispatched[2];
	19	unsigned long rq_merged;
	20
	21	/* incremented at completion time */
	22	unsigned long ____cacheline_aligned_in_smp rq_completed[2];
cf43e6be	23	struct blk_rq_stat stat[2];
320ae51f JA	24
	25	struct request_queue *queue;
	26	struct kobject kobj;
4bb659b1	27	} ____cacheline_aligned_in_smp;
320ae51f	28
320ae51f	29	void blk_mq_run_hw_queue(struct blk_mq_hw_ctx *hctx, bool async);
780db207	30	void blk_mq_freeze_queue(struct request_queue *q);
3edcc0ce	31	void blk_mq_free_queue(struct request_queue *q);
e3a2b3f9	32	int blk_mq_update_nr_requests(struct request_queue *q, unsigned int nr);
aed3ea94	33	void blk_mq_wake_waiters(struct request_queue *q);
f04c3df3	34	bool blk_mq_dispatch_rq_list(struct blk_mq_hw_ctx , struct list_head );
2c3ad667	35	void blk_mq_flush_busy_ctxs(struct blk_mq_hw_ctx hctx, struct list_head list);
50e1dab8	36	bool blk_mq_hctx_has_pending(struct blk_mq_hw_ctx *hctx);
bd6737f1 JA	37	bool blk_mq_get_driver_tag(struct request rq, struct blk_mq_hw_ctx *hctx,
bd6737f1 JA	38	bool wait);
2c3ad667 JA	39
	40	/*
	41	* Internal helpers for allocating/freeing the request map
	42	*/
cc71a6f4 JA	43	void blk_mq_free_rqs(struct blk_mq_tag_set set, struct blk_mq_tags tags,
	44	unsigned int hctx_idx);
	45	void blk_mq_free_rq_map(struct blk_mq_tags *tags);
	46	struct blk_mq_tags blk_mq_alloc_rq_map(struct blk_mq_tag_set set,
	47	unsigned int hctx_idx,
	48	unsigned int nr_tags,
	49	unsigned int reserved_tags);
	50	int blk_mq_alloc_rqs(struct blk_mq_tag_set set, struct blk_mq_tags tags,
	51	unsigned int hctx_idx, unsigned int depth);
2c3ad667 JA	52
	53	/*
	54	* Internal helpers for request insertion into sw queues
	55	*/
	56	void __blk_mq_insert_request(struct blk_mq_hw_ctx hctx, struct request rq,
	57	bool at_head);
bd166ef1 JA	58	void blk_mq_insert_requests(struct blk_mq_hw_ctx hctx, struct blk_mq_ctx ctx,
bd166ef1 JA	59	struct list_head *list);
320ae51f JA	60	/*
	61	* CPU hotplug helpers
	62	*/
676141e4 JA	63	void blk_mq_enable_hotplug(void);
676141e4 JA	64	void blk_mq_disable_hotplug(void);
320ae51f JA	65
	66	/*
	67	* CPU -> queue mappings
	68	*/
f14bbe77	69	extern int blk_mq_hw_queue_to_node(unsigned int *map, unsigned int);
320ae51f	70
7d7e0f90 CH	71	static inline struct blk_mq_hw_ctx blk_mq_map_queue(struct request_queue q,
	72	int cpu)
	73	{
	74	return q->queue_hw_ctx[q->mq_map[cpu]];
	75	}
	76
67aec14c JA	77	/*
	78	* sysfs helpers
	79	*/
	80	extern int blk_mq_sysfs_register(struct request_queue *q);
	81	extern void blk_mq_sysfs_unregister(struct request_queue *q);
868f2f0b	82	extern void blk_mq_hctx_kobj_init(struct blk_mq_hw_ctx *hctx);
67aec14c	83
07e4fead OS	84	/*
	85	* debugfs helpers
	86	*/
400f73b2	87	#ifdef CONFIG_BLK_DEBUG_FS
07e4fead OS	88	int blk_mq_debugfs_register(struct request_queue q, const char name);
	89	void blk_mq_debugfs_unregister(struct request_queue *q);
	90	int blk_mq_debugfs_register_hctxs(struct request_queue *q);
	91	void blk_mq_debugfs_unregister_hctxs(struct request_queue *q);
	92	#else
400f73b2 OS	93	static inline int blk_mq_debugfs_register(struct request_queue *q,
400f73b2 OS	94	const char *name)
07e4fead OS	95	{
	96	return 0;
	97	}
	98
400f73b2	99	static inline void blk_mq_debugfs_unregister(struct request_queue *q)
07e4fead OS	100	{
	101	}
	102
400f73b2	103	static inline int blk_mq_debugfs_register_hctxs(struct request_queue *q)
07e4fead OS	104	{
	105	return 0;
	106	}
	107
400f73b2	108	static inline void blk_mq_debugfs_unregister_hctxs(struct request_queue *q)
07e4fead OS	109	{
	110	}
	111	#endif
	112
90415837 CH	113	extern void blk_mq_rq_timed_out(struct request *req, bool reserved);
90415837 CH	114
e09aae7e ML	115	void blk_mq_release(struct request_queue *q);
e09aae7e ML	116
1aecfe48 ML	117	static inline struct blk_mq_ctx __blk_mq_get_ctx(struct request_queue q,
	118	unsigned int cpu)
	119	{
	120	return per_cpu_ptr(q->queue_ctx, cpu);
	121	}
	122
	123	/*
	124	* This assumes per-cpu software queueing queues. They could be per-node
	125	* as well, for instance. For now this is hardcoded as-is. Note that we don't
	126	* care about preemption, since we know the ctx's are persistent. This does
	127	* mean that we can't rely on ctx always matching the currently running CPU.
	128	*/
	129	static inline struct blk_mq_ctx blk_mq_get_ctx(struct request_queue q)
	130	{
	131	return __blk_mq_get_ctx(q, get_cpu());
	132	}
	133
	134	static inline void blk_mq_put_ctx(struct blk_mq_ctx *ctx)
	135	{
	136	put_cpu();
	137	}
	138
cb96a42c ML	139	struct blk_mq_alloc_data {
	140	/* input parameter */
	141	struct request_queue *q;
6f3b0e8b	142	unsigned int flags;
cb96a42c ML	143
	144	/* input & output parameter */
	145	struct blk_mq_ctx *ctx;
	146	struct blk_mq_hw_ctx *hctx;
	147	};
	148
4941115b JA	149	static inline struct blk_mq_tags blk_mq_tags_from_data(struct blk_mq_alloc_data data)
4941115b JA	150	{
bd166ef1 JA	151	if (data->flags & BLK_MQ_REQ_INTERNAL)
	152	return data->hctx->sched_tags;
	153
4941115b JA	154	return data->hctx->tags;
	155	}
	156
2c3ad667 JA	157	/*
	158	* Internal helpers for request allocation/init/free
	159	*/
	160	void blk_mq_rq_ctx_init(struct request_queue q, struct blk_mq_ctx ctx,
	161	struct request *rq, unsigned int op);
bd166ef1	162	void __blk_mq_finish_request(struct blk_mq_hw_ctx hctx, struct blk_mq_ctx ctx,
2c3ad667	163	struct request *rq);
bd166ef1	164	void blk_mq_finish_request(struct request *rq);
2c3ad667 JA	165	struct request __blk_mq_alloc_request(struct blk_mq_alloc_data data,
	166	unsigned int op);
	167
5d1b25c1 BVA	168	static inline bool blk_mq_hctx_stopped(struct blk_mq_hw_ctx *hctx)
	169	{
	170	return test_bit(BLK_MQ_S_STOPPED, &hctx->state);
	171	}
	172
19c66e59 ML	173	static inline bool blk_mq_hw_queue_mapped(struct blk_mq_hw_ctx *hctx)
	174	{
	175	return hctx->nr_ctx && hctx->tags;
	176	}
	177
320ae51f	178	#endif