linux/net/ceph/debugfs.c
<<
>>
Prefs
   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
  11#include <linux/ceph/libceph.h>
  12#include <linux/ceph/mon_client.h>
  13#include <linux/ceph/auth.h>
  14#include <linux/ceph/debugfs.h>
  15
  16#ifdef CONFIG_DEBUG_FS
  17
  18/*
  19 * Implement /sys/kernel/debug/ceph fun
  20 *
  21 * /sys/kernel/debug/ceph/client*  - an instance of the ceph client
  22 *      .../osdmap      - current osdmap
  23 *      .../monmap      - current monmap
  24 *      .../osdc        - active osd requests
  25 *      .../monc        - mon client state
  26 *      .../client_options - libceph-only (i.e. not rbd or cephfs) options
  27 *      .../dentry_lru  - dump contents of dentry lru
  28 *      .../caps        - expose cap (reservation) stats
  29 *      .../bdi         - symlink to ../../bdi/something
  30 */
  31
  32static struct dentry *ceph_debugfs_dir;
  33
  34static int monmap_show(struct seq_file *s, void *p)
  35{
  36        int i;
  37        struct ceph_client *client = s->private;
  38
  39        if (client->monc.monmap == NULL)
  40                return 0;
  41
  42        seq_printf(s, "epoch %d\n", client->monc.monmap->epoch);
  43        for (i = 0; i < client->monc.monmap->num_mon; i++) {
  44                struct ceph_entity_inst *inst =
  45                        &client->monc.monmap->mon_inst[i];
  46
  47                seq_printf(s, "\t%s%lld\t%s\n",
  48                           ENTITY_NAME(inst->name),
  49                           ceph_pr_addr(&inst->addr));
  50        }
  51        return 0;
  52}
  53
  54static int osdmap_show(struct seq_file *s, void *p)
  55{
  56        int i;
  57        struct ceph_client *client = s->private;
  58        struct ceph_osd_client *osdc = &client->osdc;
  59        struct ceph_osdmap *map = osdc->osdmap;
  60        struct rb_node *n;
  61
  62        if (map == NULL)
  63                return 0;
  64
  65        down_read(&osdc->lock);
  66        seq_printf(s, "epoch %u barrier %u flags 0x%x\n", map->epoch,
  67                        osdc->epoch_barrier, map->flags);
  68
  69        for (n = rb_first(&map->pg_pools); n; n = rb_next(n)) {
  70                struct ceph_pg_pool_info *pi =
  71                        rb_entry(n, struct ceph_pg_pool_info, node);
  72
  73                seq_printf(s, "pool %lld '%s' type %d size %d min_size %d pg_num %u pg_num_mask %d flags 0x%llx lfor %u read_tier %lld write_tier %lld\n",
  74                           pi->id, pi->name, pi->type, pi->size, pi->min_size,
  75                           pi->pg_num, pi->pg_num_mask, pi->flags,
  76                           pi->last_force_request_resend, pi->read_tier,
  77                           pi->write_tier);
  78        }
  79        for (i = 0; i < map->max_osd; i++) {
  80                struct ceph_entity_addr *addr = &map->osd_addr[i];
  81                u32 state = map->osd_state[i];
  82                char sb[64];
  83
  84                seq_printf(s, "osd%d\t%s\t%3d%%\t(%s)\t%3d%%\n",
  85                           i, ceph_pr_addr(addr),
  86                           ((map->osd_weight[i]*100) >> 16),
  87                           ceph_osdmap_state_str(sb, sizeof(sb), state),
  88                           ((ceph_get_primary_affinity(map, i)*100) >> 16));
  89        }
  90        for (n = rb_first(&map->pg_temp); n; n = rb_next(n)) {
  91                struct ceph_pg_mapping *pg =
  92                        rb_entry(n, struct ceph_pg_mapping, node);
  93
  94                seq_printf(s, "pg_temp %llu.%x [", pg->pgid.pool,
  95                           pg->pgid.seed);
  96                for (i = 0; i < pg->pg_temp.len; i++)
  97                        seq_printf(s, "%s%d", (i == 0 ? "" : ","),
  98                                   pg->pg_temp.osds[i]);
  99                seq_printf(s, "]\n");
 100        }
 101        for (n = rb_first(&map->primary_temp); n; n = rb_next(n)) {
 102                struct ceph_pg_mapping *pg =
 103                        rb_entry(n, struct ceph_pg_mapping, node);
 104
 105                seq_printf(s, "primary_temp %llu.%x %d\n", pg->pgid.pool,
 106                           pg->pgid.seed, pg->primary_temp.osd);
 107        }
 108        for (n = rb_first(&map->pg_upmap); n; n = rb_next(n)) {
 109                struct ceph_pg_mapping *pg =
 110                        rb_entry(n, struct ceph_pg_mapping, node);
 111
 112                seq_printf(s, "pg_upmap %llu.%x [", pg->pgid.pool,
 113                           pg->pgid.seed);
 114                for (i = 0; i < pg->pg_upmap.len; i++)
 115                        seq_printf(s, "%s%d", (i == 0 ? "" : ","),
 116                                   pg->pg_upmap.osds[i]);
 117                seq_printf(s, "]\n");
 118        }
 119        for (n = rb_first(&map->pg_upmap_items); n; n = rb_next(n)) {
 120                struct ceph_pg_mapping *pg =
 121                        rb_entry(n, struct ceph_pg_mapping, node);
 122
 123                seq_printf(s, "pg_upmap_items %llu.%x [", pg->pgid.pool,
 124                           pg->pgid.seed);
 125                for (i = 0; i < pg->pg_upmap_items.len; i++)
 126                        seq_printf(s, "%s%d->%d", (i == 0 ? "" : ","),
 127                                   pg->pg_upmap_items.from_to[i][0],
 128                                   pg->pg_upmap_items.from_to[i][1]);
 129                seq_printf(s, "]\n");
 130        }
 131
 132        up_read(&osdc->lock);
 133        return 0;
 134}
 135
 136static int monc_show(struct seq_file *s, void *p)
 137{
 138        struct ceph_client *client = s->private;
 139        struct ceph_mon_generic_request *req;
 140        struct ceph_mon_client *monc = &client->monc;
 141        struct rb_node *rp;
 142        int i;
 143
 144        mutex_lock(&monc->mutex);
 145
 146        for (i = 0; i < ARRAY_SIZE(monc->subs); i++) {
 147                seq_printf(s, "have %s %u", ceph_sub_str[i],
 148                           monc->subs[i].have);
 149                if (monc->subs[i].want)
 150                        seq_printf(s, " want %llu%s",
 151                                   le64_to_cpu(monc->subs[i].item.start),
 152                                   (monc->subs[i].item.flags &
 153                                        CEPH_SUBSCRIBE_ONETIME ?  "" : "+"));
 154                seq_putc(s, '\n');
 155        }
 156        seq_printf(s, "fs_cluster_id %d\n", monc->fs_cluster_id);
 157
 158        for (rp = rb_first(&monc->generic_request_tree); rp; rp = rb_next(rp)) {
 159                __u16 op;
 160                req = rb_entry(rp, struct ceph_mon_generic_request, node);
 161                op = le16_to_cpu(req->request->hdr.type);
 162                if (op == CEPH_MSG_STATFS)
 163                        seq_printf(s, "%llu statfs\n", req->tid);
 164                else if (op == CEPH_MSG_MON_GET_VERSION)
 165                        seq_printf(s, "%llu mon_get_version", req->tid);
 166                else
 167                        seq_printf(s, "%llu unknown\n", req->tid);
 168        }
 169
 170        mutex_unlock(&monc->mutex);
 171        return 0;
 172}
 173
 174static void dump_spgid(struct seq_file *s, const struct ceph_spg *spgid)
 175{
 176        seq_printf(s, "%llu.%x", spgid->pgid.pool, spgid->pgid.seed);
 177        if (spgid->shard != CEPH_SPG_NOSHARD)
 178                seq_printf(s, "s%d", spgid->shard);
 179}
 180
 181static void dump_target(struct seq_file *s, struct ceph_osd_request_target *t)
 182{
 183        int i;
 184
 185        seq_printf(s, "osd%d\t%llu.%x\t", t->osd, t->pgid.pool, t->pgid.seed);
 186        dump_spgid(s, &t->spgid);
 187        seq_puts(s, "\t[");
 188        for (i = 0; i < t->up.size; i++)
 189                seq_printf(s, "%s%d", (!i ? "" : ","), t->up.osds[i]);
 190        seq_printf(s, "]/%d\t[", t->up.primary);
 191        for (i = 0; i < t->acting.size; i++)
 192                seq_printf(s, "%s%d", (!i ? "" : ","), t->acting.osds[i]);
 193        seq_printf(s, "]/%d\te%u\t", t->acting.primary, t->epoch);
 194        if (t->target_oloc.pool_ns) {
 195                seq_printf(s, "%*pE/%*pE\t0x%x",
 196                        (int)t->target_oloc.pool_ns->len,
 197                        t->target_oloc.pool_ns->str,
 198                        t->target_oid.name_len, t->target_oid.name, t->flags);
 199        } else {
 200                seq_printf(s, "%*pE\t0x%x", t->target_oid.name_len,
 201                        t->target_oid.name, t->flags);
 202        }
 203        if (t->paused)
 204                seq_puts(s, "\tP");
 205}
 206
 207static void dump_request(struct seq_file *s, struct ceph_osd_request *req)
 208{
 209        int i;
 210
 211        seq_printf(s, "%llu\t", req->r_tid);
 212        dump_target(s, &req->r_t);
 213
 214        seq_printf(s, "\t%d", req->r_attempts);
 215
 216        for (i = 0; i < req->r_num_ops; i++) {
 217                struct ceph_osd_req_op *op = &req->r_ops[i];
 218
 219                seq_printf(s, "%s%s", (i == 0 ? "\t" : ","),
 220                           ceph_osd_op_name(op->op));
 221                if (op->op == CEPH_OSD_OP_WATCH)
 222                        seq_printf(s, "-%s",
 223                                   ceph_osd_watch_op_name(op->watch.op));
 224        }
 225
 226        seq_putc(s, '\n');
 227}
 228
 229static void dump_requests(struct seq_file *s, struct ceph_osd *osd)
 230{
 231        struct rb_node *n;
 232
 233        mutex_lock(&osd->lock);
 234        for (n = rb_first(&osd->o_requests); n; n = rb_next(n)) {
 235                struct ceph_osd_request *req =
 236                    rb_entry(n, struct ceph_osd_request, r_node);
 237
 238                dump_request(s, req);
 239        }
 240
 241        mutex_unlock(&osd->lock);
 242}
 243
 244static void dump_linger_request(struct seq_file *s,
 245                                struct ceph_osd_linger_request *lreq)
 246{
 247        seq_printf(s, "%llu\t", lreq->linger_id);
 248        dump_target(s, &lreq->t);
 249
 250        seq_printf(s, "\t%u\t%s%s/%d\n", lreq->register_gen,
 251                   lreq->is_watch ? "W" : "N", lreq->committed ? "C" : "",
 252                   lreq->last_error);
 253}
 254
 255static void dump_linger_requests(struct seq_file *s, struct ceph_osd *osd)
 256{
 257        struct rb_node *n;
 258
 259        mutex_lock(&osd->lock);
 260        for (n = rb_first(&osd->o_linger_requests); n; n = rb_next(n)) {
 261                struct ceph_osd_linger_request *lreq =
 262                    rb_entry(n, struct ceph_osd_linger_request, node);
 263
 264                dump_linger_request(s, lreq);
 265        }
 266
 267        mutex_unlock(&osd->lock);
 268}
 269
 270static void dump_snapid(struct seq_file *s, u64 snapid)
 271{
 272        if (snapid == CEPH_NOSNAP)
 273                seq_puts(s, "head");
 274        else if (snapid == CEPH_SNAPDIR)
 275                seq_puts(s, "snapdir");
 276        else
 277                seq_printf(s, "%llx", snapid);
 278}
 279
 280static void dump_name_escaped(struct seq_file *s, unsigned char *name,
 281                              size_t len)
 282{
 283        size_t i;
 284
 285        for (i = 0; i < len; i++) {
 286                if (name[i] == '%' || name[i] == ':' || name[i] == '/' ||
 287                    name[i] < 32 || name[i] >= 127) {
 288                        seq_printf(s, "%%%02x", name[i]);
 289                } else {
 290                        seq_putc(s, name[i]);
 291                }
 292        }
 293}
 294
 295static void dump_hoid(struct seq_file *s, const struct ceph_hobject_id *hoid)
 296{
 297        if (hoid->snapid == 0 && hoid->hash == 0 && !hoid->is_max &&
 298            hoid->pool == S64_MIN) {
 299                seq_puts(s, "MIN");
 300                return;
 301        }
 302        if (hoid->is_max) {
 303                seq_puts(s, "MAX");
 304                return;
 305        }
 306        seq_printf(s, "%lld:%08x:", hoid->pool, hoid->hash_reverse_bits);
 307        dump_name_escaped(s, hoid->nspace, hoid->nspace_len);
 308        seq_putc(s, ':');
 309        dump_name_escaped(s, hoid->key, hoid->key_len);
 310        seq_putc(s, ':');
 311        dump_name_escaped(s, hoid->oid, hoid->oid_len);
 312        seq_putc(s, ':');
 313        dump_snapid(s, hoid->snapid);
 314}
 315
 316static void dump_backoffs(struct seq_file *s, struct ceph_osd *osd)
 317{
 318        struct rb_node *n;
 319
 320        mutex_lock(&osd->lock);
 321        for (n = rb_first(&osd->o_backoffs_by_id); n; n = rb_next(n)) {
 322                struct ceph_osd_backoff *backoff =
 323                    rb_entry(n, struct ceph_osd_backoff, id_node);
 324
 325                seq_printf(s, "osd%d\t", osd->o_osd);
 326                dump_spgid(s, &backoff->spgid);
 327                seq_printf(s, "\t%llu\t", backoff->id);
 328                dump_hoid(s, backoff->begin);
 329                seq_putc(s, '\t');
 330                dump_hoid(s, backoff->end);
 331                seq_putc(s, '\n');
 332        }
 333
 334        mutex_unlock(&osd->lock);
 335}
 336
 337static int osdc_show(struct seq_file *s, void *pp)
 338{
 339        struct ceph_client *client = s->private;
 340        struct ceph_osd_client *osdc = &client->osdc;
 341        struct rb_node *n;
 342
 343        down_read(&osdc->lock);
 344        seq_printf(s, "REQUESTS %d homeless %d\n",
 345                   atomic_read(&osdc->num_requests),
 346                   atomic_read(&osdc->num_homeless));
 347        for (n = rb_first(&osdc->osds); n; n = rb_next(n)) {
 348                struct ceph_osd *osd = rb_entry(n, struct ceph_osd, o_node);
 349
 350                dump_requests(s, osd);
 351        }
 352        dump_requests(s, &osdc->homeless_osd);
 353
 354        seq_puts(s, "LINGER REQUESTS\n");
 355        for (n = rb_first(&osdc->osds); n; n = rb_next(n)) {
 356                struct ceph_osd *osd = rb_entry(n, struct ceph_osd, o_node);
 357
 358                dump_linger_requests(s, osd);
 359        }
 360        dump_linger_requests(s, &osdc->homeless_osd);
 361
 362        seq_puts(s, "BACKOFFS\n");
 363        for (n = rb_first(&osdc->osds); n; n = rb_next(n)) {
 364                struct ceph_osd *osd = rb_entry(n, struct ceph_osd, o_node);
 365
 366                dump_backoffs(s, osd);
 367        }
 368
 369        up_read(&osdc->lock);
 370        return 0;
 371}
 372
 373static int client_options_show(struct seq_file *s, void *p)
 374{
 375        struct ceph_client *client = s->private;
 376        int ret;
 377
 378        ret = ceph_print_client_options(s, client, true);
 379        if (ret)
 380                return ret;
 381
 382        seq_putc(s, '\n');
 383        return 0;
 384}
 385
 386CEPH_DEFINE_SHOW_FUNC(monmap_show)
 387CEPH_DEFINE_SHOW_FUNC(osdmap_show)
 388CEPH_DEFINE_SHOW_FUNC(monc_show)
 389CEPH_DEFINE_SHOW_FUNC(osdc_show)
 390CEPH_DEFINE_SHOW_FUNC(client_options_show)
 391
 392void __init ceph_debugfs_init(void)
 393{
 394        ceph_debugfs_dir = debugfs_create_dir("ceph", NULL);
 395}
 396
 397void ceph_debugfs_cleanup(void)
 398{
 399        debugfs_remove(ceph_debugfs_dir);
 400}
 401
 402void ceph_debugfs_client_init(struct ceph_client *client)
 403{
 404        char name[80];
 405
 406        snprintf(name, sizeof(name), "%pU.client%lld", &client->fsid,
 407                 client->monc.auth->global_id);
 408
 409        dout("ceph_debugfs_client_init %p %s\n", client, name);
 410
 411        client->debugfs_dir = debugfs_create_dir(name, ceph_debugfs_dir);
 412
 413        client->monc.debugfs_file = debugfs_create_file("monc",
 414                                                      0400,
 415                                                      client->debugfs_dir,
 416                                                      client,
 417                                                      &monc_show_fops);
 418
 419        client->osdc.debugfs_file = debugfs_create_file("osdc",
 420                                                      0400,
 421                                                      client->debugfs_dir,
 422                                                      client,
 423                                                      &osdc_show_fops);
 424
 425        client->debugfs_monmap = debugfs_create_file("monmap",
 426                                        0400,
 427                                        client->debugfs_dir,
 428                                        client,
 429                                        &monmap_show_fops);
 430
 431        client->debugfs_osdmap = debugfs_create_file("osdmap",
 432                                        0400,
 433                                        client->debugfs_dir,
 434                                        client,
 435                                        &osdmap_show_fops);
 436
 437        client->debugfs_options = debugfs_create_file("client_options",
 438                                        0400,
 439                                        client->debugfs_dir,
 440                                        client,
 441                                        &client_options_show_fops);
 442}
 443
 444void ceph_debugfs_client_cleanup(struct ceph_client *client)
 445{
 446        dout("ceph_debugfs_client_cleanup %p\n", client);
 447        debugfs_remove(client->debugfs_options);
 448        debugfs_remove(client->debugfs_osdmap);
 449        debugfs_remove(client->debugfs_monmap);
 450        debugfs_remove(client->osdc.debugfs_file);
 451        debugfs_remove(client->monc.debugfs_file);
 452        debugfs_remove(client->debugfs_dir);
 453}
 454
 455#else  /* CONFIG_DEBUG_FS */
 456
 457void __init ceph_debugfs_init(void)
 458{
 459}
 460
 461void ceph_debugfs_cleanup(void)
 462{
 463}
 464
 465void ceph_debugfs_client_init(struct ceph_client *client)
 466{
 467}
 468
 469void ceph_debugfs_client_cleanup(struct ceph_client *client)
 470{
 471}
 472
 473#endif  /* CONFIG_DEBUG_FS */
 474