[linux.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 {
	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 blk_mq_hw_ctx **hctx,
				bool wait);
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);

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

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;
	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]);

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