[linux-block.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_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 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 request_queue	*queue;
	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);

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

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

void blk_mq_in_flight(struct request_queue *q, struct hd_struct *part,
		      unsigned int inflight[2]);
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)
{
	struct blk_mq_hw_ctx *hctx;

	if (rq->tag == -1 || rq->internal_tag == -1)
		return;

	hctx = blk_mq_map_queue(rq->q, rq->mq_ctx->cpu);
	__blk_mq_put_driver_tag(hctx, rq);
}

#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
fe644072 LW	10	/**
	11	* struct blk_mq_ctx - State for a software queue facing the submitting CPUs
	12	*/
320ae51f JA	13	struct blk_mq_ctx {
	14	struct {
	15	spinlock_t lock;
	16	struct list_head rq_list;
	17	} ____cacheline_aligned_in_smp;
	18
	19	unsigned int cpu;
	20	unsigned int index_hw;
320ae51f JA	21
	22	/* incremented at dispatch time */
	23	unsigned long rq_dispatched[2];
	24	unsigned long rq_merged;
	25
	26	/* incremented at completion time */
	27	unsigned long ____cacheline_aligned_in_smp rq_completed[2];
	28
	29	struct request_queue *queue;
	30	struct kobject kobj;
4bb659b1	31	} ____cacheline_aligned_in_smp;
320ae51f	32
780db207	33	void blk_mq_freeze_queue(struct request_queue *q);
3edcc0ce	34	void blk_mq_free_queue(struct request_queue *q);
e3a2b3f9	35	int blk_mq_update_nr_requests(struct request_queue *q, unsigned int nr);
aed3ea94	36	void blk_mq_wake_waiters(struct request_queue *q);
de148297	37	bool blk_mq_dispatch_rq_list(struct request_queue , struct list_head , bool);
2c3ad667	38	void blk_mq_flush_busy_ctxs(struct blk_mq_hw_ctx hctx, struct list_head list);
8ab6bb9e	39	bool blk_mq_get_driver_tag(struct request *rq);
b347689f ML	40	struct request blk_mq_dequeue_from_ctx(struct blk_mq_hw_ctx hctx,
b347689f ML	41	struct blk_mq_ctx *start);
2c3ad667 JA	42
	43	/*
	44	* Internal helpers for allocating/freeing the request map
	45	*/
cc71a6f4 JA	46	void blk_mq_free_rqs(struct blk_mq_tag_set set, struct blk_mq_tags tags,
	47	unsigned int hctx_idx);
	48	void blk_mq_free_rq_map(struct blk_mq_tags *tags);
	49	struct blk_mq_tags blk_mq_alloc_rq_map(struct blk_mq_tag_set set,
	50	unsigned int hctx_idx,
	51	unsigned int nr_tags,
	52	unsigned int reserved_tags);
	53	int blk_mq_alloc_rqs(struct blk_mq_tag_set set, struct blk_mq_tags tags,
	54	unsigned int hctx_idx, unsigned int depth);
2c3ad667 JA	55
	56	/*
	57	* Internal helpers for request insertion into sw queues
	58	*/
	59	void __blk_mq_insert_request(struct blk_mq_hw_ctx hctx, struct request rq,
	60	bool at_head);
b0850297	61	void blk_mq_request_bypass_insert(struct request *rq, bool run_queue);
bd166ef1 JA	62	void blk_mq_insert_requests(struct blk_mq_hw_ctx hctx, struct blk_mq_ctx ctx,
bd166ef1 JA	63	struct list_head *list);
320ae51f	64
396eaf21	65	/* Used by blk_insert_cloned_request() to issue request directly */
c77ff7fd	66	blk_status_t blk_mq_request_issue_directly(struct request *rq);
396eaf21	67
320ae51f JA	68	/*
	69	* CPU -> queue mappings
	70	*/
f14bbe77	71	extern int blk_mq_hw_queue_to_node(unsigned int *map, unsigned int);
320ae51f	72
7d7e0f90 CH	73	static inline struct blk_mq_hw_ctx blk_mq_map_queue(struct request_queue q,
	74	int cpu)
	75	{
	76	return q->queue_hw_ctx[q->mq_map[cpu]];
	77	}
	78
67aec14c JA	79	/*
	80	* sysfs helpers
	81	*/
737f98cf	82	extern void blk_mq_sysfs_init(struct request_queue *q);
7ea5fe31	83	extern void blk_mq_sysfs_deinit(struct request_queue *q);
2d0364c8	84	extern int __blk_mq_register_dev(struct device dev, struct request_queue q);
67aec14c JA	85	extern int blk_mq_sysfs_register(struct request_queue *q);
67aec14c JA	86	extern void blk_mq_sysfs_unregister(struct request_queue *q);
868f2f0b	87	extern void blk_mq_hctx_kobj_init(struct blk_mq_hw_ctx *hctx);
67aec14c	88
e09aae7e ML	89	void blk_mq_release(struct request_queue *q);
e09aae7e ML	90
1d9bd516 TH	91	/**
	92	* blk_mq_rq_state() - read the current MQ_RQ_* state of a request
	93	* @rq: target request.
	94	*/
12f5b931	95	static inline enum mq_rq_state blk_mq_rq_state(struct request *rq)
1d9bd516	96	{
12f5b931	97	return READ_ONCE(rq->state);
1d9bd516 TH	98	}
1d9bd516 TH	99
1aecfe48 ML	100	static inline struct blk_mq_ctx __blk_mq_get_ctx(struct request_queue q,
	101	unsigned int cpu)
	102	{
	103	return per_cpu_ptr(q->queue_ctx, cpu);
	104	}
	105
	106	/*
	107	* This assumes per-cpu software queueing queues. They could be per-node
	108	* as well, for instance. For now this is hardcoded as-is. Note that we don't
	109	* care about preemption, since we know the ctx's are persistent. This does
	110	* mean that we can't rely on ctx always matching the currently running CPU.
	111	*/
	112	static inline struct blk_mq_ctx blk_mq_get_ctx(struct request_queue q)
	113	{
	114	return __blk_mq_get_ctx(q, get_cpu());
	115	}
	116
	117	static inline void blk_mq_put_ctx(struct blk_mq_ctx *ctx)
	118	{
	119	put_cpu();
	120	}
	121
cb96a42c ML	122	struct blk_mq_alloc_data {
	123	/* input parameter */
	124	struct request_queue *q;
9a95e4ef	125	blk_mq_req_flags_t flags;
229a9287	126	unsigned int shallow_depth;
cb96a42c ML	127
	128	/* input & output parameter */
	129	struct blk_mq_ctx *ctx;
	130	struct blk_mq_hw_ctx *hctx;
	131	};
	132
4941115b JA	133	static inline struct blk_mq_tags blk_mq_tags_from_data(struct blk_mq_alloc_data data)
4941115b JA	134	{
bd166ef1 JA	135	if (data->flags & BLK_MQ_REQ_INTERNAL)
	136	return data->hctx->sched_tags;
	137
4941115b JA	138	return data->hctx->tags;
	139	}
	140
5d1b25c1 BVA	141	static inline bool blk_mq_hctx_stopped(struct blk_mq_hw_ctx *hctx)
	142	{
	143	return test_bit(BLK_MQ_S_STOPPED, &hctx->state);
	144	}
	145
19c66e59 ML	146	static inline bool blk_mq_hw_queue_mapped(struct blk_mq_hw_ctx *hctx)
	147	{
	148	return hctx->nr_ctx && hctx->tags;
	149	}
	150
f299b7c7	151	void blk_mq_in_flight(struct request_queue q, struct hd_struct part,
bf0ddaba OS	152	unsigned int inflight[2]);
	153	void blk_mq_in_flight_rw(struct request_queue q, struct hd_struct part,
	154	unsigned int inflight[2]);
f299b7c7	155
de148297 ML	156	static inline void blk_mq_put_dispatch_budget(struct blk_mq_hw_ctx *hctx)
	157	{
	158	struct request_queue *q = hctx->queue;
	159
	160	if (q->mq_ops->put_budget)
	161	q->mq_ops->put_budget(hctx);
	162	}
	163
88022d72	164	static inline bool blk_mq_get_dispatch_budget(struct blk_mq_hw_ctx *hctx)
de148297 ML	165	{
	166	struct request_queue *q = hctx->queue;
	167
	168	if (q->mq_ops->get_budget)
	169	return q->mq_ops->get_budget(hctx);
88022d72	170	return true;
de148297 ML	171	}
de148297 ML	172
244c65a3 ML	173	static inline void __blk_mq_put_driver_tag(struct blk_mq_hw_ctx *hctx,
	174	struct request *rq)
	175	{
	176	blk_mq_put_tag(hctx, hctx->tags, rq->mq_ctx, rq->tag);
	177	rq->tag = -1;
	178
	179	if (rq->rq_flags & RQF_MQ_INFLIGHT) {
	180	rq->rq_flags &= ~RQF_MQ_INFLIGHT;
	181	atomic_dec(&hctx->nr_active);
	182	}
	183	}
	184
	185	static inline void blk_mq_put_driver_tag_hctx(struct blk_mq_hw_ctx *hctx,
	186	struct request *rq)
	187	{
	188	if (rq->tag == -1 \|\| rq->internal_tag == -1)
	189	return;
	190
	191	__blk_mq_put_driver_tag(hctx, rq);
	192	}
	193
	194	static inline void blk_mq_put_driver_tag(struct request *rq)
	195	{
	196	struct blk_mq_hw_ctx *hctx;
	197
	198	if (rq->tag == -1 \|\| rq->internal_tag == -1)
	199	return;
	200
	201	hctx = blk_mq_map_queue(rq->q, rq->mq_ctx->cpu);
	202	__blk_mq_put_driver_tag(hctx, rq);
	203	}
	204
320ae51f	205	#endif