[mirror_ubuntu-jammy-kernel.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_list;
	}  ____cacheline_aligned_in_smp;

	unsigned int		cpu;
	unsigned short		index_hw[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_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 request_queue *, struct list_head *, bool);
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
 */
static inline struct blk_mq_hw_ctx *blk_mq_map_queue(struct request_queue *q,
						     unsigned int flags,
						     unsigned int cpu)
{
	enum hctx_type type = HCTX_TYPE_DEFAULT;

	if (q->tag_set->nr_maps > HCTX_TYPE_POLL &&
	    ((flags & REQ_HIPRI) && test_bit(QUEUE_FLAG_POLL, &q->queue_flags)))
		type = HCTX_TYPE_POLL;

	else if (q->tag_set->nr_maps > HCTX_TYPE_READ &&
		 ((flags & REQ_OP_MASK) == REQ_OP_READ))
		type = HCTX_TYPE_READ;

	return blk_mq_map_queue_type(q, type, cpu);
}

/*
 * 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_hctx(struct blk_mq_hw_ctx *hctx,
				       struct request *rq)
{
	if (rq->tag == -1 || rq->internal_tag == -1)
		return;

	__blk_mq_put_driver_tag(hctx, rq);
}

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