1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/ceph/ceph_debug.h>
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>
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>
16 #ifdef CONFIG_DEBUG_FS
19 * Implement /sys/kernel/debug/ceph fun
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
32 static struct dentry
*ceph_debugfs_dir
;
34 static int monmap_show(struct seq_file
*s
, void *p
)
37 struct ceph_client
*client
= s
->private;
39 if (client
->monc
.monmap
== NULL
)
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
];
47 seq_printf(s
, "\t%s%lld\t%s\n",
48 ENTITY_NAME(inst
->name
),
49 ceph_pr_addr(&inst
->addr
));
54 static int osdmap_show(struct seq_file
*s
, void *p
)
57 struct ceph_client
*client
= s
->private;
58 struct ceph_osd_client
*osdc
= &client
->osdc
;
59 struct ceph_osdmap
*map
= osdc
->osdmap
;
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
);
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
);
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
,
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
];
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));
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
);
94 seq_printf(s
, "pg_temp %llu.%x [", pg
->pgid
.pool
,
96 for (i
= 0; i
< pg
->pg_temp
.len
; i
++)
97 seq_printf(s
, "%s%d", (i
== 0 ? "" : ","),
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
);
105 seq_printf(s
, "primary_temp %llu.%x %d\n", pg
->pgid
.pool
,
106 pg
->pgid
.seed
, pg
->primary_temp
.osd
);
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
);
112 seq_printf(s
, "pg_upmap %llu.%x [", pg
->pgid
.pool
,
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");
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
);
123 seq_printf(s
, "pg_upmap_items %llu.%x [", pg
->pgid
.pool
,
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");
132 up_read(&osdc
->lock
);
136 static int monc_show(struct seq_file
*s
, void *p
)
138 struct ceph_client
*client
= s
->private;
139 struct ceph_mon_generic_request
*req
;
140 struct ceph_mon_client
*monc
= &client
->monc
;
144 mutex_lock(&monc
->mutex
);
146 for (i
= 0; i
< ARRAY_SIZE(monc
->subs
); i
++) {
147 seq_printf(s
, "have %s %u", ceph_sub_str
[i
],
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
? "" : "+"));
156 seq_printf(s
, "fs_cluster_id %d\n", monc
->fs_cluster_id
);
158 for (rp
= rb_first(&monc
->generic_request_tree
); rp
; rp
= rb_next(rp
)) {
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
);
167 seq_printf(s
, "%llu unknown\n", req
->tid
);
170 mutex_unlock(&monc
->mutex
);
174 static void dump_spgid(struct seq_file
*s
, const struct ceph_spg
*spgid
)
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
);
181 static void dump_target(struct seq_file
*s
, struct ceph_osd_request_target
*t
)
185 seq_printf(s
, "osd%d\t%llu.%x\t", t
->osd
, t
->pgid
.pool
, t
->pgid
.seed
);
186 dump_spgid(s
, &t
->spgid
);
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
);
200 seq_printf(s
, "%*pE\t0x%x", t
->target_oid
.name_len
,
201 t
->target_oid
.name
, t
->flags
);
207 static void dump_request(struct seq_file
*s
, struct ceph_osd_request
*req
)
211 seq_printf(s
, "%llu\t", req
->r_tid
);
212 dump_target(s
, &req
->r_t
);
214 seq_printf(s
, "\t%d", req
->r_attempts
);
216 for (i
= 0; i
< req
->r_num_ops
; i
++) {
217 struct ceph_osd_req_op
*op
= &req
->r_ops
[i
];
219 seq_printf(s
, "%s%s", (i
== 0 ? "\t" : ","),
220 ceph_osd_op_name(op
->op
));
221 if (op
->op
== CEPH_OSD_OP_WATCH
)
223 ceph_osd_watch_op_name(op
->watch
.op
));
229 static void dump_requests(struct seq_file
*s
, struct ceph_osd
*osd
)
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
);
238 dump_request(s
, req
);
241 mutex_unlock(&osd
->lock
);
244 static void dump_linger_request(struct seq_file
*s
,
245 struct ceph_osd_linger_request
*lreq
)
247 seq_printf(s
, "%llu\t", lreq
->linger_id
);
248 dump_target(s
, &lreq
->t
);
250 seq_printf(s
, "\t%u\t%s%s/%d\n", lreq
->register_gen
,
251 lreq
->is_watch
? "W" : "N", lreq
->committed
? "C" : "",
255 static void dump_linger_requests(struct seq_file
*s
, struct ceph_osd
*osd
)
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
);
264 dump_linger_request(s
, lreq
);
267 mutex_unlock(&osd
->lock
);
270 static void dump_snapid(struct seq_file
*s
, u64 snapid
)
272 if (snapid
== CEPH_NOSNAP
)
274 else if (snapid
== CEPH_SNAPDIR
)
275 seq_puts(s
, "snapdir");
277 seq_printf(s
, "%llx", snapid
);
280 static void dump_name_escaped(struct seq_file
*s
, unsigned char *name
,
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
]);
290 seq_putc(s
, name
[i
]);
295 static void dump_hoid(struct seq_file
*s
, const struct ceph_hobject_id
*hoid
)
297 if (hoid
->snapid
== 0 && hoid
->hash
== 0 && !hoid
->is_max
&&
298 hoid
->pool
== S64_MIN
) {
306 seq_printf(s
, "%lld:%08x:", hoid
->pool
, hoid
->hash_reverse_bits
);
307 dump_name_escaped(s
, hoid
->nspace
, hoid
->nspace_len
);
309 dump_name_escaped(s
, hoid
->key
, hoid
->key_len
);
311 dump_name_escaped(s
, hoid
->oid
, hoid
->oid_len
);
313 dump_snapid(s
, hoid
->snapid
);
316 static void dump_backoffs(struct seq_file
*s
, struct ceph_osd
*osd
)
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
);
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
);
330 dump_hoid(s
, backoff
->end
);
334 mutex_unlock(&osd
->lock
);
337 static int osdc_show(struct seq_file
*s
, void *pp
)
339 struct ceph_client
*client
= s
->private;
340 struct ceph_osd_client
*osdc
= &client
->osdc
;
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
);
350 dump_requests(s
, osd
);
352 dump_requests(s
, &osdc
->homeless_osd
);
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
);
358 dump_linger_requests(s
, osd
);
360 dump_linger_requests(s
, &osdc
->homeless_osd
);
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
);
366 dump_backoffs(s
, osd
);
369 up_read(&osdc
->lock
);
373 static int client_options_show(struct seq_file
*s
, void *p
)
375 struct ceph_client
*client
= s
->private;
378 ret
= ceph_print_client_options(s
, client
, true);
386 CEPH_DEFINE_SHOW_FUNC(monmap_show
)
387 CEPH_DEFINE_SHOW_FUNC(osdmap_show
)
388 CEPH_DEFINE_SHOW_FUNC(monc_show
)
389 CEPH_DEFINE_SHOW_FUNC(osdc_show
)
390 CEPH_DEFINE_SHOW_FUNC(client_options_show
)
392 void __init
ceph_debugfs_init(void)
394 ceph_debugfs_dir
= debugfs_create_dir("ceph", NULL
);
397 void ceph_debugfs_cleanup(void)
399 debugfs_remove(ceph_debugfs_dir
);
402 void ceph_debugfs_client_init(struct ceph_client
*client
)
406 snprintf(name
, sizeof(name
), "%pU.client%lld", &client
->fsid
,
407 client
->monc
.auth
->global_id
);
409 dout("ceph_debugfs_client_init %p %s\n", client
, name
);
411 client
->debugfs_dir
= debugfs_create_dir(name
, ceph_debugfs_dir
);
413 client
->monc
.debugfs_file
= debugfs_create_file("monc",
419 client
->osdc
.debugfs_file
= debugfs_create_file("osdc",
425 client
->debugfs_monmap
= debugfs_create_file("monmap",
431 client
->debugfs_osdmap
= debugfs_create_file("osdmap",
437 client
->debugfs_options
= debugfs_create_file("client_options",
441 &client_options_show_fops
);
444 void ceph_debugfs_client_cleanup(struct ceph_client
*client
)
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
);
455 #else /* CONFIG_DEBUG_FS */
457 void __init
ceph_debugfs_init(void)
461 void ceph_debugfs_cleanup(void)
465 void ceph_debugfs_client_init(struct ceph_client
*client
)
469 void ceph_debugfs_client_cleanup(struct ceph_client
*client
)
473 #endif /* CONFIG_DEBUG_FS */