xref: /linux/block/blk-mq-sysfs.c (revision 1cab50da62aa810e532396fcaeb96cf9c3fdf87a)
1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/kernel.h>
3 #include <linux/module.h>
4 #include <linux/backing-dev.h>
5 #include <linux/bio.h>
6 #include <linux/blkdev.h>
7 #include <linux/mm.h>
8 #include <linux/init.h>
9 #include <linux/slab.h>
10 #include <linux/workqueue.h>
11 #include <linux/smp.h>
12 
13 #include "blk.h"
14 #include "blk-mq.h"
15 
16 static void blk_mq_sysfs_release(struct kobject *kobj)
17 {
18 	struct blk_mq_ctxs *ctxs = container_of(kobj, struct blk_mq_ctxs, kobj);
19 
20 	free_percpu(ctxs->queue_ctx);
21 	kfree(ctxs);
22 }
23 
24 static void blk_mq_ctx_sysfs_release(struct kobject *kobj)
25 {
26 	struct blk_mq_ctx *ctx = container_of(kobj, struct blk_mq_ctx, kobj);
27 
28 	/* ctx->ctxs won't be released until all ctx are freed */
29 	kobject_put(&ctx->ctxs->kobj);
30 }
31 
32 static void blk_mq_hw_sysfs_release(struct kobject *kobj)
33 {
34 	struct blk_mq_hw_ctx *hctx = container_of(kobj, struct blk_mq_hw_ctx,
35 						  kobj);
36 
37 	blk_free_flush_queue(hctx->fq);
38 	sbitmap_free(&hctx->ctx_map);
39 	free_cpumask_var(hctx->cpumask);
40 	kfree(hctx->ctxs);
41 	kfree(hctx);
42 }
43 
44 struct blk_mq_hw_ctx_sysfs_entry {
45 	struct attribute attr;
46 	ssize_t (*show)(struct blk_mq_hw_ctx *, char *);
47 };
48 
49 static ssize_t blk_mq_hw_sysfs_show(struct kobject *kobj,
50 				    struct attribute *attr, char *page)
51 {
52 	struct blk_mq_hw_ctx_sysfs_entry *entry;
53 	struct blk_mq_hw_ctx *hctx;
54 	struct request_queue *q;
55 	ssize_t res;
56 
57 	entry = container_of(attr, struct blk_mq_hw_ctx_sysfs_entry, attr);
58 	hctx = container_of(kobj, struct blk_mq_hw_ctx, kobj);
59 	q = hctx->queue;
60 
61 	if (!entry->show)
62 		return -EIO;
63 
64 	mutex_lock(&q->elevator_lock);
65 	res = entry->show(hctx, page);
66 	mutex_unlock(&q->elevator_lock);
67 	return res;
68 }
69 
70 static ssize_t blk_mq_hw_sysfs_nr_tags_show(struct blk_mq_hw_ctx *hctx,
71 					    char *page)
72 {
73 	return sprintf(page, "%u\n", hctx->tags->nr_tags);
74 }
75 
76 static ssize_t blk_mq_hw_sysfs_nr_reserved_tags_show(struct blk_mq_hw_ctx *hctx,
77 						     char *page)
78 {
79 	return sprintf(page, "%u\n", hctx->tags->nr_reserved_tags);
80 }
81 
82 static ssize_t blk_mq_hw_sysfs_cpus_show(struct blk_mq_hw_ctx *hctx, char *page)
83 {
84 	const size_t size = PAGE_SIZE - 1;
85 	unsigned int i, first = 1;
86 	int ret = 0, pos = 0;
87 
88 	for_each_cpu(i, hctx->cpumask) {
89 		if (first)
90 			ret = snprintf(pos + page, size - pos, "%u", i);
91 		else
92 			ret = snprintf(pos + page, size - pos, ", %u", i);
93 
94 		if (ret >= size - pos)
95 			break;
96 
97 		first = 0;
98 		pos += ret;
99 	}
100 
101 	ret = snprintf(pos + page, size + 1 - pos, "\n");
102 	return pos + ret;
103 }
104 
105 static struct blk_mq_hw_ctx_sysfs_entry blk_mq_hw_sysfs_nr_tags = {
106 	.attr = {.name = "nr_tags", .mode = 0444 },
107 	.show = blk_mq_hw_sysfs_nr_tags_show,
108 };
109 static struct blk_mq_hw_ctx_sysfs_entry blk_mq_hw_sysfs_nr_reserved_tags = {
110 	.attr = {.name = "nr_reserved_tags", .mode = 0444 },
111 	.show = blk_mq_hw_sysfs_nr_reserved_tags_show,
112 };
113 static struct blk_mq_hw_ctx_sysfs_entry blk_mq_hw_sysfs_cpus = {
114 	.attr = {.name = "cpu_list", .mode = 0444 },
115 	.show = blk_mq_hw_sysfs_cpus_show,
116 };
117 
118 static struct attribute *default_hw_ctx_attrs[] = {
119 	&blk_mq_hw_sysfs_nr_tags.attr,
120 	&blk_mq_hw_sysfs_nr_reserved_tags.attr,
121 	&blk_mq_hw_sysfs_cpus.attr,
122 	NULL,
123 };
124 ATTRIBUTE_GROUPS(default_hw_ctx);
125 
126 static const struct sysfs_ops blk_mq_hw_sysfs_ops = {
127 	.show	= blk_mq_hw_sysfs_show,
128 };
129 
130 static const struct kobj_type blk_mq_ktype = {
131 	.release	= blk_mq_sysfs_release,
132 };
133 
134 static const struct kobj_type blk_mq_ctx_ktype = {
135 	.release	= blk_mq_ctx_sysfs_release,
136 };
137 
138 static const struct kobj_type blk_mq_hw_ktype = {
139 	.sysfs_ops	= &blk_mq_hw_sysfs_ops,
140 	.default_groups = default_hw_ctx_groups,
141 	.release	= blk_mq_hw_sysfs_release,
142 };
143 
144 static void blk_mq_unregister_hctx(struct blk_mq_hw_ctx *hctx)
145 {
146 	struct blk_mq_ctx *ctx;
147 	int i;
148 
149 	if (!hctx->nr_ctx)
150 		return;
151 
152 	hctx_for_each_ctx(hctx, ctx, i)
153 		if (ctx->kobj.state_in_sysfs)
154 			kobject_del(&ctx->kobj);
155 
156 	if (hctx->kobj.state_in_sysfs)
157 		kobject_del(&hctx->kobj);
158 }
159 
160 static int blk_mq_register_hctx(struct blk_mq_hw_ctx *hctx)
161 {
162 	struct request_queue *q = hctx->queue;
163 	struct blk_mq_ctx *ctx;
164 	int i, j, ret;
165 
166 	if (!hctx->nr_ctx)
167 		return 0;
168 
169 	ret = kobject_add(&hctx->kobj, q->mq_kobj, "%u", hctx->queue_num);
170 	if (ret)
171 		return ret;
172 
173 	hctx_for_each_ctx(hctx, ctx, i) {
174 		ret = kobject_add(&ctx->kobj, &hctx->kobj, "cpu%u", ctx->cpu);
175 		if (ret)
176 			goto out;
177 	}
178 
179 	return 0;
180 out:
181 	hctx_for_each_ctx(hctx, ctx, j) {
182 		if (j < i)
183 			kobject_del(&ctx->kobj);
184 	}
185 	kobject_del(&hctx->kobj);
186 	return ret;
187 }
188 
189 void blk_mq_hctx_kobj_init(struct blk_mq_hw_ctx *hctx)
190 {
191 	kobject_init(&hctx->kobj, &blk_mq_hw_ktype);
192 }
193 
194 void blk_mq_sysfs_deinit(struct request_queue *q)
195 {
196 	struct blk_mq_ctx *ctx;
197 	int cpu;
198 
199 	for_each_possible_cpu(cpu) {
200 		ctx = per_cpu_ptr(q->queue_ctx, cpu);
201 		kobject_put(&ctx->kobj);
202 	}
203 	kobject_put(q->mq_kobj);
204 }
205 
206 void blk_mq_sysfs_init(struct request_queue *q)
207 {
208 	struct blk_mq_ctx *ctx;
209 	int cpu;
210 
211 	kobject_init(q->mq_kobj, &blk_mq_ktype);
212 
213 	for_each_possible_cpu(cpu) {
214 		ctx = per_cpu_ptr(q->queue_ctx, cpu);
215 
216 		kobject_get(q->mq_kobj);
217 		kobject_init(&ctx->kobj, &blk_mq_ctx_ktype);
218 	}
219 }
220 
221 int blk_mq_sysfs_register(struct gendisk *disk)
222 {
223 	struct request_queue *q = disk->queue;
224 	struct blk_mq_hw_ctx *hctx;
225 	unsigned long i, j;
226 	int ret;
227 
228 	ret = kobject_add(q->mq_kobj, &disk_to_dev(disk)->kobj, "mq");
229 	if (ret < 0)
230 		return ret;
231 
232 	kobject_uevent(q->mq_kobj, KOBJ_ADD);
233 
234 	mutex_lock(&q->tag_set->tag_list_lock);
235 	queue_for_each_hw_ctx(q, hctx, i) {
236 		ret = blk_mq_register_hctx(hctx);
237 		if (ret)
238 			goto out_unreg;
239 	}
240 	mutex_unlock(&q->tag_set->tag_list_lock);
241 	return 0;
242 
243 out_unreg:
244 	queue_for_each_hw_ctx(q, hctx, j) {
245 		if (j < i)
246 			blk_mq_unregister_hctx(hctx);
247 	}
248 	mutex_unlock(&q->tag_set->tag_list_lock);
249 
250 	kobject_uevent(q->mq_kobj, KOBJ_REMOVE);
251 	kobject_del(q->mq_kobj);
252 	return ret;
253 }
254 
255 void blk_mq_sysfs_unregister(struct gendisk *disk)
256 {
257 	struct request_queue *q = disk->queue;
258 	struct blk_mq_hw_ctx *hctx;
259 	unsigned long i;
260 
261 	mutex_lock(&q->tag_set->tag_list_lock);
262 	queue_for_each_hw_ctx(q, hctx, i)
263 		blk_mq_unregister_hctx(hctx);
264 	mutex_unlock(&q->tag_set->tag_list_lock);
265 
266 	kobject_uevent(q->mq_kobj, KOBJ_REMOVE);
267 	kobject_del(q->mq_kobj);
268 }
269 
270 void blk_mq_sysfs_unregister_hctxs(struct request_queue *q)
271 {
272 	struct blk_mq_hw_ctx *hctx;
273 	unsigned long i;
274 
275 	if (!blk_queue_registered(q))
276 		return;
277 
278 	queue_for_each_hw_ctx(q, hctx, i)
279 		blk_mq_unregister_hctx(hctx);
280 }
281 
282 int blk_mq_sysfs_register_hctxs(struct request_queue *q)
283 {
284 	struct blk_mq_hw_ctx *hctx;
285 	unsigned long i;
286 	int ret = 0;
287 
288 	if (!blk_queue_registered(q))
289 		goto out;
290 
291 	queue_for_each_hw_ctx(q, hctx, i) {
292 		ret = blk_mq_register_hctx(hctx);
293 		if (ret)
294 			break;
295 	}
296 
297 out:
298 	return ret;
299 }
300