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