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