block/blk-mq-debugfs.c

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