fs/ceph/debugfs.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include <linux/ceph/ceph_debug.h>
   3
   4 #include <linux/device.h>
   5 #include <linux/slab.h>
   6 #include <linux/module.h>
   7 #include <linux/ctype.h>
   8 #include <linux/debugfs.h>
   9 #include <linux/seq_file.h>
  10 #include <linux/math64.h>
  11 #include <linux/ktime.h>
  12
  13 #include <linux/ceph/libceph.h>
  14 #include <linux/ceph/mon_client.h>
  15 #include <linux/ceph/auth.h>
  16 #include <linux/ceph/debugfs.h>
  17
  18 #include "super.h"
  19
  20 #ifdef CONFIG_DEBUG_FS
  21
  22 #include "mds_client.h"
  23 #include "metric.h"
  24
  25 static int mdsmap_show(struct seq_file *s, void *p)
  26 {
  27         int i;
  28         struct ceph_fs_client *fsc = s->private;
  29         struct ceph_mdsmap *mdsmap;
  30
  31         if (!fsc->mdsc || !fsc->mdsc->mdsmap)
  32                 return 0;
  33         mdsmap = fsc->mdsc->mdsmap;
  34         seq_printf(s, "epoch %d\n", mdsmap->m_epoch);
  35         seq_printf(s, "root %d\n", mdsmap->m_root);
  36         seq_printf(s, "max_mds %d\n", mdsmap->m_max_mds);
  37         seq_printf(s, "session_timeout %d\n", mdsmap->m_session_timeout);
  38         seq_printf(s, "session_autoclose %d\n", mdsmap->m_session_autoclose);
  39         for (i = 0; i < mdsmap->possible_max_rank; i++) {
  40                 struct ceph_entity_addr *addr = &mdsmap->m_info[i].addr;
  41                 int state = mdsmap->m_info[i].state;
  42                 seq_printf(s, "\tmds%d\t%s\t(%s)\n", i,
  43                                ceph_pr_addr(addr),
  44                                ceph_mds_state_name(state));
  45         }
  46         return 0;
  47 }
  48
  49 /*
  50  * mdsc debugfs
  51  */
  52 static int mdsc_show(struct seq_file *s, void *p)
  53 {
  54         struct ceph_fs_client *fsc = s->private;
  55         struct ceph_mds_client *mdsc = fsc->mdsc;
  56         struct ceph_mds_request *req;
  57         struct rb_node *rp;
  58         int pathlen = 0;
  59         u64 pathbase;
  60         char *path;
  61
  62         mutex_lock(&mdsc->mutex);
  63         for (rp = rb_first(&mdsc->request_tree); rp; rp = rb_next(rp)) {
  64                 req = rb_entry(rp, struct ceph_mds_request, r_node);
  65
  66                 if (req->r_request && req->r_session)
  67                         seq_printf(s, "%lld\tmds%d\t", req->r_tid,
  68                                    req->r_session->s_mds);
  69                 else if (!req->r_request)
  70                         seq_printf(s, "%lld\t(no request)\t", req->r_tid);
  71                 else
  72                         seq_printf(s, "%lld\t(no session)\t", req->r_tid);
  73
  74                 seq_printf(s, "%s", ceph_mds_op_name(req->r_op));
  75
  76                 if (test_bit(CEPH_MDS_R_GOT_UNSAFE, &req->r_req_flags))
  77                         seq_puts(s, "\t(unsafe)");
  78                 else
  79                         seq_puts(s, "\t");
  80
  81                 if (req->r_inode) {
  82                         seq_printf(s, " #%llx", ceph_ino(req->r_inode));
  83                 } else if (req->r_dentry) {
  84                         path = ceph_mdsc_build_path(req->r_dentry, &pathlen,
  85                                                     &pathbase, 0);
  86                         if (IS_ERR(path))
  87                                 path = NULL;
  88                         spin_lock(&req->r_dentry->d_lock);
  89                         seq_printf(s, " #%llx/%pd (%s)",
  90                                    ceph_ino(d_inode(req->r_dentry->d_parent)),
  91                                    req->r_dentry,
  92                                    path ? path : "");
  93                         spin_unlock(&req->r_dentry->d_lock);
  94                         ceph_mdsc_free_path(path, pathlen);
  95                 } else if (req->r_path1) {
  96                         seq_printf(s, " #%llx/%s", req->r_ino1.ino,
  97                                    req->r_path1);
  98                 } else {
  99                         seq_printf(s, " #%llx", req->r_ino1.ino);
 100                 }
 101
 102                 if (req->r_old_dentry) {
 103                         path = ceph_mdsc_build_path(req->r_old_dentry, &pathlen,
 104                                                     &pathbase, 0);
 105                         if (IS_ERR(path))
 106                                 path = NULL;
 107                         spin_lock(&req->r_old_dentry->d_lock);
 108                         seq_printf(s, " #%llx/%pd (%s)",
 109                                    req->r_old_dentry_dir ?
 110                                    ceph_ino(req->r_old_dentry_dir) : 0,
 111                                    req->r_old_dentry,
 112                                    path ? path : "");
 113                         spin_unlock(&req->r_old_dentry->d_lock);
 114                         ceph_mdsc_free_path(path, pathlen);
 115                 } else if (req->r_path2 && req->r_op != CEPH_MDS_OP_SYMLINK) {
 116                         if (req->r_ino2.ino)
 117                                 seq_printf(s, " #%llx/%s", req->r_ino2.ino,
 118                                            req->r_path2);
 119                         else
 120                                 seq_printf(s, " %s", req->r_path2);
 121                 }
 122
 123                 seq_puts(s, "\n");
 124         }
 125         mutex_unlock(&mdsc->mutex);
 126
 127         return 0;
 128 }
 129
 130 #define CEPH_METRIC_SHOW(name, total, avg, min, max, sq) {              \
 131         s64 _total, _avg, _min, _max, _sq, _st;                         \
 132         _avg = ktime_to_us(avg);                                        \
 133         _min = ktime_to_us(min == KTIME_MAX ? 0 : min);                 \
 134         _max = ktime_to_us(max);                                        \
 135         _total = total - 1;                                             \
 136         _sq = _total > 0 ? DIV64_U64_ROUND_CLOSEST(sq, _total) : 0;     \
 137         _st = int_sqrt64(_sq);                                          \
 138         _st = ktime_to_us(_st);                                         \
 139         seq_printf(s, "%-14s%-12lld%-16lld%-16lld%-16lld%lld\n",        \
 140                    name, total, _avg, _min, _max, _st);                 \
 141 }
 142
 143 static int metric_show(struct seq_file *s, void *p)
 144 {
 145         struct ceph_fs_client *fsc = s->private;
 146         struct ceph_mds_client *mdsc = fsc->mdsc;
 147         struct ceph_client_metric *m = &mdsc->metric;
 148         int nr_caps = 0;
 149         s64 total, sum, avg, min, max, sq;
 150
 151         sum = percpu_counter_sum(&m->total_inodes);
 152         seq_printf(s, "item                               total\n");
 153         seq_printf(s, "------------------------------------------\n");
 154         seq_printf(s, "%-35s%lld / %lld\n", "opened files  / total inodes",
 155                    atomic64_read(&m->opened_files), sum);
 156         seq_printf(s, "%-35s%lld / %lld\n", "pinned i_caps / total inodes",
 157                    atomic64_read(&m->total_caps), sum);
 158         seq_printf(s, "%-35s%lld / %lld\n", "opened inodes / total inodes",
 159                    percpu_counter_sum(&m->opened_inodes), sum);
 160
 161         seq_printf(s, "\n");
 162         seq_printf(s, "item          total       avg_lat(us)     min_lat(us)     max_lat(us)     stdev(us)\n");
 163         seq_printf(s, "-----------------------------------------------------------------------------------\n");
 164
 165         spin_lock(&m->read_latency_lock);
 166         total = m->total_reads;
 167         sum = m->read_latency_sum;
 168         avg = total > 0 ? DIV64_U64_ROUND_CLOSEST(sum, total) : 0;
 169         min = m->read_latency_min;
 170         max = m->read_latency_max;
 171         sq = m->read_latency_sq_sum;
 172         spin_unlock(&m->read_latency_lock);
 173         CEPH_METRIC_SHOW("read", total, avg, min, max, sq);
 174
 175         spin_lock(&m->write_latency_lock);
 176         total = m->total_writes;
 177         sum = m->write_latency_sum;
 178         avg = total > 0 ? DIV64_U64_ROUND_CLOSEST(sum, total) : 0;
 179         min = m->write_latency_min;
 180         max = m->write_latency_max;
 181         sq = m->write_latency_sq_sum;
 182         spin_unlock(&m->write_latency_lock);
 183         CEPH_METRIC_SHOW("write", total, avg, min, max, sq);
 184
 185         spin_lock(&m->metadata_latency_lock);
 186         total = m->total_metadatas;
 187         sum = m->metadata_latency_sum;
 188         avg = total > 0 ? DIV64_U64_ROUND_CLOSEST(sum, total) : 0;
 189         min = m->metadata_latency_min;
 190         max = m->metadata_latency_max;
 191         sq = m->metadata_latency_sq_sum;
 192         spin_unlock(&m->metadata_latency_lock);
 193         CEPH_METRIC_SHOW("metadata", total, avg, min, max, sq);
 194
 195         seq_printf(s, "\n");
 196         seq_printf(s, "item          total           miss            hit\n");
 197         seq_printf(s, "-------------------------------------------------\n");
 198
 199         seq_printf(s, "%-14s%-16lld%-16lld%lld\n", "d_lease",
 200                    atomic64_read(&m->total_dentries),
 201                    percpu_counter_sum(&m->d_lease_mis),
 202                    percpu_counter_sum(&m->d_lease_hit));
 203
 204         nr_caps = atomic64_read(&m->total_caps);
 205         seq_printf(s, "%-14s%-16d%-16lld%lld\n", "caps", nr_caps,
 206                    percpu_counter_sum(&m->i_caps_mis),
 207                    percpu_counter_sum(&m->i_caps_hit));
 208
 209         return 0;
 210 }
 211
 212 static int caps_show_cb(struct inode *inode, struct ceph_cap *cap, void *p)
 213 {
 214         struct seq_file *s = p;
 215
 216         seq_printf(s, "0x%-17llx%-3d%-17s%-17s\n", ceph_ino(inode),
 217                    cap->session->s_mds,
 218                    ceph_cap_string(cap->issued),
 219                    ceph_cap_string(cap->implemented));
 220         return 0;
 221 }
 222
 223 static int caps_show(struct seq_file *s, void *p)
 224 {
 225         struct ceph_fs_client *fsc = s->private;
 226         struct ceph_mds_client *mdsc = fsc->mdsc;
 227         int total, avail, used, reserved, min, i;
 228         struct cap_wait *cw;
 229
 230         ceph_reservation_status(fsc, &total, &avail, &used, &reserved, &min);
 231         seq_printf(s, "total\t\t%d\n"
 232                    "avail\t\t%d\n"
 233                    "used\t\t%d\n"
 234                    "reserved\t%d\n"
 235                    "min\t\t%d\n\n",
 236                    total, avail, used, reserved, min);
 237         seq_printf(s, "ino              mds  issued           implemented\n");
 238         seq_printf(s, "--------------------------------------------------\n");
 239
 240         mutex_lock(&mdsc->mutex);
 241         for (i = 0; i < mdsc->max_sessions; i++) {
 242                 struct ceph_mds_session *session;
 243
 244                 session = __ceph_lookup_mds_session(mdsc, i);
 245                 if (!session)
 246                         continue;
 247                 mutex_unlock(&mdsc->mutex);
 248                 mutex_lock(&session->s_mutex);
 249                 ceph_iterate_session_caps(session, caps_show_cb, s);
 250                 mutex_unlock(&session->s_mutex);
 251                 ceph_put_mds_session(session);
 252                 mutex_lock(&mdsc->mutex);
 253         }
 254         mutex_unlock(&mdsc->mutex);
 255
 256         seq_printf(s, "\n\nWaiters:\n--------\n");
 257         seq_printf(s, "tgid         ino                need             want\n");
 258         seq_printf(s, "-----------------------------------------------------\n");
 259
 260         spin_lock(&mdsc->caps_list_lock);
 261         list_for_each_entry(cw, &mdsc->cap_wait_list, list) {
 262                 seq_printf(s, "%-13d0x%-17llx%-17s%-17s\n", cw->tgid, cw->ino,
 263                                 ceph_cap_string(cw->need),
 264                                 ceph_cap_string(cw->want));
 265         }
 266         spin_unlock(&mdsc->caps_list_lock);
 267
 268         return 0;
 269 }
 270
 271 static int mds_sessions_show(struct seq_file *s, void *ptr)
 272 {
 273         struct ceph_fs_client *fsc = s->private;
 274         struct ceph_mds_client *mdsc = fsc->mdsc;
 275         struct ceph_auth_client *ac = fsc->client->monc.auth;
 276         struct ceph_options *opt = fsc->client->options;
 277         int mds;
 278
 279         mutex_lock(&mdsc->mutex);
 280
 281         /* The 'num' portion of an 'entity name' */
 282         seq_printf(s, "global_id %llu\n", ac->global_id);
 283
 284         /* The -o name mount argument */
 285         seq_printf(s, "name \"%s\"\n", opt->name ? opt->name : "");
 286
 287         /* The list of MDS session rank+state */
 288         for (mds = 0; mds < mdsc->max_sessions; mds++) {
 289                 struct ceph_mds_session *session =
 290                         __ceph_lookup_mds_session(mdsc, mds);
 291                 if (!session) {
 292                         continue;
 293                 }
 294                 mutex_unlock(&mdsc->mutex);
 295                 seq_printf(s, "mds.%d %s\n",
 296                                 session->s_mds,
 297                                 ceph_session_state_name(session->s_state));
 298
 299                 ceph_put_mds_session(session);
 300                 mutex_lock(&mdsc->mutex);
 301         }
 302         mutex_unlock(&mdsc->mutex);
 303
 304         return 0;
 305 }
 306
 307 static int status_show(struct seq_file *s, void *p)
 308 {
 309         struct ceph_fs_client *fsc = s->private;
 310         struct ceph_entity_inst *inst = &fsc->client->msgr.inst;
 311         struct ceph_entity_addr *client_addr = ceph_client_addr(fsc->client);
 312
 313         seq_printf(s, "instance: %s.%lld %s/%u\n", ENTITY_NAME(inst->name),
 314                    ceph_pr_addr(client_addr), le32_to_cpu(client_addr->nonce));
 315         seq_printf(s, "blocklisted: %s\n", fsc->blocklisted ? "true" : "false");
 316
 317         return 0;
 318 }
 319
 320 DEFINE_SHOW_ATTRIBUTE(mdsmap);
 321 DEFINE_SHOW_ATTRIBUTE(mdsc);
 322 DEFINE_SHOW_ATTRIBUTE(caps);
 323 DEFINE_SHOW_ATTRIBUTE(mds_sessions);
 324 DEFINE_SHOW_ATTRIBUTE(metric);
 325 DEFINE_SHOW_ATTRIBUTE(status);
 326
 327
 328 /*
 329  * debugfs
 330  */
 331 static int congestion_kb_set(void *data, u64 val)
 332 {
 333         struct ceph_fs_client *fsc = (struct ceph_fs_client *)data;
 334
 335         fsc->mount_options->congestion_kb = (int)val;
 336         return 0;
 337 }
 338
 339 static int congestion_kb_get(void *data, u64 *val)
 340 {
 341         struct ceph_fs_client *fsc = (struct ceph_fs_client *)data;
 342
 343         *val = (u64)fsc->mount_options->congestion_kb;
 344         return 0;
 345 }
 346
 347 DEFINE_SIMPLE_ATTRIBUTE(congestion_kb_fops, congestion_kb_get,
 348                         congestion_kb_set, "%llu\n");
 349
 350
 351 void ceph_fs_debugfs_cleanup(struct ceph_fs_client *fsc)
 352 {
 353         dout("ceph_fs_debugfs_cleanup\n");
 354         debugfs_remove(fsc->debugfs_bdi);
 355         debugfs_remove(fsc->debugfs_congestion_kb);
 356         debugfs_remove(fsc->debugfs_mdsmap);
 357         debugfs_remove(fsc->debugfs_mds_sessions);
 358         debugfs_remove(fsc->debugfs_caps);
 359         debugfs_remove(fsc->debugfs_metric);
 360         debugfs_remove(fsc->debugfs_mdsc);
 361 }
 362
 363 void ceph_fs_debugfs_init(struct ceph_fs_client *fsc)
 364 {
 365         char name[100];
 366
 367         dout("ceph_fs_debugfs_init\n");
 368         fsc->debugfs_congestion_kb =
 369                 debugfs_create_file("writeback_congestion_kb",
 370                                     0600,
 371                                     fsc->client->debugfs_dir,
 372                                     fsc,
 373                                     &congestion_kb_fops);
 374
 375         snprintf(name, sizeof(name), "../../bdi/%s",
 376                  bdi_dev_name(fsc->sb->s_bdi));
 377         fsc->debugfs_bdi =
 378                 debugfs_create_symlink("bdi",
 379                                        fsc->client->debugfs_dir,
 380                                        name);
 381
 382         fsc->debugfs_mdsmap = debugfs_create_file("mdsmap",
 383                                         0400,
 384                                         fsc->client->debugfs_dir,
 385                                         fsc,
 386                                         &mdsmap_fops);
 387
 388         fsc->debugfs_mds_sessions = debugfs_create_file("mds_sessions",
 389                                         0400,
 390                                         fsc->client->debugfs_dir,
 391                                         fsc,
 392                                         &mds_sessions_fops);
 393
 394         fsc->debugfs_mdsc = debugfs_create_file("mdsc",
 395                                                 0400,
 396                                                 fsc->client->debugfs_dir,
 397                                                 fsc,
 398                                                 &mdsc_fops);
 399
 400         fsc->debugfs_metric = debugfs_create_file("metrics",
 401                                                   0400,
 402                                                   fsc->client->debugfs_dir,
 403                                                   fsc,
 404                                                   &metric_fops);
 405
 406         fsc->debugfs_caps = debugfs_create_file("caps",
 407                                                 0400,
 408                                                 fsc->client->debugfs_dir,
 409                                                 fsc,
 410                                                 &caps_fops);
 411
 412         fsc->debugfs_status = debugfs_create_file("status",
 413                                                   0400,
 414                                                   fsc->client->debugfs_dir,
 415                                                   fsc,
 416                                                   &status_fops);
 417 }
 418
 419
 420 #else  /* CONFIG_DEBUG_FS */
 421
 422 void ceph_fs_debugfs_init(struct ceph_fs_client *fsc)
 423 {
 424 }
 425
 426 void ceph_fs_debugfs_cleanup(struct ceph_fs_client *fsc)
 427 {
 428 }
 429
 430 #endif  /* CONFIG_DEBUG_FS */