[thirdparty/kernel/stable.git] / block / blk-mq.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef INT_BLK_MQ_H
#define INT_BLK_MQ_H

#include "blk-stat.h"
#include "blk-mq-tag.h"

struct blk_mq_tag_set;

struct blk_mq_ctxs {
	struct kobject kobj;
	struct blk_mq_ctx __percpu	*queue_ctx;
};

/**
 * struct blk_mq_ctx - State for a software queue facing the submitting CPUs
 */
struct blk_mq_ctx {
	struct {
		spinlock_t		lock;
		struct list_head	rq_lists[HCTX_MAX_TYPES];
	} ____cacheline_aligned_in_smp;

	unsigned int		cpu;
	unsigned short		index_hw[HCTX_MAX_TYPES];
	struct blk_mq_hw_ctx 	*hctxs[HCTX_MAX_TYPES];

	/* 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 request_queue	*queue;
	struct blk_mq_ctxs      *ctxs;
	struct kobject		kobj;
} ____cacheline_aligned_in_smp;

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 request_queue *, struct list_head *, bool);
void blk_mq_add_to_requeue_list(struct request *rq, bool at_head,
				bool kick_requeue_list);
void blk_mq_flush_busy_ctxs(struct blk_mq_hw_ctx *hctx, struct list_head *list);
bool blk_mq_get_driver_tag(struct request *rq);
struct request *blk_mq_dequeue_from_ctx(struct blk_mq_hw_ctx *hctx,
					struct blk_mq_ctx *start);

/*
 * 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_request_bypass_insert(struct request *rq, bool run_queue);
void blk_mq_insert_requests(struct blk_mq_hw_ctx *hctx, struct blk_mq_ctx *ctx,
				struct list_head *list);

/* Used by blk_insert_cloned_request() to issue request directly */
blk_status_t blk_mq_request_issue_directly(struct request *rq, bool last);
void blk_mq_try_issue_list_directly(struct blk_mq_hw_ctx *hctx,
				    struct list_head *list);

/*
 * CPU -> queue mappings
 */
extern int blk_mq_hw_queue_to_node(struct blk_mq_queue_map *qmap, unsigned int);

/*
 * blk_mq_map_queue_type() - map (hctx_type,cpu) to hardware queue
 * @q: request queue
 * @type: the hctx type index
 * @cpu: CPU
 */
static inline struct blk_mq_hw_ctx *blk_mq_map_queue_type(struct request_queue *q,
							  enum hctx_type type,
							  unsigned int cpu)
{
	return q->queue_hw_ctx[q->tag_set->map[type].mq_map[cpu]];
}

/*
 * blk_mq_map_queue() - map (cmd_flags,type) to hardware queue
 * @q: request queue
 * @flags: request command flags
 * @cpu: cpu ctx
 */
static inline struct blk_mq_hw_ctx *blk_mq_map_queue(struct request_queue *q,
						     unsigned int flags,
						     struct blk_mq_ctx *ctx)
{
	enum hctx_type type = HCTX_TYPE_DEFAULT;

	/*
	 * The caller ensure that if REQ_HIPRI, poll must be enabled.
	 */
	if (flags & REQ_HIPRI)
		type = HCTX_TYPE_POLL;
	else if ((flags & REQ_OP_MASK) == REQ_OP_READ)
		type = HCTX_TYPE_READ;
	
	return ctx->hctxs[type];
}

/*
 * sysfs helpers
 */
extern void blk_mq_sysfs_init(struct request_queue *q);
extern void blk_mq_sysfs_deinit(struct request_queue *q);
extern int __blk_mq_register_dev(struct device *dev, struct request_queue *q);
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);

void blk_mq_release(struct request_queue *q);

/**
 * blk_mq_rq_state() - read the current MQ_RQ_* state of a request
 * @rq: target request.
 */
static inline enum mq_rq_state blk_mq_rq_state(struct request *rq)
{
	return READ_ONCE(rq->state);
}

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;
	blk_mq_req_flags_t flags;
	unsigned int shallow_depth;
	unsigned int cmd_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;
}

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

unsigned int blk_mq_in_flight(struct request_queue *q, struct hd_struct *part);
void blk_mq_in_flight_rw(struct request_queue *q, struct hd_struct *part,
			 unsigned int inflight[2]);

static inline void blk_mq_put_dispatch_budget(struct blk_mq_hw_ctx *hctx)
{
	struct request_queue *q = hctx->queue;

	if (q->mq_ops->put_budget)
		q->mq_ops->put_budget(hctx);
}

static inline bool blk_mq_get_dispatch_budget(struct blk_mq_hw_ctx *hctx)
{
	struct request_queue *q = hctx->queue;

	if (q->mq_ops->get_budget)
		return q->mq_ops->get_budget(hctx);
	return true;
}

static inline void __blk_mq_put_driver_tag(struct blk_mq_hw_ctx *hctx,
					   struct request *rq)
{
	blk_mq_put_tag(hctx, hctx->tags, rq->mq_ctx, rq->tag);
	rq->tag = -1;

	if (rq->rq_flags & RQF_MQ_INFLIGHT) {
		rq->rq_flags &= ~RQF_MQ_INFLIGHT;
		atomic_dec(&hctx->nr_active);
	}
}

static inline void blk_mq_put_driver_tag(struct request *rq)
{
	if (rq->tag == -1 || rq->internal_tag == -1)
		return;

	__blk_mq_put_driver_tag(rq->mq_hctx, rq);
}

static inline void blk_mq_clear_mq_map(struct blk_mq_queue_map *qmap)
{
	int cpu;

	for_each_possible_cpu(cpu)
		qmap->mq_map[cpu] = 0;
}

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
320ae51f JA	2	#ifndef INT_BLK_MQ_H
	3	#define INT_BLK_MQ_H
	4
cf43e6be	5	#include "blk-stat.h"
244c65a3	6	#include "blk-mq-tag.h"
cf43e6be	7
24d2f903 CH	8	struct blk_mq_tag_set;
24d2f903 CH	9
1db4909e ML	10	struct blk_mq_ctxs {
	11	struct kobject kobj;
	12	struct blk_mq_ctx __percpu *queue_ctx;
	13	};
	14
fe644072 LW	15	/**
	16	* struct blk_mq_ctx - State for a software queue facing the submitting CPUs
	17	*/
320ae51f JA	18	struct blk_mq_ctx {
	19	struct {
	20	spinlock_t lock;
c16d6b5a ML	21	struct list_head rq_lists[HCTX_MAX_TYPES];
c16d6b5a ML	22	} ____cacheline_aligned_in_smp;
320ae51f JA	23
320ae51f JA	24	unsigned int cpu;
f31967f0	25	unsigned short index_hw[HCTX_MAX_TYPES];
8ccdf4a3	26	struct blk_mq_hw_ctx *hctxs[HCTX_MAX_TYPES];
320ae51f JA	27
	28	/* incremented at dispatch time */
	29	unsigned long rq_dispatched[2];
	30	unsigned long rq_merged;
	31
	32	/* incremented at completion time */
	33	unsigned long ____cacheline_aligned_in_smp rq_completed[2];
	34
	35	struct request_queue *queue;
1db4909e	36	struct blk_mq_ctxs *ctxs;
320ae51f	37	struct kobject kobj;
4bb659b1	38	} ____cacheline_aligned_in_smp;
320ae51f	39
3edcc0ce	40	void blk_mq_free_queue(struct request_queue *q);
e3a2b3f9	41	int blk_mq_update_nr_requests(struct request_queue *q, unsigned int nr);
aed3ea94	42	void blk_mq_wake_waiters(struct request_queue *q);
de148297	43	bool blk_mq_dispatch_rq_list(struct request_queue , struct list_head , bool);
e6c98712 BVA	44	void blk_mq_add_to_requeue_list(struct request *rq, bool at_head,
e6c98712 BVA	45	bool kick_requeue_list);
2c3ad667	46	void blk_mq_flush_busy_ctxs(struct blk_mq_hw_ctx hctx, struct list_head list);
8ab6bb9e	47	bool blk_mq_get_driver_tag(struct request *rq);
b347689f ML	48	struct request blk_mq_dequeue_from_ctx(struct blk_mq_hw_ctx hctx,
b347689f ML	49	struct blk_mq_ctx *start);
2c3ad667 JA	50
	51	/*
	52	* Internal helpers for allocating/freeing the request map
	53	*/
cc71a6f4 JA	54	void blk_mq_free_rqs(struct blk_mq_tag_set set, struct blk_mq_tags tags,
	55	unsigned int hctx_idx);
	56	void blk_mq_free_rq_map(struct blk_mq_tags *tags);
	57	struct blk_mq_tags blk_mq_alloc_rq_map(struct blk_mq_tag_set set,
	58	unsigned int hctx_idx,
	59	unsigned int nr_tags,
	60	unsigned int reserved_tags);
	61	int blk_mq_alloc_rqs(struct blk_mq_tag_set set, struct blk_mq_tags tags,
	62	unsigned int hctx_idx, unsigned int depth);
2c3ad667 JA	63
	64	/*
	65	* Internal helpers for request insertion into sw queues
	66	*/
	67	void __blk_mq_insert_request(struct blk_mq_hw_ctx hctx, struct request rq,
	68	bool at_head);
b0850297	69	void blk_mq_request_bypass_insert(struct request *rq, bool run_queue);
bd166ef1 JA	70	void blk_mq_insert_requests(struct blk_mq_hw_ctx hctx, struct blk_mq_ctx ctx,
bd166ef1 JA	71	struct list_head *list);
320ae51f	72
fd9c40f6 BVA	73	/* Used by blk_insert_cloned_request() to issue request directly */
fd9c40f6 BVA	74	blk_status_t blk_mq_request_issue_directly(struct request *rq, bool last);
6ce3dd6e ML	75	void blk_mq_try_issue_list_directly(struct blk_mq_hw_ctx *hctx,
6ce3dd6e ML	76	struct list_head *list);
396eaf21	77
320ae51f JA	78	/*
	79	* CPU -> queue mappings
	80	*/
ed76e329	81	extern int blk_mq_hw_queue_to_node(struct blk_mq_queue_map *qmap, unsigned int);
320ae51f	82
b3c661b1 JA	83	/*
	84	* blk_mq_map_queue_type() - map (hctx_type,cpu) to hardware queue
	85	* @q: request queue
e20ba6e1	86	* @type: the hctx type index
b3c661b1 JA	87	* @cpu: CPU
	88	*/
	89	static inline struct blk_mq_hw_ctx blk_mq_map_queue_type(struct request_queue q,
e20ba6e1	90	enum hctx_type type,
b3c661b1	91	unsigned int cpu)
7d7e0f90	92	{
e20ba6e1	93	return q->queue_hw_ctx[q->tag_set->map[type].mq_map[cpu]];
7d7e0f90 CH	94	}
7d7e0f90 CH	95
b3c661b1 JA	96	/*
	97	* blk_mq_map_queue() - map (cmd_flags,type) to hardware queue
	98	* @q: request queue
	99	* @flags: request command flags
8ccdf4a3	100	* @cpu: cpu ctx
b3c661b1 JA	101	*/
	102	static inline struct blk_mq_hw_ctx blk_mq_map_queue(struct request_queue q,
	103	unsigned int flags,
8ccdf4a3	104	struct blk_mq_ctx *ctx)
ff2c5660	105	{
e20ba6e1 CH	106	enum hctx_type type = HCTX_TYPE_DEFAULT;
e20ba6e1 CH	107
bb94aea1 JW	108	/*
	109	* The caller ensure that if REQ_HIPRI, poll must be enabled.
	110	*/
	111	if (flags & REQ_HIPRI)
e20ba6e1	112	type = HCTX_TYPE_POLL;
bb94aea1	113	else if ((flags & REQ_OP_MASK) == REQ_OP_READ)
e20ba6e1	114	type = HCTX_TYPE_READ;
5aceaeb2	115
8ccdf4a3	116	return ctx->hctxs[type];
ff2c5660 JA	117	}
ff2c5660 JA	118
67aec14c JA	119	/*
	120	* sysfs helpers
	121	*/
737f98cf	122	extern void blk_mq_sysfs_init(struct request_queue *q);
7ea5fe31	123	extern void blk_mq_sysfs_deinit(struct request_queue *q);
2d0364c8	124	extern int __blk_mq_register_dev(struct device dev, struct request_queue q);
67aec14c JA	125	extern int blk_mq_sysfs_register(struct request_queue *q);
67aec14c JA	126	extern void blk_mq_sysfs_unregister(struct request_queue *q);
868f2f0b	127	extern void blk_mq_hctx_kobj_init(struct blk_mq_hw_ctx *hctx);
67aec14c	128
e09aae7e ML	129	void blk_mq_release(struct request_queue *q);
e09aae7e ML	130
1d9bd516 TH	131	/**
	132	* blk_mq_rq_state() - read the current MQ_RQ_* state of a request
	133	* @rq: target request.
	134	*/
12f5b931	135	static inline enum mq_rq_state blk_mq_rq_state(struct request *rq)
1d9bd516	136	{
12f5b931	137	return READ_ONCE(rq->state);
1d9bd516 TH	138	}
1d9bd516 TH	139
1aecfe48 ML	140	static inline struct blk_mq_ctx __blk_mq_get_ctx(struct request_queue q,
	141	unsigned int cpu)
	142	{
	143	return per_cpu_ptr(q->queue_ctx, cpu);
	144	}
	145
	146	/*
	147	* This assumes per-cpu software queueing queues. They could be per-node
	148	* as well, for instance. For now this is hardcoded as-is. Note that we don't
	149	* care about preemption, since we know the ctx's are persistent. This does
	150	* mean that we can't rely on ctx always matching the currently running CPU.
	151	*/
	152	static inline struct blk_mq_ctx blk_mq_get_ctx(struct request_queue q)
	153	{
	154	return __blk_mq_get_ctx(q, get_cpu());
	155	}
	156
	157	static inline void blk_mq_put_ctx(struct blk_mq_ctx *ctx)
	158	{
	159	put_cpu();
	160	}
	161
cb96a42c ML	162	struct blk_mq_alloc_data {
	163	/* input parameter */
	164	struct request_queue *q;
9a95e4ef	165	blk_mq_req_flags_t flags;
229a9287	166	unsigned int shallow_depth;
f9afca4d	167	unsigned int cmd_flags;
cb96a42c ML	168
	169	/* input & output parameter */
	170	struct blk_mq_ctx *ctx;
	171	struct blk_mq_hw_ctx *hctx;
	172	};
	173
4941115b JA	174	static inline struct blk_mq_tags blk_mq_tags_from_data(struct blk_mq_alloc_data data)
4941115b JA	175	{
bd166ef1 JA	176	if (data->flags & BLK_MQ_REQ_INTERNAL)
	177	return data->hctx->sched_tags;
	178
4941115b JA	179	return data->hctx->tags;
	180	}
	181
5d1b25c1 BVA	182	static inline bool blk_mq_hctx_stopped(struct blk_mq_hw_ctx *hctx)
	183	{
	184	return test_bit(BLK_MQ_S_STOPPED, &hctx->state);
	185	}
	186
19c66e59 ML	187	static inline bool blk_mq_hw_queue_mapped(struct blk_mq_hw_ctx *hctx)
	188	{
	189	return hctx->nr_ctx && hctx->tags;
	190	}
	191
e016b782	192	unsigned int blk_mq_in_flight(struct request_queue q, struct hd_struct part);
bf0ddaba OS	193	void blk_mq_in_flight_rw(struct request_queue q, struct hd_struct part,
bf0ddaba OS	194	unsigned int inflight[2]);
f299b7c7	195
de148297 ML	196	static inline void blk_mq_put_dispatch_budget(struct blk_mq_hw_ctx *hctx)
	197	{
	198	struct request_queue *q = hctx->queue;
	199
	200	if (q->mq_ops->put_budget)
	201	q->mq_ops->put_budget(hctx);
	202	}
	203
88022d72	204	static inline bool blk_mq_get_dispatch_budget(struct blk_mq_hw_ctx *hctx)
de148297 ML	205	{
	206	struct request_queue *q = hctx->queue;
	207
	208	if (q->mq_ops->get_budget)
	209	return q->mq_ops->get_budget(hctx);
88022d72	210	return true;
de148297 ML	211	}
de148297 ML	212
244c65a3 ML	213	static inline void __blk_mq_put_driver_tag(struct blk_mq_hw_ctx *hctx,
	214	struct request *rq)
	215	{
	216	blk_mq_put_tag(hctx, hctx->tags, rq->mq_ctx, rq->tag);
	217	rq->tag = -1;
	218
	219	if (rq->rq_flags & RQF_MQ_INFLIGHT) {
	220	rq->rq_flags &= ~RQF_MQ_INFLIGHT;
	221	atomic_dec(&hctx->nr_active);
	222	}
	223	}
	224
244c65a3 ML	225	static inline void blk_mq_put_driver_tag(struct request *rq)
244c65a3 ML	226	{
244c65a3 ML	227	if (rq->tag == -1 \|\| rq->internal_tag == -1)
	228	return;
	229
ea4f995e	230	__blk_mq_put_driver_tag(rq->mq_hctx, rq);
244c65a3 ML	231	}
244c65a3 ML	232
ed76e329	233	static inline void blk_mq_clear_mq_map(struct blk_mq_queue_map *qmap)
0da73d00 MI	234	{
	235	int cpu;
	236
	237	for_each_possible_cpu(cpu)
ed76e329	238	qmap->mq_map[cpu] = 0;
0da73d00 MI	239	}
0da73d00 MI	240
320ae51f	241	#endif