Commit | Line | Data |
---|---|---|
3dcf60bc | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
a7905043 JB |
2 | #ifndef RQ_QOS_H |
3 | #define RQ_QOS_H | |
4 | ||
5 | #include <linux/kernel.h> | |
6 | #include <linux/blkdev.h> | |
7 | #include <linux/blk_types.h> | |
8 | #include <linux/atomic.h> | |
9 | #include <linux/wait.h> | |
10 | ||
cc56694f ML |
11 | #include "blk-mq-debugfs.h" |
12 | ||
13 | struct blk_mq_debugfs_attr; | |
14 | ||
a7905043 JB |
15 | enum rq_qos_id { |
16 | RQ_QOS_WBT, | |
beab17fc | 17 | RQ_QOS_LATENCY, |
a7905043 JB |
18 | }; |
19 | ||
20 | struct rq_wait { | |
21 | wait_queue_head_t wait; | |
22 | atomic_t inflight; | |
23 | }; | |
24 | ||
25 | struct rq_qos { | |
26 | struct rq_qos_ops *ops; | |
27 | struct request_queue *q; | |
28 | enum rq_qos_id id; | |
29 | struct rq_qos *next; | |
cc56694f ML |
30 | #ifdef CONFIG_BLK_DEBUG_FS |
31 | struct dentry *debugfs_dir; | |
32 | #endif | |
a7905043 JB |
33 | }; |
34 | ||
35 | struct rq_qos_ops { | |
d5337560 | 36 | void (*throttle)(struct rq_qos *, struct bio *); |
c1c80384 | 37 | void (*track)(struct rq_qos *, struct request *, struct bio *); |
d3e65fff | 38 | void (*merge)(struct rq_qos *, struct request *, struct bio *); |
a7905043 JB |
39 | void (*issue)(struct rq_qos *, struct request *); |
40 | void (*requeue)(struct rq_qos *, struct request *); | |
41 | void (*done)(struct rq_qos *, struct request *); | |
67b42d0b | 42 | void (*done_bio)(struct rq_qos *, struct bio *); |
c1c80384 | 43 | void (*cleanup)(struct rq_qos *, struct bio *); |
9677a3e0 | 44 | void (*queue_depth_changed)(struct rq_qos *); |
a7905043 | 45 | void (*exit)(struct rq_qos *); |
cc56694f | 46 | const struct blk_mq_debugfs_attr *debugfs_attrs; |
a7905043 JB |
47 | }; |
48 | ||
49 | struct rq_depth { | |
50 | unsigned int max_depth; | |
51 | ||
52 | int scale_step; | |
53 | bool scaled_max; | |
54 | ||
55 | unsigned int queue_depth; | |
56 | unsigned int default_depth; | |
57 | }; | |
58 | ||
59 | static inline struct rq_qos *rq_qos_id(struct request_queue *q, | |
60 | enum rq_qos_id id) | |
61 | { | |
62 | struct rq_qos *rqos; | |
63 | for (rqos = q->rq_qos; rqos; rqos = rqos->next) { | |
64 | if (rqos->id == id) | |
65 | break; | |
66 | } | |
67 | return rqos; | |
68 | } | |
69 | ||
70 | static inline struct rq_qos *wbt_rq_qos(struct request_queue *q) | |
71 | { | |
72 | return rq_qos_id(q, RQ_QOS_WBT); | |
73 | } | |
74 | ||
75 | static inline struct rq_qos *blkcg_rq_qos(struct request_queue *q) | |
76 | { | |
beab17fc | 77 | return rq_qos_id(q, RQ_QOS_LATENCY); |
a7905043 JB |
78 | } |
79 | ||
cc56694f ML |
80 | static inline const char *rq_qos_id_to_name(enum rq_qos_id id) |
81 | { | |
82 | switch (id) { | |
83 | case RQ_QOS_WBT: | |
84 | return "wbt"; | |
beab17fc TH |
85 | case RQ_QOS_LATENCY: |
86 | return "latency"; | |
cc56694f ML |
87 | } |
88 | return "unknown"; | |
89 | } | |
90 | ||
a7905043 JB |
91 | static inline void rq_wait_init(struct rq_wait *rq_wait) |
92 | { | |
93 | atomic_set(&rq_wait->inflight, 0); | |
94 | init_waitqueue_head(&rq_wait->wait); | |
95 | } | |
96 | ||
97 | static inline void rq_qos_add(struct request_queue *q, struct rq_qos *rqos) | |
98 | { | |
99 | rqos->next = q->rq_qos; | |
100 | q->rq_qos = rqos; | |
cc56694f ML |
101 | |
102 | if (rqos->ops->debugfs_attrs) | |
103 | blk_mq_debugfs_register_rqos(rqos); | |
a7905043 JB |
104 | } |
105 | ||
106 | static inline void rq_qos_del(struct request_queue *q, struct rq_qos *rqos) | |
107 | { | |
108 | struct rq_qos *cur, *prev = NULL; | |
109 | for (cur = q->rq_qos; cur; cur = cur->next) { | |
110 | if (cur == rqos) { | |
111 | if (prev) | |
112 | prev->next = rqos->next; | |
113 | else | |
114 | q->rq_qos = cur; | |
115 | break; | |
116 | } | |
117 | prev = cur; | |
118 | } | |
cc56694f ML |
119 | |
120 | blk_mq_debugfs_unregister_rqos(rqos); | |
a7905043 JB |
121 | } |
122 | ||
84f60324 JB |
123 | typedef bool (acquire_inflight_cb_t)(struct rq_wait *rqw, void *private_data); |
124 | typedef void (cleanup_cb_t)(struct rq_wait *rqw, void *private_data); | |
125 | ||
126 | void rq_qos_wait(struct rq_wait *rqw, void *private_data, | |
127 | acquire_inflight_cb_t *acquire_inflight_cb, | |
128 | cleanup_cb_t *cleanup_cb); | |
22f17952 | 129 | bool rq_wait_inc_below(struct rq_wait *rq_wait, unsigned int limit); |
a7905043 JB |
130 | void rq_depth_scale_up(struct rq_depth *rqd); |
131 | void rq_depth_scale_down(struct rq_depth *rqd, bool hard_throttle); | |
132 | bool rq_depth_calc_max_depth(struct rq_depth *rqd); | |
133 | ||
e5045454 JA |
134 | void __rq_qos_cleanup(struct rq_qos *rqos, struct bio *bio); |
135 | void __rq_qos_done(struct rq_qos *rqos, struct request *rq); | |
136 | void __rq_qos_issue(struct rq_qos *rqos, struct request *rq); | |
137 | void __rq_qos_requeue(struct rq_qos *rqos, struct request *rq); | |
138 | void __rq_qos_throttle(struct rq_qos *rqos, struct bio *bio); | |
139 | void __rq_qos_track(struct rq_qos *rqos, struct request *rq, struct bio *bio); | |
d3e65fff | 140 | void __rq_qos_merge(struct rq_qos *rqos, struct request *rq, struct bio *bio); |
e5045454 | 141 | void __rq_qos_done_bio(struct rq_qos *rqos, struct bio *bio); |
9677a3e0 | 142 | void __rq_qos_queue_depth_changed(struct rq_qos *rqos); |
e5045454 JA |
143 | |
144 | static inline void rq_qos_cleanup(struct request_queue *q, struct bio *bio) | |
145 | { | |
146 | if (q->rq_qos) | |
147 | __rq_qos_cleanup(q->rq_qos, bio); | |
148 | } | |
149 | ||
150 | static inline void rq_qos_done(struct request_queue *q, struct request *rq) | |
151 | { | |
152 | if (q->rq_qos) | |
153 | __rq_qos_done(q->rq_qos, rq); | |
154 | } | |
155 | ||
156 | static inline void rq_qos_issue(struct request_queue *q, struct request *rq) | |
157 | { | |
158 | if (q->rq_qos) | |
159 | __rq_qos_issue(q->rq_qos, rq); | |
160 | } | |
161 | ||
162 | static inline void rq_qos_requeue(struct request_queue *q, struct request *rq) | |
163 | { | |
164 | if (q->rq_qos) | |
165 | __rq_qos_requeue(q->rq_qos, rq); | |
166 | } | |
167 | ||
168 | static inline void rq_qos_done_bio(struct request_queue *q, struct bio *bio) | |
169 | { | |
170 | if (q->rq_qos) | |
171 | __rq_qos_done_bio(q->rq_qos, bio); | |
172 | } | |
173 | ||
174 | static inline void rq_qos_throttle(struct request_queue *q, struct bio *bio) | |
175 | { | |
13369816 DZ |
176 | /* |
177 | * BIO_TRACKED lets controllers know that a bio went through the | |
178 | * normal rq_qos path. | |
179 | */ | |
180 | bio_set_flag(bio, BIO_TRACKED); | |
e5045454 JA |
181 | if (q->rq_qos) |
182 | __rq_qos_throttle(q->rq_qos, bio); | |
183 | } | |
184 | ||
185 | static inline void rq_qos_track(struct request_queue *q, struct request *rq, | |
186 | struct bio *bio) | |
187 | { | |
188 | if (q->rq_qos) | |
189 | __rq_qos_track(q->rq_qos, rq, bio); | |
190 | } | |
191 | ||
d3e65fff TH |
192 | static inline void rq_qos_merge(struct request_queue *q, struct request *rq, |
193 | struct bio *bio) | |
194 | { | |
195 | if (q->rq_qos) | |
196 | __rq_qos_merge(q->rq_qos, rq, bio); | |
197 | } | |
198 | ||
9677a3e0 TH |
199 | static inline void rq_qos_queue_depth_changed(struct request_queue *q) |
200 | { | |
201 | if (q->rq_qos) | |
202 | __rq_qos_queue_depth_changed(q->rq_qos); | |
203 | } | |
204 | ||
a7905043 | 205 | void rq_qos_exit(struct request_queue *); |
e5045454 | 206 | |
a7905043 | 207 | #endif |