Merge tag 'for-6.10/block-20240511' of git://git.kernel.dk/linux
[linux-block.git] / block / blk-mq-debugfs.c
CommitLineData
8c16567d 1// SPDX-License-Identifier: GPL-2.0
07e4fead
OS
2/*
3 * Copyright (C) 2017 Facebook
07e4fead
OS
4 */
5
6#include <linux/kernel.h>
7#include <linux/blkdev.h>
8#include <linux/debugfs.h>
9
18fbda91 10#include "blk.h"
07e4fead 11#include "blk-mq.h"
d173a251 12#include "blk-mq-debugfs.h"
2aa7745b 13#include "blk-mq-sched.h"
cc56694f 14#include "blk-rq-qos.h"
07e4fead 15
1209cb7f
BVA
16static int queue_poll_stat_show(void *data, struct seq_file *m)
17{
1209cb7f
BVA
18 return 0;
19}
20
21static void *queue_requeue_list_start(struct seq_file *m, loff_t *pos)
22 __acquires(&q->requeue_lock)
23{
24 struct request_queue *q = m->private;
25
26 spin_lock_irq(&q->requeue_lock);
27 return seq_list_start(&q->requeue_list, *pos);
28}
29
30static void *queue_requeue_list_next(struct seq_file *m, void *v, loff_t *pos)
31{
32 struct request_queue *q = m->private;
33
34 return seq_list_next(v, &q->requeue_list, pos);
35}
36
37static void queue_requeue_list_stop(struct seq_file *m, void *v)
38 __releases(&q->requeue_lock)
39{
40 struct request_queue *q = m->private;
41
42 spin_unlock_irq(&q->requeue_lock);
43}
44
45static const struct seq_operations queue_requeue_list_seq_ops = {
46 .start = queue_requeue_list_start,
47 .next = queue_requeue_list_next,
48 .stop = queue_requeue_list_stop,
49 .show = blk_mq_debugfs_rq_show,
50};
51
91d68905
BVA
52static int blk_flags_show(struct seq_file *m, const unsigned long flags,
53 const char *const *flag_name, int flag_name_count)
54{
55 bool sep = false;
56 int i;
57
58 for (i = 0; i < sizeof(flags) * BITS_PER_BYTE; i++) {
59 if (!(flags & BIT(i)))
60 continue;
61 if (sep)
bec03d6b 62 seq_puts(m, "|");
91d68905
BVA
63 sep = true;
64 if (i < flag_name_count && flag_name[i])
65 seq_puts(m, flag_name[i]);
66 else
67 seq_printf(m, "%d", i);
68 }
91d68905
BVA
69 return 0;
70}
71
cd84a62e
BVA
72static int queue_pm_only_show(void *data, struct seq_file *m)
73{
74 struct request_queue *q = data;
75
76 seq_printf(m, "%d\n", atomic_read(&q->pm_only));
77 return 0;
78}
79
1a435111 80#define QUEUE_FLAG_NAME(name) [QUEUE_FLAG_##name] = #name
91d68905 81static const char *const blk_queue_flag_name[] = {
1a435111 82 QUEUE_FLAG_NAME(STOPPED),
1a435111 83 QUEUE_FLAG_NAME(DYING),
1a435111
OS
84 QUEUE_FLAG_NAME(NOMERGES),
85 QUEUE_FLAG_NAME(SAME_COMP),
86 QUEUE_FLAG_NAME(FAIL_IO),
1a435111
OS
87 QUEUE_FLAG_NAME(NONROT),
88 QUEUE_FLAG_NAME(IO_STAT),
1a435111
OS
89 QUEUE_FLAG_NAME(NOXMERGES),
90 QUEUE_FLAG_NAME(ADD_RANDOM),
d5fb8726 91 QUEUE_FLAG_NAME(SYNCHRONOUS),
1a435111 92 QUEUE_FLAG_NAME(SAME_FORCE),
1a435111 93 QUEUE_FLAG_NAME(INIT_DONE),
1cb039f3 94 QUEUE_FLAG_NAME(STABLE_WRITES),
1a435111
OS
95 QUEUE_FLAG_NAME(POLL),
96 QUEUE_FLAG_NAME(WC),
97 QUEUE_FLAG_NAME(FUA),
1a435111
OS
98 QUEUE_FLAG_NAME(DAX),
99 QUEUE_FLAG_NAME(STATS),
1a435111 100 QUEUE_FLAG_NAME(REGISTERED),
22d53821 101 QUEUE_FLAG_NAME(QUIESCED),
bfe373f6
HT
102 QUEUE_FLAG_NAME(PCI_P2PDMA),
103 QUEUE_FLAG_NAME(ZONE_RESETALL),
104 QUEUE_FLAG_NAME(RQ_ALLOC_TIME),
1dbdd99b 105 QUEUE_FLAG_NAME(HCTX_ACTIVE),
dc304326 106 QUEUE_FLAG_NAME(NOWAIT),
d5fb8726
BVA
107 QUEUE_FLAG_NAME(SQ_SCHED),
108 QUEUE_FLAG_NAME(SKIP_TAGSET_QUIESCE),
91d68905 109};
1a435111 110#undef QUEUE_FLAG_NAME
91d68905 111
f57de23a 112static int queue_state_show(void *data, struct seq_file *m)
91d68905 113{
f57de23a 114 struct request_queue *q = data;
91d68905
BVA
115
116 blk_flags_show(m, q->queue_flags, blk_queue_flag_name,
117 ARRAY_SIZE(blk_queue_flag_name));
fd07dc81 118 seq_puts(m, "\n");
91d68905
BVA
119 return 0;
120}
121
f57de23a
OS
122static ssize_t queue_state_write(void *data, const char __user *buf,
123 size_t count, loff_t *ppos)
91d68905 124{
f57de23a 125 struct request_queue *q = data;
71b90511 126 char opbuf[16] = { }, *op;
91d68905 127
18d4d7d0 128 /*
1f90307e
CH
129 * The "state" attribute is removed when the queue is removed. Don't
130 * allow setting the state on a dying queue to avoid a use-after-free.
18d4d7d0 131 */
1f90307e 132 if (blk_queue_dying(q))
18d4d7d0
BVA
133 return -ENOENT;
134
71b90511 135 if (count >= sizeof(opbuf)) {
c7e4145a
OS
136 pr_err("%s: operation too long\n", __func__);
137 goto inval;
138 }
139
71b90511 140 if (copy_from_user(opbuf, buf, count))
91d68905 141 return -EFAULT;
71b90511 142 op = strstrip(opbuf);
91d68905
BVA
143 if (strcmp(op, "run") == 0) {
144 blk_mq_run_hw_queues(q, true);
145 } else if (strcmp(op, "start") == 0) {
146 blk_mq_start_stopped_hw_queues(q, true);
edea55ab
BVA
147 } else if (strcmp(op, "kick") == 0) {
148 blk_mq_kick_requeue_list(q);
91d68905 149 } else {
c7e4145a
OS
150 pr_err("%s: unsupported operation '%s'\n", __func__, op);
151inval:
edea55ab 152 pr_err("%s: use 'run', 'start' or 'kick'\n", __func__);
91d68905
BVA
153 return -EINVAL;
154 }
c7e4145a 155 return count;
91d68905
BVA
156}
157
1209cb7f
BVA
158static const struct blk_mq_debugfs_attr blk_mq_debugfs_queue_attrs[] = {
159 { "poll_stat", 0400, queue_poll_stat_show },
160 { "requeue_list", 0400, .seq_ops = &queue_requeue_list_seq_ops },
cd84a62e 161 { "pm_only", 0600, queue_pm_only_show, NULL },
1209cb7f 162 { "state", 0600, queue_state_show, queue_state_write },
a98b05b0 163 { "zone_wplugs", 0400, queue_zone_wplugs_show, NULL },
1209cb7f
BVA
164 { },
165};
34dbad5d 166
1a435111 167#define HCTX_STATE_NAME(name) [BLK_MQ_S_##name] = #name
f5c0b091 168static const char *const hctx_state_name[] = {
1a435111
OS
169 HCTX_STATE_NAME(STOPPED),
170 HCTX_STATE_NAME(TAG_ACTIVE),
171 HCTX_STATE_NAME(SCHED_RESTART),
bf0beec0 172 HCTX_STATE_NAME(INACTIVE),
f5c0b091 173};
1a435111
OS
174#undef HCTX_STATE_NAME
175
f57de23a 176static int hctx_state_show(void *data, struct seq_file *m)
9abb2ad2 177{
f57de23a 178 struct blk_mq_hw_ctx *hctx = data;
9abb2ad2 179
f5c0b091
BVA
180 blk_flags_show(m, hctx->state, hctx_state_name,
181 ARRAY_SIZE(hctx_state_name));
fd07dc81 182 seq_puts(m, "\n");
9abb2ad2
OS
183 return 0;
184}
185
1a435111 186#define BLK_TAG_ALLOC_NAME(name) [BLK_TAG_ALLOC_##name] = #name
f5c0b091 187static const char *const alloc_policy_name[] = {
1a435111
OS
188 BLK_TAG_ALLOC_NAME(FIFO),
189 BLK_TAG_ALLOC_NAME(RR),
f5c0b091 190};
1a435111 191#undef BLK_TAG_ALLOC_NAME
f5c0b091 192
1a435111 193#define HCTX_FLAG_NAME(name) [ilog2(BLK_MQ_F_##name)] = #name
f5c0b091 194static const char *const hctx_flag_name[] = {
1a435111 195 HCTX_FLAG_NAME(SHOULD_MERGE),
51db1c37 196 HCTX_FLAG_NAME(TAG_QUEUE_SHARED),
1a435111
OS
197 HCTX_FLAG_NAME(BLOCKING),
198 HCTX_FLAG_NAME(NO_SCHED),
bf0beec0 199 HCTX_FLAG_NAME(STACKING),
02f938e9 200 HCTX_FLAG_NAME(TAG_HCTX_SHARED),
f5c0b091 201};
1a435111 202#undef HCTX_FLAG_NAME
f5c0b091 203
f57de23a 204static int hctx_flags_show(void *data, struct seq_file *m)
9abb2ad2 205{
f57de23a 206 struct blk_mq_hw_ctx *hctx = data;
f5c0b091 207 const int alloc_policy = BLK_MQ_FLAG_TO_ALLOC_POLICY(hctx->flags);
9abb2ad2 208
f5c0b091
BVA
209 seq_puts(m, "alloc_policy=");
210 if (alloc_policy < ARRAY_SIZE(alloc_policy_name) &&
211 alloc_policy_name[alloc_policy])
212 seq_puts(m, alloc_policy_name[alloc_policy]);
213 else
214 seq_printf(m, "%d", alloc_policy);
215 seq_puts(m, " ");
216 blk_flags_show(m,
217 hctx->flags ^ BLK_ALLOC_POLICY_TO_MQ_FLAG(alloc_policy),
218 hctx_flag_name, ARRAY_SIZE(hctx_flag_name));
fd07dc81 219 seq_puts(m, "\n");
9abb2ad2
OS
220 return 0;
221}
222
1a435111 223#define CMD_FLAG_NAME(name) [__REQ_##name] = #name
8658dca8 224static const char *const cmd_flag_name[] = {
1a435111
OS
225 CMD_FLAG_NAME(FAILFAST_DEV),
226 CMD_FLAG_NAME(FAILFAST_TRANSPORT),
227 CMD_FLAG_NAME(FAILFAST_DRIVER),
228 CMD_FLAG_NAME(SYNC),
229 CMD_FLAG_NAME(META),
230 CMD_FLAG_NAME(PRIO),
231 CMD_FLAG_NAME(NOMERGE),
232 CMD_FLAG_NAME(IDLE),
233 CMD_FLAG_NAME(INTEGRITY),
234 CMD_FLAG_NAME(FUA),
235 CMD_FLAG_NAME(PREFLUSH),
236 CMD_FLAG_NAME(RAHEAD),
237 CMD_FLAG_NAME(BACKGROUND),
22d53821 238 CMD_FLAG_NAME(NOWAIT),
1c26010c 239 CMD_FLAG_NAME(NOUNMAP),
6ce913fe 240 CMD_FLAG_NAME(POLLED),
8658dca8 241};
1a435111 242#undef CMD_FLAG_NAME
8658dca8 243
1a435111 244#define RQF_NAME(name) [ilog2((__force u32)RQF_##name)] = #name
8658dca8 245static const char *const rqf_name[] = {
85ba3eff 246 RQF_NAME(STARTED),
1a435111
OS
247 RQF_NAME(FLUSH_SEQ),
248 RQF_NAME(MIXED_MERGE),
1a435111 249 RQF_NAME(DONTPREP),
dd6216bb
CH
250 RQF_NAME(SCHED_TAGS),
251 RQF_NAME(USE_SCHED),
1a435111
OS
252 RQF_NAME(FAILED),
253 RQF_NAME(QUIET),
1a435111 254 RQF_NAME(IO_STAT),
1a435111
OS
255 RQF_NAME(PM),
256 RQF_NAME(HASHED),
257 RQF_NAME(STATS),
258 RQF_NAME(SPECIAL_PAYLOAD),
745ed372 259 RQF_NAME(TIMED_OUT),
745ed372 260 RQF_NAME(RESV),
8658dca8 261};
1a435111 262#undef RQF_NAME
8658dca8 263
ec6dcf63
BVA
264static const char *const blk_mq_rq_state_name_array[] = {
265 [MQ_RQ_IDLE] = "idle",
266 [MQ_RQ_IN_FLIGHT] = "in_flight",
267 [MQ_RQ_COMPLETE] = "complete",
268};
269
270static const char *blk_mq_rq_state_name(enum mq_rq_state rq_state)
271{
a1e79188 272 if (WARN_ON_ONCE((unsigned int)rq_state >=
ec6dcf63
BVA
273 ARRAY_SIZE(blk_mq_rq_state_name_array)))
274 return "(?)";
275 return blk_mq_rq_state_name_array[rq_state];
276}
277
daaadb3e 278int __blk_mq_debugfs_rq_show(struct seq_file *m, struct request *rq)
950cd7e9 279{
2836ee4b 280 const struct blk_mq_ops *const mq_ops = rq->q->mq_ops;
77e7ffd7 281 const enum req_op op = req_op(rq);
874c893b 282 const char *op_str = blk_op_str(op);
950cd7e9 283
8658dca8 284 seq_printf(m, "%p {.op=", rq);
874c893b 285 if (strcmp(op_str, "UNKNOWN") == 0)
3f6d385f 286 seq_printf(m, "%u", op);
8658dca8 287 else
874c893b 288 seq_printf(m, "%s", op_str);
8658dca8 289 seq_puts(m, ", .cmd_flags=");
16458cf3
BVA
290 blk_flags_show(m, (__force unsigned int)(rq->cmd_flags & ~REQ_OP_MASK),
291 cmd_flag_name, ARRAY_SIZE(cmd_flag_name));
8658dca8
BVA
292 seq_puts(m, ", .rq_flags=");
293 blk_flags_show(m, (__force unsigned int)rq->rq_flags, rqf_name,
294 ARRAY_SIZE(rqf_name));
ec6dcf63 295 seq_printf(m, ", .state=%s", blk_mq_rq_state_name(blk_mq_rq_state(rq)));
2836ee4b 296 seq_printf(m, ", .tag=%d, .internal_tag=%d", rq->tag,
8658dca8 297 rq->internal_tag);
2836ee4b
BVA
298 if (mq_ops->show_rq)
299 mq_ops->show_rq(m, rq);
300 seq_puts(m, "}\n");
950cd7e9
OS
301 return 0;
302}
daaadb3e
OS
303EXPORT_SYMBOL_GPL(__blk_mq_debugfs_rq_show);
304
305int blk_mq_debugfs_rq_show(struct seq_file *m, void *v)
306{
307 return __blk_mq_debugfs_rq_show(m, list_entry_rq(v));
308}
16b738f6 309EXPORT_SYMBOL_GPL(blk_mq_debugfs_rq_show);
950cd7e9
OS
310
311static void *hctx_dispatch_start(struct seq_file *m, loff_t *pos)
f3bcb0e6 312 __acquires(&hctx->lock)
950cd7e9
OS
313{
314 struct blk_mq_hw_ctx *hctx = m->private;
315
316 spin_lock(&hctx->lock);
317 return seq_list_start(&hctx->dispatch, *pos);
318}
319
320static void *hctx_dispatch_next(struct seq_file *m, void *v, loff_t *pos)
321{
322 struct blk_mq_hw_ctx *hctx = m->private;
323
324 return seq_list_next(v, &hctx->dispatch, pos);
325}
326
327static void hctx_dispatch_stop(struct seq_file *m, void *v)
f3bcb0e6 328 __releases(&hctx->lock)
950cd7e9
OS
329{
330 struct blk_mq_hw_ctx *hctx = m->private;
331
332 spin_unlock(&hctx->lock);
333}
334
335static const struct seq_operations hctx_dispatch_seq_ops = {
336 .start = hctx_dispatch_start,
337 .next = hctx_dispatch_next,
338 .stop = hctx_dispatch_stop,
339 .show = blk_mq_debugfs_rq_show,
340};
341
2720bab5
BVA
342struct show_busy_params {
343 struct seq_file *m;
344 struct blk_mq_hw_ctx *hctx;
345};
346
347/*
348 * Note: the state of a request may change while this function is in progress,
7baa8572
JA
349 * e.g. due to a concurrent blk_mq_finish_request() call. Returns true to
350 * keep iterating requests.
2720bab5 351 */
2dd6532e 352static bool hctx_show_busy_rq(struct request *rq, void *data)
2720bab5
BVA
353{
354 const struct show_busy_params *params = data;
355
ea4f995e 356 if (rq->mq_hctx == params->hctx)
b5fc1e8b 357 __blk_mq_debugfs_rq_show(params->m, rq);
7baa8572
JA
358
359 return true;
2720bab5
BVA
360}
361
362static int hctx_busy_show(void *data, struct seq_file *m)
363{
364 struct blk_mq_hw_ctx *hctx = data;
365 struct show_busy_params params = { .m = m, .hctx = hctx };
366
367 blk_mq_tagset_busy_iter(hctx->queue->tag_set, hctx_show_busy_rq,
368 &params);
369
370 return 0;
371}
372
346fc108
ML
373static const char *const hctx_types[] = {
374 [HCTX_TYPE_DEFAULT] = "default",
375 [HCTX_TYPE_READ] = "read",
376 [HCTX_TYPE_POLL] = "poll",
377};
378
379static int hctx_type_show(void *data, struct seq_file *m)
380{
381 struct blk_mq_hw_ctx *hctx = data;
382
383 BUILD_BUG_ON(ARRAY_SIZE(hctx_types) != HCTX_MAX_TYPES);
384 seq_printf(m, "%s\n", hctx_types[hctx->type]);
385 return 0;
386}
387
f57de23a 388static int hctx_ctx_map_show(void *data, struct seq_file *m)
0bfa5288 389{
f57de23a 390 struct blk_mq_hw_ctx *hctx = data;
0bfa5288
OS
391
392 sbitmap_bitmap_show(&hctx->ctx_map, m);
393 return 0;
394}
395
d96b37c0
OS
396static void blk_mq_debugfs_tags_show(struct seq_file *m,
397 struct blk_mq_tags *tags)
398{
399 seq_printf(m, "nr_tags=%u\n", tags->nr_tags);
400 seq_printf(m, "nr_reserved_tags=%u\n", tags->nr_reserved_tags);
401 seq_printf(m, "active_queues=%d\n",
4f1731df 402 READ_ONCE(tags->active_queues));
d96b37c0
OS
403
404 seq_puts(m, "\nbitmap_tags:\n");
ae0f1a73 405 sbitmap_queue_show(&tags->bitmap_tags, m);
d96b37c0
OS
406
407 if (tags->nr_reserved_tags) {
408 seq_puts(m, "\nbreserved_tags:\n");
ae0f1a73 409 sbitmap_queue_show(&tags->breserved_tags, m);
d96b37c0
OS
410 }
411}
412
f57de23a 413static int hctx_tags_show(void *data, struct seq_file *m)
d96b37c0 414{
f57de23a 415 struct blk_mq_hw_ctx *hctx = data;
d96b37c0 416 struct request_queue *q = hctx->queue;
8c0f14ea 417 int res;
d96b37c0 418
8c0f14ea
BVA
419 res = mutex_lock_interruptible(&q->sysfs_lock);
420 if (res)
421 goto out;
d96b37c0
OS
422 if (hctx->tags)
423 blk_mq_debugfs_tags_show(m, hctx->tags);
424 mutex_unlock(&q->sysfs_lock);
425
8c0f14ea
BVA
426out:
427 return res;
d96b37c0
OS
428}
429
f57de23a 430static int hctx_tags_bitmap_show(void *data, struct seq_file *m)
d7e3621a 431{
f57de23a 432 struct blk_mq_hw_ctx *hctx = data;
d7e3621a 433 struct request_queue *q = hctx->queue;
8c0f14ea 434 int res;
d7e3621a 435
8c0f14ea
BVA
436 res = mutex_lock_interruptible(&q->sysfs_lock);
437 if (res)
438 goto out;
d7e3621a 439 if (hctx->tags)
ae0f1a73 440 sbitmap_bitmap_show(&hctx->tags->bitmap_tags.sb, m);
d7e3621a 441 mutex_unlock(&q->sysfs_lock);
8c0f14ea
BVA
442
443out:
444 return res;
d7e3621a
OS
445}
446
f57de23a 447static int hctx_sched_tags_show(void *data, struct seq_file *m)
d96b37c0 448{
f57de23a 449 struct blk_mq_hw_ctx *hctx = data;
d96b37c0 450 struct request_queue *q = hctx->queue;
8c0f14ea 451 int res;
d96b37c0 452
8c0f14ea
BVA
453 res = mutex_lock_interruptible(&q->sysfs_lock);
454 if (res)
455 goto out;
d96b37c0
OS
456 if (hctx->sched_tags)
457 blk_mq_debugfs_tags_show(m, hctx->sched_tags);
458 mutex_unlock(&q->sysfs_lock);
459
8c0f14ea
BVA
460out:
461 return res;
d96b37c0
OS
462}
463
f57de23a 464static int hctx_sched_tags_bitmap_show(void *data, struct seq_file *m)
d7e3621a 465{
f57de23a 466 struct blk_mq_hw_ctx *hctx = data;
d7e3621a 467 struct request_queue *q = hctx->queue;
8c0f14ea 468 int res;
d7e3621a 469
8c0f14ea
BVA
470 res = mutex_lock_interruptible(&q->sysfs_lock);
471 if (res)
472 goto out;
d7e3621a 473 if (hctx->sched_tags)
ae0f1a73 474 sbitmap_bitmap_show(&hctx->sched_tags->bitmap_tags.sb, m);
d7e3621a 475 mutex_unlock(&q->sysfs_lock);
8c0f14ea
BVA
476
477out:
478 return res;
d7e3621a
OS
479}
480
f57de23a 481static int hctx_active_show(void *data, struct seq_file *m)
4a46f05e 482{
f57de23a 483 struct blk_mq_hw_ctx *hctx = data;
4a46f05e 484
9b84c629 485 seq_printf(m, "%d\n", __blk_mq_active_requests(hctx));
4a46f05e
OS
486 return 0;
487}
488
6e768717
ML
489static int hctx_dispatch_busy_show(void *data, struct seq_file *m)
490{
491 struct blk_mq_hw_ctx *hctx = data;
492
493 seq_printf(m, "%u\n", hctx->dispatch_busy);
494 return 0;
495}
496
c16d6b5a
ML
497#define CTX_RQ_SEQ_OPS(name, type) \
498static void *ctx_##name##_rq_list_start(struct seq_file *m, loff_t *pos) \
499 __acquires(&ctx->lock) \
500{ \
501 struct blk_mq_ctx *ctx = m->private; \
502 \
503 spin_lock(&ctx->lock); \
504 return seq_list_start(&ctx->rq_lists[type], *pos); \
505} \
506 \
507static void *ctx_##name##_rq_list_next(struct seq_file *m, void *v, \
508 loff_t *pos) \
509{ \
510 struct blk_mq_ctx *ctx = m->private; \
511 \
512 return seq_list_next(v, &ctx->rq_lists[type], pos); \
513} \
514 \
515static void ctx_##name##_rq_list_stop(struct seq_file *m, void *v) \
516 __releases(&ctx->lock) \
517{ \
518 struct blk_mq_ctx *ctx = m->private; \
519 \
520 spin_unlock(&ctx->lock); \
521} \
522 \
523static const struct seq_operations ctx_##name##_rq_list_seq_ops = { \
524 .start = ctx_##name##_rq_list_start, \
525 .next = ctx_##name##_rq_list_next, \
526 .stop = ctx_##name##_rq_list_stop, \
527 .show = blk_mq_debugfs_rq_show, \
528}
529
530CTX_RQ_SEQ_OPS(default, HCTX_TYPE_DEFAULT);
531CTX_RQ_SEQ_OPS(read, HCTX_TYPE_READ);
532CTX_RQ_SEQ_OPS(poll, HCTX_TYPE_POLL);
950cd7e9 533
f57de23a
OS
534static int blk_mq_debugfs_show(struct seq_file *m, void *v)
535{
536 const struct blk_mq_debugfs_attr *attr = m->private;
537 void *data = d_inode(m->file->f_path.dentry->d_parent)->i_private;
538
539 return attr->show(data, m);
540}
541
542static ssize_t blk_mq_debugfs_write(struct file *file, const char __user *buf,
543 size_t count, loff_t *ppos)
4a46f05e
OS
544{
545 struct seq_file *m = file->private_data;
f57de23a
OS
546 const struct blk_mq_debugfs_attr *attr = m->private;
547 void *data = d_inode(file->f_path.dentry->d_parent)->i_private;
4a46f05e 548
6b136a24
EG
549 /*
550 * Attributes that only implement .seq_ops are read-only and 'attr' is
551 * the same with 'data' in this case.
552 */
553 if (attr == data || !attr->write)
f57de23a
OS
554 return -EPERM;
555
556 return attr->write(data, buf, count, ppos);
557}
558
559static int blk_mq_debugfs_open(struct inode *inode, struct file *file)
560{
561 const struct blk_mq_debugfs_attr *attr = inode->i_private;
562 void *data = d_inode(file->f_path.dentry->d_parent)->i_private;
563 struct seq_file *m;
564 int ret;
565
566 if (attr->seq_ops) {
567 ret = seq_open(file, attr->seq_ops);
568 if (!ret) {
569 m = file->private_data;
570 m->private = data;
571 }
572 return ret;
573 }
574
575 if (WARN_ON_ONCE(!attr->show))
576 return -EPERM;
577
578 return single_open(file, blk_mq_debugfs_show, inode->i_private);
4a46f05e
OS
579}
580
f57de23a
OS
581static int blk_mq_debugfs_release(struct inode *inode, struct file *file)
582{
583 const struct blk_mq_debugfs_attr *attr = inode->i_private;
584
585 if (attr->show)
586 return single_release(inode, file);
ee1e0359
CK
587
588 return seq_release(inode, file);
f57de23a
OS
589}
590
f8465933 591static const struct file_operations blk_mq_debugfs_fops = {
f57de23a 592 .open = blk_mq_debugfs_open,
4a46f05e 593 .read = seq_read,
f57de23a 594 .write = blk_mq_debugfs_write,
4a46f05e 595 .llseek = seq_lseek,
f57de23a 596 .release = blk_mq_debugfs_release,
4a46f05e
OS
597};
598
07e4fead 599static const struct blk_mq_debugfs_attr blk_mq_debugfs_hctx_attrs[] = {
f57de23a
OS
600 {"state", 0400, hctx_state_show},
601 {"flags", 0400, hctx_flags_show},
602 {"dispatch", 0400, .seq_ops = &hctx_dispatch_seq_ops},
2720bab5 603 {"busy", 0400, hctx_busy_show},
f57de23a
OS
604 {"ctx_map", 0400, hctx_ctx_map_show},
605 {"tags", 0400, hctx_tags_show},
606 {"tags_bitmap", 0400, hctx_tags_bitmap_show},
607 {"sched_tags", 0400, hctx_sched_tags_show},
608 {"sched_tags_bitmap", 0400, hctx_sched_tags_bitmap_show},
f57de23a 609 {"active", 0400, hctx_active_show},
6e768717 610 {"dispatch_busy", 0400, hctx_dispatch_busy_show},
346fc108 611 {"type", 0400, hctx_type_show},
72f2f8f6 612 {},
07e4fead
OS
613};
614
615static const struct blk_mq_debugfs_attr blk_mq_debugfs_ctx_attrs[] = {
c16d6b5a
ML
616 {"default_rq_list", 0400, .seq_ops = &ctx_default_rq_list_seq_ops},
617 {"read_rq_list", 0400, .seq_ops = &ctx_read_rq_list_seq_ops},
618 {"poll_rq_list", 0400, .seq_ops = &ctx_poll_rq_list_seq_ops},
72f2f8f6 619 {},
07e4fead
OS
620};
621
6cfc0081 622static void debugfs_create_files(struct dentry *parent, void *data,
9c1051aa
OS
623 const struct blk_mq_debugfs_attr *attr)
624{
36991ca6 625 if (IS_ERR_OR_NULL(parent))
6cfc0081 626 return;
36991ca6 627
9c1051aa
OS
628 d_inode(parent)->i_private = data;
629
6cfc0081
GKH
630 for (; attr->name; attr++)
631 debugfs_create_file(attr->name, attr->mode, parent,
632 (void *)attr, &blk_mq_debugfs_fops);
9c1051aa
OS
633}
634
6cfc0081 635void blk_mq_debugfs_register(struct request_queue *q)
07e4fead 636{
9c1051aa 637 struct blk_mq_hw_ctx *hctx;
4f481208 638 unsigned long i;
9c1051aa 639
6cfc0081 640 debugfs_create_files(q->debugfs_dir, q, blk_mq_debugfs_queue_attrs);
07e4fead 641
9c1051aa 642 /*
70e62f4b 643 * blk_mq_init_sched() attempted to do this already, but q->debugfs_dir
9c1051aa
OS
644 * didn't exist yet (because we don't know what to name the directory
645 * until the queue is registered to a gendisk).
646 */
70e62f4b
OS
647 if (q->elevator && !q->sched_debugfs_dir)
648 blk_mq_debugfs_register_sched(q);
649
650 /* Similarly, blk_mq_init_hctx() couldn't do this previously. */
9c1051aa 651 queue_for_each_hw_ctx(q, hctx, i) {
6cfc0081
GKH
652 if (!hctx->debugfs_dir)
653 blk_mq_debugfs_register_hctx(q, hctx);
654 if (q->elevator && !hctx->sched_debugfs_dir)
655 blk_mq_debugfs_register_sched_hctx(q, hctx);
9c1051aa
OS
656 }
657
cc56694f
ML
658 if (q->rq_qos) {
659 struct rq_qos *rqos = q->rq_qos;
660
661 while (rqos) {
662 blk_mq_debugfs_register_rqos(rqos);
663 rqos = rqos->next;
664 }
665 }
07e4fead
OS
666}
667
6cfc0081
GKH
668static void blk_mq_debugfs_register_ctx(struct blk_mq_hw_ctx *hctx,
669 struct blk_mq_ctx *ctx)
07e4fead
OS
670{
671 struct dentry *ctx_dir;
672 char name[20];
07e4fead
OS
673
674 snprintf(name, sizeof(name), "cpu%u", ctx->cpu);
9c1051aa 675 ctx_dir = debugfs_create_dir(name, hctx->debugfs_dir);
07e4fead 676
6cfc0081 677 debugfs_create_files(ctx_dir, ctx, blk_mq_debugfs_ctx_attrs);
07e4fead
OS
678}
679
6cfc0081
GKH
680void blk_mq_debugfs_register_hctx(struct request_queue *q,
681 struct blk_mq_hw_ctx *hctx)
07e4fead
OS
682{
683 struct blk_mq_ctx *ctx;
07e4fead
OS
684 char name[20];
685 int i;
686
f3ec5d11
ML
687 if (!q->debugfs_dir)
688 return;
689
88aabbd7 690 snprintf(name, sizeof(name), "hctx%u", hctx->queue_num);
9c1051aa 691 hctx->debugfs_dir = debugfs_create_dir(name, q->debugfs_dir);
07e4fead 692
6cfc0081 693 debugfs_create_files(hctx->debugfs_dir, hctx, blk_mq_debugfs_hctx_attrs);
9c1051aa 694
6cfc0081
GKH
695 hctx_for_each_ctx(hctx, ctx, i)
696 blk_mq_debugfs_register_ctx(hctx, ctx);
9c1051aa
OS
697}
698
699void blk_mq_debugfs_unregister_hctx(struct blk_mq_hw_ctx *hctx)
700{
5cf9c91b
CH
701 if (!hctx->queue->debugfs_dir)
702 return;
9c1051aa 703 debugfs_remove_recursive(hctx->debugfs_dir);
d332ce09 704 hctx->sched_debugfs_dir = NULL;
9c1051aa 705 hctx->debugfs_dir = NULL;
07e4fead
OS
706}
707
6cfc0081 708void blk_mq_debugfs_register_hctxs(struct request_queue *q)
07e4fead
OS
709{
710 struct blk_mq_hw_ctx *hctx;
4f481208 711 unsigned long i;
07e4fead 712
6cfc0081
GKH
713 queue_for_each_hw_ctx(q, hctx, i)
714 blk_mq_debugfs_register_hctx(q, hctx);
07e4fead
OS
715}
716
9c1051aa 717void blk_mq_debugfs_unregister_hctxs(struct request_queue *q)
07e4fead 718{
9c1051aa 719 struct blk_mq_hw_ctx *hctx;
4f481208 720 unsigned long i;
9c1051aa
OS
721
722 queue_for_each_hw_ctx(q, hctx, i)
723 blk_mq_debugfs_unregister_hctx(hctx);
07e4fead 724}
d332ce09 725
6cfc0081 726void blk_mq_debugfs_register_sched(struct request_queue *q)
d332ce09
OS
727{
728 struct elevator_type *e = q->elevator->type;
729
5cf9c91b
CH
730 lockdep_assert_held(&q->debugfs_mutex);
731
7e41c3c9
GKH
732 /*
733 * If the parent directory has not been created yet, return, we will be
734 * called again later on and the directory/files will be created then.
735 */
736 if (!q->debugfs_dir)
737 return;
738
d332ce09 739 if (!e->queue_debugfs_attrs)
6cfc0081 740 return;
d332ce09
OS
741
742 q->sched_debugfs_dir = debugfs_create_dir("sched", q->debugfs_dir);
d332ce09 743
6cfc0081 744 debugfs_create_files(q->sched_debugfs_dir, q, e->queue_debugfs_attrs);
d332ce09
OS
745}
746
747void blk_mq_debugfs_unregister_sched(struct request_queue *q)
748{
5cf9c91b
CH
749 lockdep_assert_held(&q->debugfs_mutex);
750
d332ce09
OS
751 debugfs_remove_recursive(q->sched_debugfs_dir);
752 q->sched_debugfs_dir = NULL;
753}
754
fb44023e
BVA
755static const char *rq_qos_id_to_name(enum rq_qos_id id)
756{
757 switch (id) {
758 case RQ_QOS_WBT:
759 return "wbt";
760 case RQ_QOS_LATENCY:
761 return "latency";
762 case RQ_QOS_COST:
763 return "cost";
764 }
765 return "unknown";
766}
767
cc56694f
ML
768void blk_mq_debugfs_unregister_rqos(struct rq_qos *rqos)
769{
ba91c849 770 lockdep_assert_held(&rqos->disk->queue->debugfs_mutex);
5cf9c91b 771
ba91c849 772 if (!rqos->disk->queue->debugfs_dir)
5cf9c91b 773 return;
cc56694f
ML
774 debugfs_remove_recursive(rqos->debugfs_dir);
775 rqos->debugfs_dir = NULL;
776}
777
6cfc0081 778void blk_mq_debugfs_register_rqos(struct rq_qos *rqos)
cc56694f 779{
ba91c849 780 struct request_queue *q = rqos->disk->queue;
cc56694f
ML
781 const char *dir_name = rq_qos_id_to_name(rqos->id);
782
5cf9c91b
CH
783 lockdep_assert_held(&q->debugfs_mutex);
784
cc56694f 785 if (rqos->debugfs_dir || !rqos->ops->debugfs_attrs)
6cfc0081 786 return;
cc56694f 787
6cfc0081 788 if (!q->rqos_debugfs_dir)
cc56694f
ML
789 q->rqos_debugfs_dir = debugfs_create_dir("rqos",
790 q->debugfs_dir);
cc56694f 791
ba91c849 792 rqos->debugfs_dir = debugfs_create_dir(dir_name, q->rqos_debugfs_dir);
6cfc0081 793 debugfs_create_files(rqos->debugfs_dir, rqos, rqos->ops->debugfs_attrs);
cc56694f
ML
794}
795
6cfc0081
GKH
796void blk_mq_debugfs_register_sched_hctx(struct request_queue *q,
797 struct blk_mq_hw_ctx *hctx)
d332ce09
OS
798{
799 struct elevator_type *e = q->elevator->type;
800
5cf9c91b
CH
801 lockdep_assert_held(&q->debugfs_mutex);
802
1e91e28e
S
803 /*
804 * If the parent debugfs directory has not been created yet, return;
805 * We will be called again later on with appropriate parent debugfs
806 * directory from blk_register_queue()
807 */
808 if (!hctx->debugfs_dir)
809 return;
810
d332ce09 811 if (!e->hctx_debugfs_attrs)
6cfc0081 812 return;
d332ce09
OS
813
814 hctx->sched_debugfs_dir = debugfs_create_dir("sched",
815 hctx->debugfs_dir);
6cfc0081
GKH
816 debugfs_create_files(hctx->sched_debugfs_dir, hctx,
817 e->hctx_debugfs_attrs);
d332ce09
OS
818}
819
820void blk_mq_debugfs_unregister_sched_hctx(struct blk_mq_hw_ctx *hctx)
821{
5cf9c91b
CH
822 lockdep_assert_held(&hctx->queue->debugfs_mutex);
823
824 if (!hctx->queue->debugfs_dir)
825 return;
d332ce09
OS
826 debugfs_remove_recursive(hctx->sched_debugfs_dir);
827 hctx->sched_debugfs_dir = NULL;
828}