xref: /linux-6.15/net/ceph/debugfs.c (revision 5aea3dcd)
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_osdmap *map = client->osdc.osdmap;
58 	struct rb_node *n;
59 
60 	if (map == NULL)
61 		return 0;
62 
63 	seq_printf(s, "epoch %d\n", map->epoch);
64 	seq_printf(s, "flags%s%s\n",
65 		   (map->flags & CEPH_OSDMAP_NEARFULL) ?  " NEARFULL" : "",
66 		   (map->flags & CEPH_OSDMAP_FULL) ?  " FULL" : "");
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 	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 
132 	for (rp = rb_first(&monc->generic_request_tree); rp; rp = rb_next(rp)) {
133 		__u16 op;
134 		req = rb_entry(rp, struct ceph_mon_generic_request, node);
135 		op = le16_to_cpu(req->request->hdr.type);
136 		if (op == CEPH_MSG_STATFS)
137 			seq_printf(s, "%llu statfs\n", req->tid);
138 		else if (op == CEPH_MSG_MON_GET_VERSION)
139 			seq_printf(s, "%llu mon_get_version", req->tid);
140 		else
141 			seq_printf(s, "%llu unknown\n", req->tid);
142 	}
143 
144 	mutex_unlock(&monc->mutex);
145 	return 0;
146 }
147 
148 static void dump_target(struct seq_file *s, struct ceph_osd_request_target *t)
149 {
150 	int i;
151 
152 	seq_printf(s, "osd%d\t%llu.%x\t[", t->osd, t->pgid.pool, t->pgid.seed);
153 	for (i = 0; i < t->up.size; i++)
154 		seq_printf(s, "%s%d", (!i ? "" : ","), t->up.osds[i]);
155 	seq_printf(s, "]/%d\t[", t->up.primary);
156 	for (i = 0; i < t->acting.size; i++)
157 		seq_printf(s, "%s%d", (!i ? "" : ","), t->acting.osds[i]);
158 	seq_printf(s, "]/%d\t%*pE\t0x%x", t->acting.primary,
159 		   t->target_oid.name_len, t->target_oid.name, t->flags);
160 	if (t->paused)
161 		seq_puts(s, "\tP");
162 }
163 
164 static void dump_request(struct seq_file *s, struct ceph_osd_request *req)
165 {
166 	int i;
167 
168 	seq_printf(s, "%llu\t", req->r_tid);
169 	dump_target(s, &req->r_t);
170 
171 	seq_printf(s, "\t%d\t%u'%llu", req->r_attempts,
172 		   le32_to_cpu(req->r_replay_version.epoch),
173 		   le64_to_cpu(req->r_replay_version.version));
174 
175 	for (i = 0; i < req->r_num_ops; i++) {
176 		struct ceph_osd_req_op *op = &req->r_ops[i];
177 
178 		seq_printf(s, "%s%s", (i == 0 ? "\t" : ","),
179 			   ceph_osd_op_name(op->op));
180 	}
181 
182 	seq_putc(s, '\n');
183 }
184 
185 static void dump_requests(struct seq_file *s, struct ceph_osd *osd)
186 {
187 	struct rb_node *n;
188 
189 	mutex_lock(&osd->lock);
190 	for (n = rb_first(&osd->o_requests); n; n = rb_next(n)) {
191 		struct ceph_osd_request *req =
192 		    rb_entry(n, struct ceph_osd_request, r_node);
193 
194 		dump_request(s, req);
195 	}
196 
197 	mutex_unlock(&osd->lock);
198 }
199 
200 static int osdc_show(struct seq_file *s, void *pp)
201 {
202 	struct ceph_client *client = s->private;
203 	struct ceph_osd_client *osdc = &client->osdc;
204 	struct rb_node *n;
205 
206 	down_read(&osdc->lock);
207 	seq_printf(s, "REQUESTS %d homeless %d\n",
208 		   atomic_read(&osdc->num_requests),
209 		   atomic_read(&osdc->num_homeless));
210 	for (n = rb_first(&osdc->osds); n; n = rb_next(n)) {
211 		struct ceph_osd *osd = rb_entry(n, struct ceph_osd, o_node);
212 
213 		dump_requests(s, osd);
214 	}
215 	dump_requests(s, &osdc->homeless_osd);
216 
217 	up_read(&osdc->lock);
218 	return 0;
219 }
220 
221 static int client_options_show(struct seq_file *s, void *p)
222 {
223 	struct ceph_client *client = s->private;
224 	int ret;
225 
226 	ret = ceph_print_client_options(s, client);
227 	if (ret)
228 		return ret;
229 
230 	seq_putc(s, '\n');
231 	return 0;
232 }
233 
234 CEPH_DEFINE_SHOW_FUNC(monmap_show)
235 CEPH_DEFINE_SHOW_FUNC(osdmap_show)
236 CEPH_DEFINE_SHOW_FUNC(monc_show)
237 CEPH_DEFINE_SHOW_FUNC(osdc_show)
238 CEPH_DEFINE_SHOW_FUNC(client_options_show)
239 
240 int ceph_debugfs_init(void)
241 {
242 	ceph_debugfs_dir = debugfs_create_dir("ceph", NULL);
243 	if (!ceph_debugfs_dir)
244 		return -ENOMEM;
245 	return 0;
246 }
247 
248 void ceph_debugfs_cleanup(void)
249 {
250 	debugfs_remove(ceph_debugfs_dir);
251 }
252 
253 int ceph_debugfs_client_init(struct ceph_client *client)
254 {
255 	int ret = -ENOMEM;
256 	char name[80];
257 
258 	snprintf(name, sizeof(name), "%pU.client%lld", &client->fsid,
259 		 client->monc.auth->global_id);
260 
261 	dout("ceph_debugfs_client_init %p %s\n", client, name);
262 
263 	BUG_ON(client->debugfs_dir);
264 	client->debugfs_dir = debugfs_create_dir(name, ceph_debugfs_dir);
265 	if (!client->debugfs_dir)
266 		goto out;
267 
268 	client->monc.debugfs_file = debugfs_create_file("monc",
269 						      0600,
270 						      client->debugfs_dir,
271 						      client,
272 						      &monc_show_fops);
273 	if (!client->monc.debugfs_file)
274 		goto out;
275 
276 	client->osdc.debugfs_file = debugfs_create_file("osdc",
277 						      0600,
278 						      client->debugfs_dir,
279 						      client,
280 						      &osdc_show_fops);
281 	if (!client->osdc.debugfs_file)
282 		goto out;
283 
284 	client->debugfs_monmap = debugfs_create_file("monmap",
285 					0600,
286 					client->debugfs_dir,
287 					client,
288 					&monmap_show_fops);
289 	if (!client->debugfs_monmap)
290 		goto out;
291 
292 	client->debugfs_osdmap = debugfs_create_file("osdmap",
293 					0600,
294 					client->debugfs_dir,
295 					client,
296 					&osdmap_show_fops);
297 	if (!client->debugfs_osdmap)
298 		goto out;
299 
300 	client->debugfs_options = debugfs_create_file("client_options",
301 					0600,
302 					client->debugfs_dir,
303 					client,
304 					&client_options_show_fops);
305 	if (!client->debugfs_options)
306 		goto out;
307 
308 	return 0;
309 
310 out:
311 	ceph_debugfs_client_cleanup(client);
312 	return ret;
313 }
314 
315 void ceph_debugfs_client_cleanup(struct ceph_client *client)
316 {
317 	dout("ceph_debugfs_client_cleanup %p\n", client);
318 	debugfs_remove(client->debugfs_options);
319 	debugfs_remove(client->debugfs_osdmap);
320 	debugfs_remove(client->debugfs_monmap);
321 	debugfs_remove(client->osdc.debugfs_file);
322 	debugfs_remove(client->monc.debugfs_file);
323 	debugfs_remove(client->debugfs_dir);
324 }
325 
326 #else  /* CONFIG_DEBUG_FS */
327 
328 int ceph_debugfs_init(void)
329 {
330 	return 0;
331 }
332 
333 void ceph_debugfs_cleanup(void)
334 {
335 }
336 
337 int ceph_debugfs_client_init(struct ceph_client *client)
338 {
339 	return 0;
340 }
341 
342 void ceph_debugfs_client_cleanup(struct ceph_client *client)
343 {
344 }
345 
346 #endif  /* CONFIG_DEBUG_FS */
347 
348 EXPORT_SYMBOL(ceph_debugfs_init);
349 EXPORT_SYMBOL(ceph_debugfs_cleanup);
350