block: remove legacy rq tagging
[linux-2.6-microblaze.git] / block / blk-mq-debugfs.c
1 /*
2  * Copyright (C) 2017 Facebook
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public
6  * License v2 as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
15  */
16
17 #include <linux/kernel.h>
18 #include <linux/blkdev.h>
19 #include <linux/debugfs.h>
20
21 #include <linux/blk-mq.h>
22 #include "blk.h"
23 #include "blk-mq.h"
24 #include "blk-mq-debugfs.h"
25 #include "blk-mq-tag.h"
26
27 static void print_stat(struct seq_file *m, struct blk_rq_stat *stat)
28 {
29         if (stat->nr_samples) {
30                 seq_printf(m, "samples=%d, mean=%lld, min=%llu, max=%llu",
31                            stat->nr_samples, stat->mean, stat->min, stat->max);
32         } else {
33                 seq_puts(m, "samples=0");
34         }
35 }
36
37 static int queue_poll_stat_show(void *data, struct seq_file *m)
38 {
39         struct request_queue *q = data;
40         int bucket;
41
42         for (bucket = 0; bucket < BLK_MQ_POLL_STATS_BKTS/2; bucket++) {
43                 seq_printf(m, "read  (%d Bytes): ", 1 << (9+bucket));
44                 print_stat(m, &q->poll_stat[2*bucket]);
45                 seq_puts(m, "\n");
46
47                 seq_printf(m, "write (%d Bytes): ",  1 << (9+bucket));
48                 print_stat(m, &q->poll_stat[2*bucket+1]);
49                 seq_puts(m, "\n");
50         }
51         return 0;
52 }
53
54 static void *queue_requeue_list_start(struct seq_file *m, loff_t *pos)
55         __acquires(&q->requeue_lock)
56 {
57         struct request_queue *q = m->private;
58
59         spin_lock_irq(&q->requeue_lock);
60         return seq_list_start(&q->requeue_list, *pos);
61 }
62
63 static void *queue_requeue_list_next(struct seq_file *m, void *v, loff_t *pos)
64 {
65         struct request_queue *q = m->private;
66
67         return seq_list_next(v, &q->requeue_list, pos);
68 }
69
70 static void queue_requeue_list_stop(struct seq_file *m, void *v)
71         __releases(&q->requeue_lock)
72 {
73         struct request_queue *q = m->private;
74
75         spin_unlock_irq(&q->requeue_lock);
76 }
77
78 static const struct seq_operations queue_requeue_list_seq_ops = {
79         .start  = queue_requeue_list_start,
80         .next   = queue_requeue_list_next,
81         .stop   = queue_requeue_list_stop,
82         .show   = blk_mq_debugfs_rq_show,
83 };
84
85 static int blk_flags_show(struct seq_file *m, const unsigned long flags,
86                           const char *const *flag_name, int flag_name_count)
87 {
88         bool sep = false;
89         int i;
90
91         for (i = 0; i < sizeof(flags) * BITS_PER_BYTE; i++) {
92                 if (!(flags & BIT(i)))
93                         continue;
94                 if (sep)
95                         seq_puts(m, "|");
96                 sep = true;
97                 if (i < flag_name_count && flag_name[i])
98                         seq_puts(m, flag_name[i]);
99                 else
100                         seq_printf(m, "%d", i);
101         }
102         return 0;
103 }
104
105 static int queue_pm_only_show(void *data, struct seq_file *m)
106 {
107         struct request_queue *q = data;
108
109         seq_printf(m, "%d\n", atomic_read(&q->pm_only));
110         return 0;
111 }
112
113 #define QUEUE_FLAG_NAME(name) [QUEUE_FLAG_##name] = #name
114 static const char *const blk_queue_flag_name[] = {
115         QUEUE_FLAG_NAME(STOPPED),
116         QUEUE_FLAG_NAME(DYING),
117         QUEUE_FLAG_NAME(BYPASS),
118         QUEUE_FLAG_NAME(BIDI),
119         QUEUE_FLAG_NAME(NOMERGES),
120         QUEUE_FLAG_NAME(SAME_COMP),
121         QUEUE_FLAG_NAME(FAIL_IO),
122         QUEUE_FLAG_NAME(NONROT),
123         QUEUE_FLAG_NAME(IO_STAT),
124         QUEUE_FLAG_NAME(DISCARD),
125         QUEUE_FLAG_NAME(NOXMERGES),
126         QUEUE_FLAG_NAME(ADD_RANDOM),
127         QUEUE_FLAG_NAME(SECERASE),
128         QUEUE_FLAG_NAME(SAME_FORCE),
129         QUEUE_FLAG_NAME(DEAD),
130         QUEUE_FLAG_NAME(INIT_DONE),
131         QUEUE_FLAG_NAME(NO_SG_MERGE),
132         QUEUE_FLAG_NAME(POLL),
133         QUEUE_FLAG_NAME(WC),
134         QUEUE_FLAG_NAME(FUA),
135         QUEUE_FLAG_NAME(FLUSH_NQ),
136         QUEUE_FLAG_NAME(DAX),
137         QUEUE_FLAG_NAME(STATS),
138         QUEUE_FLAG_NAME(POLL_STATS),
139         QUEUE_FLAG_NAME(REGISTERED),
140         QUEUE_FLAG_NAME(SCSI_PASSTHROUGH),
141         QUEUE_FLAG_NAME(QUIESCED),
142 };
143 #undef QUEUE_FLAG_NAME
144
145 static int queue_state_show(void *data, struct seq_file *m)
146 {
147         struct request_queue *q = data;
148
149         blk_flags_show(m, q->queue_flags, blk_queue_flag_name,
150                        ARRAY_SIZE(blk_queue_flag_name));
151         seq_puts(m, "\n");
152         return 0;
153 }
154
155 static ssize_t queue_state_write(void *data, const char __user *buf,
156                                  size_t count, loff_t *ppos)
157 {
158         struct request_queue *q = data;
159         char opbuf[16] = { }, *op;
160
161         /*
162          * The "state" attribute is removed after blk_cleanup_queue() has called
163          * blk_mq_free_queue(). Return if QUEUE_FLAG_DEAD has been set to avoid
164          * triggering a use-after-free.
165          */
166         if (blk_queue_dead(q))
167                 return -ENOENT;
168
169         if (count >= sizeof(opbuf)) {
170                 pr_err("%s: operation too long\n", __func__);
171                 goto inval;
172         }
173
174         if (copy_from_user(opbuf, buf, count))
175                 return -EFAULT;
176         op = strstrip(opbuf);
177         if (strcmp(op, "run") == 0) {
178                 blk_mq_run_hw_queues(q, true);
179         } else if (strcmp(op, "start") == 0) {
180                 blk_mq_start_stopped_hw_queues(q, true);
181         } else if (strcmp(op, "kick") == 0) {
182                 blk_mq_kick_requeue_list(q);
183         } else {
184                 pr_err("%s: unsupported operation '%s'\n", __func__, op);
185 inval:
186                 pr_err("%s: use 'run', 'start' or 'kick'\n", __func__);
187                 return -EINVAL;
188         }
189         return count;
190 }
191
192 static int queue_write_hint_show(void *data, struct seq_file *m)
193 {
194         struct request_queue *q = data;
195         int i;
196
197         for (i = 0; i < BLK_MAX_WRITE_HINTS; i++)
198                 seq_printf(m, "hint%d: %llu\n", i, q->write_hints[i]);
199
200         return 0;
201 }
202
203 static ssize_t queue_write_hint_store(void *data, const char __user *buf,
204                                       size_t count, loff_t *ppos)
205 {
206         struct request_queue *q = data;
207         int i;
208
209         for (i = 0; i < BLK_MAX_WRITE_HINTS; i++)
210                 q->write_hints[i] = 0;
211
212         return count;
213 }
214
215 static const struct blk_mq_debugfs_attr blk_mq_debugfs_queue_attrs[] = {
216         { "poll_stat", 0400, queue_poll_stat_show },
217         { "requeue_list", 0400, .seq_ops = &queue_requeue_list_seq_ops },
218         { "pm_only", 0600, queue_pm_only_show, NULL },
219         { "state", 0600, queue_state_show, queue_state_write },
220         { "write_hints", 0600, queue_write_hint_show, queue_write_hint_store },
221         { "zone_wlock", 0400, queue_zone_wlock_show, NULL },
222         { },
223 };
224
225 #define HCTX_STATE_NAME(name) [BLK_MQ_S_##name] = #name
226 static const char *const hctx_state_name[] = {
227         HCTX_STATE_NAME(STOPPED),
228         HCTX_STATE_NAME(TAG_ACTIVE),
229         HCTX_STATE_NAME(SCHED_RESTART),
230 };
231 #undef HCTX_STATE_NAME
232
233 static int hctx_state_show(void *data, struct seq_file *m)
234 {
235         struct blk_mq_hw_ctx *hctx = data;
236
237         blk_flags_show(m, hctx->state, hctx_state_name,
238                        ARRAY_SIZE(hctx_state_name));
239         seq_puts(m, "\n");
240         return 0;
241 }
242
243 #define BLK_TAG_ALLOC_NAME(name) [BLK_TAG_ALLOC_##name] = #name
244 static const char *const alloc_policy_name[] = {
245         BLK_TAG_ALLOC_NAME(FIFO),
246         BLK_TAG_ALLOC_NAME(RR),
247 };
248 #undef BLK_TAG_ALLOC_NAME
249
250 #define HCTX_FLAG_NAME(name) [ilog2(BLK_MQ_F_##name)] = #name
251 static const char *const hctx_flag_name[] = {
252         HCTX_FLAG_NAME(SHOULD_MERGE),
253         HCTX_FLAG_NAME(TAG_SHARED),
254         HCTX_FLAG_NAME(SG_MERGE),
255         HCTX_FLAG_NAME(BLOCKING),
256         HCTX_FLAG_NAME(NO_SCHED),
257 };
258 #undef HCTX_FLAG_NAME
259
260 static int hctx_flags_show(void *data, struct seq_file *m)
261 {
262         struct blk_mq_hw_ctx *hctx = data;
263         const int alloc_policy = BLK_MQ_FLAG_TO_ALLOC_POLICY(hctx->flags);
264
265         seq_puts(m, "alloc_policy=");
266         if (alloc_policy < ARRAY_SIZE(alloc_policy_name) &&
267             alloc_policy_name[alloc_policy])
268                 seq_puts(m, alloc_policy_name[alloc_policy]);
269         else
270                 seq_printf(m, "%d", alloc_policy);
271         seq_puts(m, " ");
272         blk_flags_show(m,
273                        hctx->flags ^ BLK_ALLOC_POLICY_TO_MQ_FLAG(alloc_policy),
274                        hctx_flag_name, ARRAY_SIZE(hctx_flag_name));
275         seq_puts(m, "\n");
276         return 0;
277 }
278
279 #define REQ_OP_NAME(name) [REQ_OP_##name] = #name
280 static const char *const op_name[] = {
281         REQ_OP_NAME(READ),
282         REQ_OP_NAME(WRITE),
283         REQ_OP_NAME(FLUSH),
284         REQ_OP_NAME(DISCARD),
285         REQ_OP_NAME(SECURE_ERASE),
286         REQ_OP_NAME(ZONE_RESET),
287         REQ_OP_NAME(WRITE_SAME),
288         REQ_OP_NAME(WRITE_ZEROES),
289         REQ_OP_NAME(SCSI_IN),
290         REQ_OP_NAME(SCSI_OUT),
291         REQ_OP_NAME(DRV_IN),
292         REQ_OP_NAME(DRV_OUT),
293 };
294 #undef REQ_OP_NAME
295
296 #define CMD_FLAG_NAME(name) [__REQ_##name] = #name
297 static const char *const cmd_flag_name[] = {
298         CMD_FLAG_NAME(FAILFAST_DEV),
299         CMD_FLAG_NAME(FAILFAST_TRANSPORT),
300         CMD_FLAG_NAME(FAILFAST_DRIVER),
301         CMD_FLAG_NAME(SYNC),
302         CMD_FLAG_NAME(META),
303         CMD_FLAG_NAME(PRIO),
304         CMD_FLAG_NAME(NOMERGE),
305         CMD_FLAG_NAME(IDLE),
306         CMD_FLAG_NAME(INTEGRITY),
307         CMD_FLAG_NAME(FUA),
308         CMD_FLAG_NAME(PREFLUSH),
309         CMD_FLAG_NAME(RAHEAD),
310         CMD_FLAG_NAME(BACKGROUND),
311         CMD_FLAG_NAME(NOUNMAP),
312         CMD_FLAG_NAME(NOWAIT),
313 };
314 #undef CMD_FLAG_NAME
315
316 #define RQF_NAME(name) [ilog2((__force u32)RQF_##name)] = #name
317 static const char *const rqf_name[] = {
318         RQF_NAME(SORTED),
319         RQF_NAME(STARTED),
320         RQF_NAME(SOFTBARRIER),
321         RQF_NAME(FLUSH_SEQ),
322         RQF_NAME(MIXED_MERGE),
323         RQF_NAME(MQ_INFLIGHT),
324         RQF_NAME(DONTPREP),
325         RQF_NAME(PREEMPT),
326         RQF_NAME(COPY_USER),
327         RQF_NAME(FAILED),
328         RQF_NAME(QUIET),
329         RQF_NAME(ELVPRIV),
330         RQF_NAME(IO_STAT),
331         RQF_NAME(ALLOCED),
332         RQF_NAME(PM),
333         RQF_NAME(HASHED),
334         RQF_NAME(STATS),
335         RQF_NAME(SPECIAL_PAYLOAD),
336         RQF_NAME(ZONE_WRITE_LOCKED),
337         RQF_NAME(MQ_POLL_SLEPT),
338 };
339 #undef RQF_NAME
340
341 static const char *const blk_mq_rq_state_name_array[] = {
342         [MQ_RQ_IDLE]            = "idle",
343         [MQ_RQ_IN_FLIGHT]       = "in_flight",
344         [MQ_RQ_COMPLETE]        = "complete",
345 };
346
347 static const char *blk_mq_rq_state_name(enum mq_rq_state rq_state)
348 {
349         if (WARN_ON_ONCE((unsigned int)rq_state >=
350                          ARRAY_SIZE(blk_mq_rq_state_name_array)))
351                 return "(?)";
352         return blk_mq_rq_state_name_array[rq_state];
353 }
354
355 int __blk_mq_debugfs_rq_show(struct seq_file *m, struct request *rq)
356 {
357         const struct blk_mq_ops *const mq_ops = rq->q->mq_ops;
358         const unsigned int op = rq->cmd_flags & REQ_OP_MASK;
359
360         seq_printf(m, "%p {.op=", rq);
361         if (op < ARRAY_SIZE(op_name) && op_name[op])
362                 seq_printf(m, "%s", op_name[op]);
363         else
364                 seq_printf(m, "%d", op);
365         seq_puts(m, ", .cmd_flags=");
366         blk_flags_show(m, rq->cmd_flags & ~REQ_OP_MASK, cmd_flag_name,
367                        ARRAY_SIZE(cmd_flag_name));
368         seq_puts(m, ", .rq_flags=");
369         blk_flags_show(m, (__force unsigned int)rq->rq_flags, rqf_name,
370                        ARRAY_SIZE(rqf_name));
371         seq_printf(m, ", .state=%s", blk_mq_rq_state_name(blk_mq_rq_state(rq)));
372         seq_printf(m, ", .tag=%d, .internal_tag=%d", rq->tag,
373                    rq->internal_tag);
374         if (mq_ops->show_rq)
375                 mq_ops->show_rq(m, rq);
376         seq_puts(m, "}\n");
377         return 0;
378 }
379 EXPORT_SYMBOL_GPL(__blk_mq_debugfs_rq_show);
380
381 int blk_mq_debugfs_rq_show(struct seq_file *m, void *v)
382 {
383         return __blk_mq_debugfs_rq_show(m, list_entry_rq(v));
384 }
385 EXPORT_SYMBOL_GPL(blk_mq_debugfs_rq_show);
386
387 static void *hctx_dispatch_start(struct seq_file *m, loff_t *pos)
388         __acquires(&hctx->lock)
389 {
390         struct blk_mq_hw_ctx *hctx = m->private;
391
392         spin_lock(&hctx->lock);
393         return seq_list_start(&hctx->dispatch, *pos);
394 }
395
396 static void *hctx_dispatch_next(struct seq_file *m, void *v, loff_t *pos)
397 {
398         struct blk_mq_hw_ctx *hctx = m->private;
399
400         return seq_list_next(v, &hctx->dispatch, pos);
401 }
402
403 static void hctx_dispatch_stop(struct seq_file *m, void *v)
404         __releases(&hctx->lock)
405 {
406         struct blk_mq_hw_ctx *hctx = m->private;
407
408         spin_unlock(&hctx->lock);
409 }
410
411 static const struct seq_operations hctx_dispatch_seq_ops = {
412         .start  = hctx_dispatch_start,
413         .next   = hctx_dispatch_next,
414         .stop   = hctx_dispatch_stop,
415         .show   = blk_mq_debugfs_rq_show,
416 };
417
418 struct show_busy_params {
419         struct seq_file         *m;
420         struct blk_mq_hw_ctx    *hctx;
421 };
422
423 /*
424  * Note: the state of a request may change while this function is in progress,
425  * e.g. due to a concurrent blk_mq_finish_request() call.
426  */
427 static void hctx_show_busy_rq(struct request *rq, void *data, bool reserved)
428 {
429         const struct show_busy_params *params = data;
430
431         if (blk_mq_map_queue(rq->q, rq->mq_ctx->cpu) == params->hctx)
432                 __blk_mq_debugfs_rq_show(params->m,
433                                          list_entry_rq(&rq->queuelist));
434 }
435
436 static int hctx_busy_show(void *data, struct seq_file *m)
437 {
438         struct blk_mq_hw_ctx *hctx = data;
439         struct show_busy_params params = { .m = m, .hctx = hctx };
440
441         blk_mq_tagset_busy_iter(hctx->queue->tag_set, hctx_show_busy_rq,
442                                 &params);
443
444         return 0;
445 }
446
447 static int hctx_ctx_map_show(void *data, struct seq_file *m)
448 {
449         struct blk_mq_hw_ctx *hctx = data;
450
451         sbitmap_bitmap_show(&hctx->ctx_map, m);
452         return 0;
453 }
454
455 static void blk_mq_debugfs_tags_show(struct seq_file *m,
456                                      struct blk_mq_tags *tags)
457 {
458         seq_printf(m, "nr_tags=%u\n", tags->nr_tags);
459         seq_printf(m, "nr_reserved_tags=%u\n", tags->nr_reserved_tags);
460         seq_printf(m, "active_queues=%d\n",
461                    atomic_read(&tags->active_queues));
462
463         seq_puts(m, "\nbitmap_tags:\n");
464         sbitmap_queue_show(&tags->bitmap_tags, m);
465
466         if (tags->nr_reserved_tags) {
467                 seq_puts(m, "\nbreserved_tags:\n");
468                 sbitmap_queue_show(&tags->breserved_tags, m);
469         }
470 }
471
472 static int hctx_tags_show(void *data, struct seq_file *m)
473 {
474         struct blk_mq_hw_ctx *hctx = data;
475         struct request_queue *q = hctx->queue;
476         int res;
477
478         res = mutex_lock_interruptible(&q->sysfs_lock);
479         if (res)
480                 goto out;
481         if (hctx->tags)
482                 blk_mq_debugfs_tags_show(m, hctx->tags);
483         mutex_unlock(&q->sysfs_lock);
484
485 out:
486         return res;
487 }
488
489 static int hctx_tags_bitmap_show(void *data, struct seq_file *m)
490 {
491         struct blk_mq_hw_ctx *hctx = data;
492         struct request_queue *q = hctx->queue;
493         int res;
494
495         res = mutex_lock_interruptible(&q->sysfs_lock);
496         if (res)
497                 goto out;
498         if (hctx->tags)
499                 sbitmap_bitmap_show(&hctx->tags->bitmap_tags.sb, m);
500         mutex_unlock(&q->sysfs_lock);
501
502 out:
503         return res;
504 }
505
506 static int hctx_sched_tags_show(void *data, struct seq_file *m)
507 {
508         struct blk_mq_hw_ctx *hctx = data;
509         struct request_queue *q = hctx->queue;
510         int res;
511
512         res = mutex_lock_interruptible(&q->sysfs_lock);
513         if (res)
514                 goto out;
515         if (hctx->sched_tags)
516                 blk_mq_debugfs_tags_show(m, hctx->sched_tags);
517         mutex_unlock(&q->sysfs_lock);
518
519 out:
520         return res;
521 }
522
523 static int hctx_sched_tags_bitmap_show(void *data, struct seq_file *m)
524 {
525         struct blk_mq_hw_ctx *hctx = data;
526         struct request_queue *q = hctx->queue;
527         int res;
528
529         res = mutex_lock_interruptible(&q->sysfs_lock);
530         if (res)
531                 goto out;
532         if (hctx->sched_tags)
533                 sbitmap_bitmap_show(&hctx->sched_tags->bitmap_tags.sb, m);
534         mutex_unlock(&q->sysfs_lock);
535
536 out:
537         return res;
538 }
539
540 static int hctx_io_poll_show(void *data, struct seq_file *m)
541 {
542         struct blk_mq_hw_ctx *hctx = data;
543
544         seq_printf(m, "considered=%lu\n", hctx->poll_considered);
545         seq_printf(m, "invoked=%lu\n", hctx->poll_invoked);
546         seq_printf(m, "success=%lu\n", hctx->poll_success);
547         return 0;
548 }
549
550 static ssize_t hctx_io_poll_write(void *data, const char __user *buf,
551                                   size_t count, loff_t *ppos)
552 {
553         struct blk_mq_hw_ctx *hctx = data;
554
555         hctx->poll_considered = hctx->poll_invoked = hctx->poll_success = 0;
556         return count;
557 }
558
559 static int hctx_dispatched_show(void *data, struct seq_file *m)
560 {
561         struct blk_mq_hw_ctx *hctx = data;
562         int i;
563
564         seq_printf(m, "%8u\t%lu\n", 0U, hctx->dispatched[0]);
565
566         for (i = 1; i < BLK_MQ_MAX_DISPATCH_ORDER - 1; i++) {
567                 unsigned int d = 1U << (i - 1);
568
569                 seq_printf(m, "%8u\t%lu\n", d, hctx->dispatched[i]);
570         }
571
572         seq_printf(m, "%8u+\t%lu\n", 1U << (i - 1), hctx->dispatched[i]);
573         return 0;
574 }
575
576 static ssize_t hctx_dispatched_write(void *data, const char __user *buf,
577                                      size_t count, loff_t *ppos)
578 {
579         struct blk_mq_hw_ctx *hctx = data;
580         int i;
581
582         for (i = 0; i < BLK_MQ_MAX_DISPATCH_ORDER; i++)
583                 hctx->dispatched[i] = 0;
584         return count;
585 }
586
587 static int hctx_queued_show(void *data, struct seq_file *m)
588 {
589         struct blk_mq_hw_ctx *hctx = data;
590
591         seq_printf(m, "%lu\n", hctx->queued);
592         return 0;
593 }
594
595 static ssize_t hctx_queued_write(void *data, const char __user *buf,
596                                  size_t count, loff_t *ppos)
597 {
598         struct blk_mq_hw_ctx *hctx = data;
599
600         hctx->queued = 0;
601         return count;
602 }
603
604 static int hctx_run_show(void *data, struct seq_file *m)
605 {
606         struct blk_mq_hw_ctx *hctx = data;
607
608         seq_printf(m, "%lu\n", hctx->run);
609         return 0;
610 }
611
612 static ssize_t hctx_run_write(void *data, const char __user *buf, size_t count,
613                               loff_t *ppos)
614 {
615         struct blk_mq_hw_ctx *hctx = data;
616
617         hctx->run = 0;
618         return count;
619 }
620
621 static int hctx_active_show(void *data, struct seq_file *m)
622 {
623         struct blk_mq_hw_ctx *hctx = data;
624
625         seq_printf(m, "%d\n", atomic_read(&hctx->nr_active));
626         return 0;
627 }
628
629 static int hctx_dispatch_busy_show(void *data, struct seq_file *m)
630 {
631         struct blk_mq_hw_ctx *hctx = data;
632
633         seq_printf(m, "%u\n", hctx->dispatch_busy);
634         return 0;
635 }
636
637 static void *ctx_rq_list_start(struct seq_file *m, loff_t *pos)
638         __acquires(&ctx->lock)
639 {
640         struct blk_mq_ctx *ctx = m->private;
641
642         spin_lock(&ctx->lock);
643         return seq_list_start(&ctx->rq_list, *pos);
644 }
645
646 static void *ctx_rq_list_next(struct seq_file *m, void *v, loff_t *pos)
647 {
648         struct blk_mq_ctx *ctx = m->private;
649
650         return seq_list_next(v, &ctx->rq_list, pos);
651 }
652
653 static void ctx_rq_list_stop(struct seq_file *m, void *v)
654         __releases(&ctx->lock)
655 {
656         struct blk_mq_ctx *ctx = m->private;
657
658         spin_unlock(&ctx->lock);
659 }
660
661 static const struct seq_operations ctx_rq_list_seq_ops = {
662         .start  = ctx_rq_list_start,
663         .next   = ctx_rq_list_next,
664         .stop   = ctx_rq_list_stop,
665         .show   = blk_mq_debugfs_rq_show,
666 };
667 static int ctx_dispatched_show(void *data, struct seq_file *m)
668 {
669         struct blk_mq_ctx *ctx = data;
670
671         seq_printf(m, "%lu %lu\n", ctx->rq_dispatched[1], ctx->rq_dispatched[0]);
672         return 0;
673 }
674
675 static ssize_t ctx_dispatched_write(void *data, const char __user *buf,
676                                     size_t count, loff_t *ppos)
677 {
678         struct blk_mq_ctx *ctx = data;
679
680         ctx->rq_dispatched[0] = ctx->rq_dispatched[1] = 0;
681         return count;
682 }
683
684 static int ctx_merged_show(void *data, struct seq_file *m)
685 {
686         struct blk_mq_ctx *ctx = data;
687
688         seq_printf(m, "%lu\n", ctx->rq_merged);
689         return 0;
690 }
691
692 static ssize_t ctx_merged_write(void *data, const char __user *buf,
693                                 size_t count, loff_t *ppos)
694 {
695         struct blk_mq_ctx *ctx = data;
696
697         ctx->rq_merged = 0;
698         return count;
699 }
700
701 static int ctx_completed_show(void *data, struct seq_file *m)
702 {
703         struct blk_mq_ctx *ctx = data;
704
705         seq_printf(m, "%lu %lu\n", ctx->rq_completed[1], ctx->rq_completed[0]);
706         return 0;
707 }
708
709 static ssize_t ctx_completed_write(void *data, const char __user *buf,
710                                    size_t count, loff_t *ppos)
711 {
712         struct blk_mq_ctx *ctx = data;
713
714         ctx->rq_completed[0] = ctx->rq_completed[1] = 0;
715         return count;
716 }
717
718 static int blk_mq_debugfs_show(struct seq_file *m, void *v)
719 {
720         const struct blk_mq_debugfs_attr *attr = m->private;
721         void *data = d_inode(m->file->f_path.dentry->d_parent)->i_private;
722
723         return attr->show(data, m);
724 }
725
726 static ssize_t blk_mq_debugfs_write(struct file *file, const char __user *buf,
727                                     size_t count, loff_t *ppos)
728 {
729         struct seq_file *m = file->private_data;
730         const struct blk_mq_debugfs_attr *attr = m->private;
731         void *data = d_inode(file->f_path.dentry->d_parent)->i_private;
732
733         /*
734          * Attributes that only implement .seq_ops are read-only and 'attr' is
735          * the same with 'data' in this case.
736          */
737         if (attr == data || !attr->write)
738                 return -EPERM;
739
740         return attr->write(data, buf, count, ppos);
741 }
742
743 static int blk_mq_debugfs_open(struct inode *inode, struct file *file)
744 {
745         const struct blk_mq_debugfs_attr *attr = inode->i_private;
746         void *data = d_inode(file->f_path.dentry->d_parent)->i_private;
747         struct seq_file *m;
748         int ret;
749
750         if (attr->seq_ops) {
751                 ret = seq_open(file, attr->seq_ops);
752                 if (!ret) {
753                         m = file->private_data;
754                         m->private = data;
755                 }
756                 return ret;
757         }
758
759         if (WARN_ON_ONCE(!attr->show))
760                 return -EPERM;
761
762         return single_open(file, blk_mq_debugfs_show, inode->i_private);
763 }
764
765 static int blk_mq_debugfs_release(struct inode *inode, struct file *file)
766 {
767         const struct blk_mq_debugfs_attr *attr = inode->i_private;
768
769         if (attr->show)
770                 return single_release(inode, file);
771         else
772                 return seq_release(inode, file);
773 }
774
775 static const struct file_operations blk_mq_debugfs_fops = {
776         .open           = blk_mq_debugfs_open,
777         .read           = seq_read,
778         .write          = blk_mq_debugfs_write,
779         .llseek         = seq_lseek,
780         .release        = blk_mq_debugfs_release,
781 };
782
783 static const struct blk_mq_debugfs_attr blk_mq_debugfs_hctx_attrs[] = {
784         {"state", 0400, hctx_state_show},
785         {"flags", 0400, hctx_flags_show},
786         {"dispatch", 0400, .seq_ops = &hctx_dispatch_seq_ops},
787         {"busy", 0400, hctx_busy_show},
788         {"ctx_map", 0400, hctx_ctx_map_show},
789         {"tags", 0400, hctx_tags_show},
790         {"tags_bitmap", 0400, hctx_tags_bitmap_show},
791         {"sched_tags", 0400, hctx_sched_tags_show},
792         {"sched_tags_bitmap", 0400, hctx_sched_tags_bitmap_show},
793         {"io_poll", 0600, hctx_io_poll_show, hctx_io_poll_write},
794         {"dispatched", 0600, hctx_dispatched_show, hctx_dispatched_write},
795         {"queued", 0600, hctx_queued_show, hctx_queued_write},
796         {"run", 0600, hctx_run_show, hctx_run_write},
797         {"active", 0400, hctx_active_show},
798         {"dispatch_busy", 0400, hctx_dispatch_busy_show},
799         {},
800 };
801
802 static const struct blk_mq_debugfs_attr blk_mq_debugfs_ctx_attrs[] = {
803         {"rq_list", 0400, .seq_ops = &ctx_rq_list_seq_ops},
804         {"dispatched", 0600, ctx_dispatched_show, ctx_dispatched_write},
805         {"merged", 0600, ctx_merged_show, ctx_merged_write},
806         {"completed", 0600, ctx_completed_show, ctx_completed_write},
807         {},
808 };
809
810 static bool debugfs_create_files(struct dentry *parent, void *data,
811                                  const struct blk_mq_debugfs_attr *attr)
812 {
813         d_inode(parent)->i_private = data;
814
815         for (; attr->name; attr++) {
816                 if (!debugfs_create_file(attr->name, attr->mode, parent,
817                                          (void *)attr, &blk_mq_debugfs_fops))
818                         return false;
819         }
820         return true;
821 }
822
823 int blk_mq_debugfs_register(struct request_queue *q)
824 {
825         struct blk_mq_hw_ctx *hctx;
826         int i;
827
828         if (!blk_debugfs_root)
829                 return -ENOENT;
830
831         q->debugfs_dir = debugfs_create_dir(kobject_name(q->kobj.parent),
832                                             blk_debugfs_root);
833         if (!q->debugfs_dir)
834                 return -ENOMEM;
835
836         if (!debugfs_create_files(q->debugfs_dir, q,
837                                   blk_mq_debugfs_queue_attrs))
838                 goto err;
839
840         /*
841          * blk_mq_init_sched() attempted to do this already, but q->debugfs_dir
842          * didn't exist yet (because we don't know what to name the directory
843          * until the queue is registered to a gendisk).
844          */
845         if (q->elevator && !q->sched_debugfs_dir)
846                 blk_mq_debugfs_register_sched(q);
847
848         /* Similarly, blk_mq_init_hctx() couldn't do this previously. */
849         queue_for_each_hw_ctx(q, hctx, i) {
850                 if (!hctx->debugfs_dir && blk_mq_debugfs_register_hctx(q, hctx))
851                         goto err;
852                 if (q->elevator && !hctx->sched_debugfs_dir &&
853                     blk_mq_debugfs_register_sched_hctx(q, hctx))
854                         goto err;
855         }
856
857         return 0;
858
859 err:
860         blk_mq_debugfs_unregister(q);
861         return -ENOMEM;
862 }
863
864 void blk_mq_debugfs_unregister(struct request_queue *q)
865 {
866         debugfs_remove_recursive(q->debugfs_dir);
867         q->sched_debugfs_dir = NULL;
868         q->debugfs_dir = NULL;
869 }
870
871 static int blk_mq_debugfs_register_ctx(struct blk_mq_hw_ctx *hctx,
872                                        struct blk_mq_ctx *ctx)
873 {
874         struct dentry *ctx_dir;
875         char name[20];
876
877         snprintf(name, sizeof(name), "cpu%u", ctx->cpu);
878         ctx_dir = debugfs_create_dir(name, hctx->debugfs_dir);
879         if (!ctx_dir)
880                 return -ENOMEM;
881
882         if (!debugfs_create_files(ctx_dir, ctx, blk_mq_debugfs_ctx_attrs))
883                 return -ENOMEM;
884
885         return 0;
886 }
887
888 int blk_mq_debugfs_register_hctx(struct request_queue *q,
889                                  struct blk_mq_hw_ctx *hctx)
890 {
891         struct blk_mq_ctx *ctx;
892         char name[20];
893         int i;
894
895         if (!q->debugfs_dir)
896                 return -ENOENT;
897
898         snprintf(name, sizeof(name), "hctx%u", hctx->queue_num);
899         hctx->debugfs_dir = debugfs_create_dir(name, q->debugfs_dir);
900         if (!hctx->debugfs_dir)
901                 return -ENOMEM;
902
903         if (!debugfs_create_files(hctx->debugfs_dir, hctx,
904                                   blk_mq_debugfs_hctx_attrs))
905                 goto err;
906
907         hctx_for_each_ctx(hctx, ctx, i) {
908                 if (blk_mq_debugfs_register_ctx(hctx, ctx))
909                         goto err;
910         }
911
912         return 0;
913
914 err:
915         blk_mq_debugfs_unregister_hctx(hctx);
916         return -ENOMEM;
917 }
918
919 void blk_mq_debugfs_unregister_hctx(struct blk_mq_hw_ctx *hctx)
920 {
921         debugfs_remove_recursive(hctx->debugfs_dir);
922         hctx->sched_debugfs_dir = NULL;
923         hctx->debugfs_dir = NULL;
924 }
925
926 int blk_mq_debugfs_register_hctxs(struct request_queue *q)
927 {
928         struct blk_mq_hw_ctx *hctx;
929         int i;
930
931         queue_for_each_hw_ctx(q, hctx, i) {
932                 if (blk_mq_debugfs_register_hctx(q, hctx))
933                         return -ENOMEM;
934         }
935
936         return 0;
937 }
938
939 void blk_mq_debugfs_unregister_hctxs(struct request_queue *q)
940 {
941         struct blk_mq_hw_ctx *hctx;
942         int i;
943
944         queue_for_each_hw_ctx(q, hctx, i)
945                 blk_mq_debugfs_unregister_hctx(hctx);
946 }
947
948 int blk_mq_debugfs_register_sched(struct request_queue *q)
949 {
950         struct elevator_type *e = q->elevator->type;
951
952         if (!q->debugfs_dir)
953                 return -ENOENT;
954
955         if (!e->queue_debugfs_attrs)
956                 return 0;
957
958         q->sched_debugfs_dir = debugfs_create_dir("sched", q->debugfs_dir);
959         if (!q->sched_debugfs_dir)
960                 return -ENOMEM;
961
962         if (!debugfs_create_files(q->sched_debugfs_dir, q,
963                                   e->queue_debugfs_attrs))
964                 goto err;
965
966         return 0;
967
968 err:
969         blk_mq_debugfs_unregister_sched(q);
970         return -ENOMEM;
971 }
972
973 void blk_mq_debugfs_unregister_sched(struct request_queue *q)
974 {
975         debugfs_remove_recursive(q->sched_debugfs_dir);
976         q->sched_debugfs_dir = NULL;
977 }
978
979 int blk_mq_debugfs_register_sched_hctx(struct request_queue *q,
980                                        struct blk_mq_hw_ctx *hctx)
981 {
982         struct elevator_type *e = q->elevator->type;
983
984         if (!hctx->debugfs_dir)
985                 return -ENOENT;
986
987         if (!e->hctx_debugfs_attrs)
988                 return 0;
989
990         hctx->sched_debugfs_dir = debugfs_create_dir("sched",
991                                                      hctx->debugfs_dir);
992         if (!hctx->sched_debugfs_dir)
993                 return -ENOMEM;
994
995         if (!debugfs_create_files(hctx->sched_debugfs_dir, hctx,
996                                   e->hctx_debugfs_attrs))
997                 return -ENOMEM;
998
999         return 0;
1000 }
1001
1002 void blk_mq_debugfs_unregister_sched_hctx(struct blk_mq_hw_ctx *hctx)
1003 {
1004         debugfs_remove_recursive(hctx->sched_debugfs_dir);
1005         hctx->sched_debugfs_dir = NULL;
1006 }