xref: /openbmc/linux/net/ceph/debugfs.c (revision 293d5b43)
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 %d flags 0x%x\n", map->epoch, map->flags);
66 
67 	for (n = rb_first(&map->pg_pools); n; n = rb_next(n)) {
68 		struct ceph_pg_pool_info *pi =
69 			rb_entry(n, struct ceph_pg_pool_info, node);
70 
71 		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",
72 			   pi->id, pi->name, pi->type, pi->size, pi->min_size,
73 			   pi->pg_num, pi->pg_num_mask, pi->flags,
74 			   pi->last_force_request_resend, pi->read_tier,
75 			   pi->write_tier);
76 	}
77 	for (i = 0; i < map->max_osd; i++) {
78 		struct ceph_entity_addr *addr = &map->osd_addr[i];
79 		int state = map->osd_state[i];
80 		char sb[64];
81 
82 		seq_printf(s, "osd%d\t%s\t%3d%%\t(%s)\t%3d%%\n",
83 			   i, ceph_pr_addr(&addr->in_addr),
84 			   ((map->osd_weight[i]*100) >> 16),
85 			   ceph_osdmap_state_str(sb, sizeof(sb), state),
86 			   ((ceph_get_primary_affinity(map, i)*100) >> 16));
87 	}
88 	for (n = rb_first(&map->pg_temp); n; n = rb_next(n)) {
89 		struct ceph_pg_mapping *pg =
90 			rb_entry(n, struct ceph_pg_mapping, node);
91 
92 		seq_printf(s, "pg_temp %llu.%x [", pg->pgid.pool,
93 			   pg->pgid.seed);
94 		for (i = 0; i < pg->pg_temp.len; i++)
95 			seq_printf(s, "%s%d", (i == 0 ? "" : ","),
96 				   pg->pg_temp.osds[i]);
97 		seq_printf(s, "]\n");
98 	}
99 	for (n = rb_first(&map->primary_temp); n; n = rb_next(n)) {
100 		struct ceph_pg_mapping *pg =
101 			rb_entry(n, struct ceph_pg_mapping, node);
102 
103 		seq_printf(s, "primary_temp %llu.%x %d\n", pg->pgid.pool,
104 			   pg->pgid.seed, pg->primary_temp.osd);
105 	}
106 
107 	up_read(&osdc->lock);
108 	return 0;
109 }
110 
111 static int monc_show(struct seq_file *s, void *p)
112 {
113 	struct ceph_client *client = s->private;
114 	struct ceph_mon_generic_request *req;
115 	struct ceph_mon_client *monc = &client->monc;
116 	struct rb_node *rp;
117 	int i;
118 
119 	mutex_lock(&monc->mutex);
120 
121 	for (i = 0; i < ARRAY_SIZE(monc->subs); i++) {
122 		seq_printf(s, "have %s %u", ceph_sub_str[i],
123 			   monc->subs[i].have);
124 		if (monc->subs[i].want)
125 			seq_printf(s, " want %llu%s",
126 				   le64_to_cpu(monc->subs[i].item.start),
127 				   (monc->subs[i].item.flags &
128 					CEPH_SUBSCRIBE_ONETIME ?  "" : "+"));
129 		seq_putc(s, '\n');
130 	}
131 	seq_printf(s, "fs_cluster_id %d\n", monc->fs_cluster_id);
132 
133 	for (rp = rb_first(&monc->generic_request_tree); rp; rp = rb_next(rp)) {
134 		__u16 op;
135 		req = rb_entry(rp, struct ceph_mon_generic_request, node);
136 		op = le16_to_cpu(req->request->hdr.type);
137 		if (op == CEPH_MSG_STATFS)
138 			seq_printf(s, "%llu statfs\n", req->tid);
139 		else if (op == CEPH_MSG_MON_GET_VERSION)
140 			seq_printf(s, "%llu mon_get_version", req->tid);
141 		else
142 			seq_printf(s, "%llu unknown\n", req->tid);
143 	}
144 
145 	mutex_unlock(&monc->mutex);
146 	return 0;
147 }
148 
149 static void dump_target(struct seq_file *s, struct ceph_osd_request_target *t)
150 {
151 	int i;
152 
153 	seq_printf(s, "osd%d\t%llu.%x\t[", t->osd, t->pgid.pool, t->pgid.seed);
154 	for (i = 0; i < t->up.size; i++)
155 		seq_printf(s, "%s%d", (!i ? "" : ","), t->up.osds[i]);
156 	seq_printf(s, "]/%d\t[", t->up.primary);
157 	for (i = 0; i < t->acting.size; i++)
158 		seq_printf(s, "%s%d", (!i ? "" : ","), t->acting.osds[i]);
159 	seq_printf(s, "]/%d\t", t->acting.primary);
160 	if (t->target_oloc.pool_ns) {
161 		seq_printf(s, "%*pE/%*pE\t0x%x",
162 			(int)t->target_oloc.pool_ns->len,
163 			t->target_oloc.pool_ns->str,
164 			t->target_oid.name_len, t->target_oid.name, t->flags);
165 	} else {
166 		seq_printf(s, "%*pE\t0x%x", t->target_oid.name_len,
167 			t->target_oid.name, t->flags);
168 	}
169 	if (t->paused)
170 		seq_puts(s, "\tP");
171 }
172 
173 static void dump_request(struct seq_file *s, struct ceph_osd_request *req)
174 {
175 	int i;
176 
177 	seq_printf(s, "%llu\t", req->r_tid);
178 	dump_target(s, &req->r_t);
179 
180 	seq_printf(s, "\t%d\t%u'%llu", req->r_attempts,
181 		   le32_to_cpu(req->r_replay_version.epoch),
182 		   le64_to_cpu(req->r_replay_version.version));
183 
184 	for (i = 0; i < req->r_num_ops; i++) {
185 		struct ceph_osd_req_op *op = &req->r_ops[i];
186 
187 		seq_printf(s, "%s%s", (i == 0 ? "\t" : ","),
188 			   ceph_osd_op_name(op->op));
189 		if (op->op == CEPH_OSD_OP_WATCH)
190 			seq_printf(s, "-%s",
191 				   ceph_osd_watch_op_name(op->watch.op));
192 	}
193 
194 	seq_putc(s, '\n');
195 }
196 
197 static void dump_requests(struct seq_file *s, struct ceph_osd *osd)
198 {
199 	struct rb_node *n;
200 
201 	mutex_lock(&osd->lock);
202 	for (n = rb_first(&osd->o_requests); n; n = rb_next(n)) {
203 		struct ceph_osd_request *req =
204 		    rb_entry(n, struct ceph_osd_request, r_node);
205 
206 		dump_request(s, req);
207 	}
208 
209 	mutex_unlock(&osd->lock);
210 }
211 
212 static void dump_linger_request(struct seq_file *s,
213 				struct ceph_osd_linger_request *lreq)
214 {
215 	seq_printf(s, "%llu\t", lreq->linger_id);
216 	dump_target(s, &lreq->t);
217 
218 	seq_printf(s, "\t%u\t%s%s/%d\n", lreq->register_gen,
219 		   lreq->is_watch ? "W" : "N", lreq->committed ? "C" : "",
220 		   lreq->last_error);
221 }
222 
223 static void dump_linger_requests(struct seq_file *s, struct ceph_osd *osd)
224 {
225 	struct rb_node *n;
226 
227 	mutex_lock(&osd->lock);
228 	for (n = rb_first(&osd->o_linger_requests); n; n = rb_next(n)) {
229 		struct ceph_osd_linger_request *lreq =
230 		    rb_entry(n, struct ceph_osd_linger_request, node);
231 
232 		dump_linger_request(s, lreq);
233 	}
234 
235 	mutex_unlock(&osd->lock);
236 }
237 
238 static int osdc_show(struct seq_file *s, void *pp)
239 {
240 	struct ceph_client *client = s->private;
241 	struct ceph_osd_client *osdc = &client->osdc;
242 	struct rb_node *n;
243 
244 	down_read(&osdc->lock);
245 	seq_printf(s, "REQUESTS %d homeless %d\n",
246 		   atomic_read(&osdc->num_requests),
247 		   atomic_read(&osdc->num_homeless));
248 	for (n = rb_first(&osdc->osds); n; n = rb_next(n)) {
249 		struct ceph_osd *osd = rb_entry(n, struct ceph_osd, o_node);
250 
251 		dump_requests(s, osd);
252 	}
253 	dump_requests(s, &osdc->homeless_osd);
254 
255 	seq_puts(s, "LINGER REQUESTS\n");
256 	for (n = rb_first(&osdc->osds); n; n = rb_next(n)) {
257 		struct ceph_osd *osd = rb_entry(n, struct ceph_osd, o_node);
258 
259 		dump_linger_requests(s, osd);
260 	}
261 	dump_linger_requests(s, &osdc->homeless_osd);
262 
263 	up_read(&osdc->lock);
264 	return 0;
265 }
266 
267 static int client_options_show(struct seq_file *s, void *p)
268 {
269 	struct ceph_client *client = s->private;
270 	int ret;
271 
272 	ret = ceph_print_client_options(s, client);
273 	if (ret)
274 		return ret;
275 
276 	seq_putc(s, '\n');
277 	return 0;
278 }
279 
280 CEPH_DEFINE_SHOW_FUNC(monmap_show)
281 CEPH_DEFINE_SHOW_FUNC(osdmap_show)
282 CEPH_DEFINE_SHOW_FUNC(monc_show)
283 CEPH_DEFINE_SHOW_FUNC(osdc_show)
284 CEPH_DEFINE_SHOW_FUNC(client_options_show)
285 
286 int ceph_debugfs_init(void)
287 {
288 	ceph_debugfs_dir = debugfs_create_dir("ceph", NULL);
289 	if (!ceph_debugfs_dir)
290 		return -ENOMEM;
291 	return 0;
292 }
293 
294 void ceph_debugfs_cleanup(void)
295 {
296 	debugfs_remove(ceph_debugfs_dir);
297 }
298 
299 int ceph_debugfs_client_init(struct ceph_client *client)
300 {
301 	int ret = -ENOMEM;
302 	char name[80];
303 
304 	snprintf(name, sizeof(name), "%pU.client%lld", &client->fsid,
305 		 client->monc.auth->global_id);
306 
307 	dout("ceph_debugfs_client_init %p %s\n", client, name);
308 
309 	BUG_ON(client->debugfs_dir);
310 	client->debugfs_dir = debugfs_create_dir(name, ceph_debugfs_dir);
311 	if (!client->debugfs_dir)
312 		goto out;
313 
314 	client->monc.debugfs_file = debugfs_create_file("monc",
315 						      0600,
316 						      client->debugfs_dir,
317 						      client,
318 						      &monc_show_fops);
319 	if (!client->monc.debugfs_file)
320 		goto out;
321 
322 	client->osdc.debugfs_file = debugfs_create_file("osdc",
323 						      0600,
324 						      client->debugfs_dir,
325 						      client,
326 						      &osdc_show_fops);
327 	if (!client->osdc.debugfs_file)
328 		goto out;
329 
330 	client->debugfs_monmap = debugfs_create_file("monmap",
331 					0600,
332 					client->debugfs_dir,
333 					client,
334 					&monmap_show_fops);
335 	if (!client->debugfs_monmap)
336 		goto out;
337 
338 	client->debugfs_osdmap = debugfs_create_file("osdmap",
339 					0600,
340 					client->debugfs_dir,
341 					client,
342 					&osdmap_show_fops);
343 	if (!client->debugfs_osdmap)
344 		goto out;
345 
346 	client->debugfs_options = debugfs_create_file("client_options",
347 					0600,
348 					client->debugfs_dir,
349 					client,
350 					&client_options_show_fops);
351 	if (!client->debugfs_options)
352 		goto out;
353 
354 	return 0;
355 
356 out:
357 	ceph_debugfs_client_cleanup(client);
358 	return ret;
359 }
360 
361 void ceph_debugfs_client_cleanup(struct ceph_client *client)
362 {
363 	dout("ceph_debugfs_client_cleanup %p\n", client);
364 	debugfs_remove(client->debugfs_options);
365 	debugfs_remove(client->debugfs_osdmap);
366 	debugfs_remove(client->debugfs_monmap);
367 	debugfs_remove(client->osdc.debugfs_file);
368 	debugfs_remove(client->monc.debugfs_file);
369 	debugfs_remove(client->debugfs_dir);
370 }
371 
372 #else  /* CONFIG_DEBUG_FS */
373 
374 int ceph_debugfs_init(void)
375 {
376 	return 0;
377 }
378 
379 void ceph_debugfs_cleanup(void)
380 {
381 }
382 
383 int ceph_debugfs_client_init(struct ceph_client *client)
384 {
385 	return 0;
386 }
387 
388 void ceph_debugfs_client_cleanup(struct ceph_client *client)
389 {
390 }
391 
392 #endif  /* CONFIG_DEBUG_FS */
393 
394 EXPORT_SYMBOL(ceph_debugfs_init);
395 EXPORT_SYMBOL(ceph_debugfs_cleanup);
396