1 /* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
6 * debug functionality for o2net
8 * Copyright (C) 2005, 2008 Oracle. All rights reserved.
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public
21 * License along with this program; if not, write to the
22 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 * Boston, MA 021110-1307, USA.
27 #ifdef CONFIG_DEBUG_FS
29 #include <linux/module.h>
30 #include <linux/types.h>
31 #include <linux/slab.h>
32 #include <linux/idr.h>
33 #include <linux/kref.h>
34 #include <linux/seq_file.h>
35 #include <linux/debugfs.h>
37 #include <linux/uaccess.h>
40 #include "nodemanager.h"
41 #define MLOG_MASK_PREFIX ML_TCP
44 #include "tcp_internal.h"
46 #define O2NET_DEBUG_DIR "o2net"
47 #define SC_DEBUG_NAME "sock_containers"
48 #define NST_DEBUG_NAME "send_tracking"
49 #define STATS_DEBUG_NAME "stats"
50 #define NODES_DEBUG_NAME "connected_nodes"
52 #define SHOW_SOCK_CONTAINERS 0
53 #define SHOW_SOCK_STATS 1
55 static struct dentry
*o2net_dentry
;
56 static struct dentry
*sc_dentry
;
57 static struct dentry
*nst_dentry
;
58 static struct dentry
*stats_dentry
;
59 static struct dentry
*nodes_dentry
;
61 static DEFINE_SPINLOCK(o2net_debug_lock
);
63 static LIST_HEAD(sock_containers
);
64 static LIST_HEAD(send_tracking
);
66 void o2net_debug_add_nst(struct o2net_send_tracking
*nst
)
68 spin_lock(&o2net_debug_lock
);
69 list_add(&nst
->st_net_debug_item
, &send_tracking
);
70 spin_unlock(&o2net_debug_lock
);
73 void o2net_debug_del_nst(struct o2net_send_tracking
*nst
)
75 spin_lock(&o2net_debug_lock
);
76 if (!list_empty(&nst
->st_net_debug_item
))
77 list_del_init(&nst
->st_net_debug_item
);
78 spin_unlock(&o2net_debug_lock
);
81 static struct o2net_send_tracking
82 *next_nst(struct o2net_send_tracking
*nst_start
)
84 struct o2net_send_tracking
*nst
, *ret
= NULL
;
86 assert_spin_locked(&o2net_debug_lock
);
88 list_for_each_entry(nst
, &nst_start
->st_net_debug_item
,
90 /* discover the head of the list */
91 if (&nst
->st_net_debug_item
== &send_tracking
)
94 /* use st_task to detect real nsts in the list */
95 if (nst
->st_task
!= NULL
) {
104 static void *nst_seq_start(struct seq_file
*seq
, loff_t
*pos
)
106 struct o2net_send_tracking
*nst
, *dummy_nst
= seq
->private;
108 spin_lock(&o2net_debug_lock
);
109 nst
= next_nst(dummy_nst
);
110 spin_unlock(&o2net_debug_lock
);
115 static void *nst_seq_next(struct seq_file
*seq
, void *v
, loff_t
*pos
)
117 struct o2net_send_tracking
*nst
, *dummy_nst
= seq
->private;
119 spin_lock(&o2net_debug_lock
);
120 nst
= next_nst(dummy_nst
);
121 list_del_init(&dummy_nst
->st_net_debug_item
);
123 list_add(&dummy_nst
->st_net_debug_item
,
124 &nst
->st_net_debug_item
);
125 spin_unlock(&o2net_debug_lock
);
127 return nst
; /* unused, just needs to be null when done */
130 static int nst_seq_show(struct seq_file
*seq
, void *v
)
132 struct o2net_send_tracking
*nst
, *dummy_nst
= seq
->private;
134 s64 sock
, send
, status
;
136 spin_lock(&o2net_debug_lock
);
137 nst
= next_nst(dummy_nst
);
142 sock
= ktime_to_us(ktime_sub(now
, nst
->st_sock_time
));
143 send
= ktime_to_us(ktime_sub(now
, nst
->st_send_time
));
144 status
= ktime_to_us(ktime_sub(now
, nst
->st_status_time
));
146 /* get_task_comm isn't exported. oh well. */
147 seq_printf(seq
, "%p:\n"
150 " process name: %s\n"
154 " message type: %u\n"
155 " message key: 0x%08x\n"
156 " sock acquiry: %lld usecs ago\n"
157 " send start: %lld usecs ago\n"
158 " wait start: %lld usecs ago\n",
159 nst
, (unsigned long)task_pid_nr(nst
->st_task
),
160 (unsigned long)nst
->st_task
->tgid
,
161 nst
->st_task
->comm
, nst
->st_node
,
162 nst
->st_sc
, nst
->st_id
, nst
->st_msg_type
,
169 spin_unlock(&o2net_debug_lock
);
174 static void nst_seq_stop(struct seq_file
*seq
, void *v
)
178 static const struct seq_operations nst_seq_ops
= {
179 .start
= nst_seq_start
,
180 .next
= nst_seq_next
,
181 .stop
= nst_seq_stop
,
182 .show
= nst_seq_show
,
185 static int nst_fop_open(struct inode
*inode
, struct file
*file
)
187 struct o2net_send_tracking
*dummy_nst
;
188 struct seq_file
*seq
;
191 dummy_nst
= kmalloc(sizeof(struct o2net_send_tracking
), GFP_KERNEL
);
192 if (dummy_nst
== NULL
) {
196 dummy_nst
->st_task
= NULL
;
198 ret
= seq_open(file
, &nst_seq_ops
);
202 seq
= file
->private_data
;
203 seq
->private = dummy_nst
;
204 o2net_debug_add_nst(dummy_nst
);
213 static int nst_fop_release(struct inode
*inode
, struct file
*file
)
215 struct seq_file
*seq
= file
->private_data
;
216 struct o2net_send_tracking
*dummy_nst
= seq
->private;
218 o2net_debug_del_nst(dummy_nst
);
219 return seq_release_private(inode
, file
);
222 static const struct file_operations nst_seq_fops
= {
223 .open
= nst_fop_open
,
226 .release
= nst_fop_release
,
229 void o2net_debug_add_sc(struct o2net_sock_container
*sc
)
231 spin_lock(&o2net_debug_lock
);
232 list_add(&sc
->sc_net_debug_item
, &sock_containers
);
233 spin_unlock(&o2net_debug_lock
);
236 void o2net_debug_del_sc(struct o2net_sock_container
*sc
)
238 spin_lock(&o2net_debug_lock
);
239 list_del_init(&sc
->sc_net_debug_item
);
240 spin_unlock(&o2net_debug_lock
);
243 struct o2net_sock_debug
{
245 struct o2net_sock_container
*dbg_sock
;
248 static struct o2net_sock_container
249 *next_sc(struct o2net_sock_container
*sc_start
)
251 struct o2net_sock_container
*sc
, *ret
= NULL
;
253 assert_spin_locked(&o2net_debug_lock
);
255 list_for_each_entry(sc
, &sc_start
->sc_net_debug_item
,
257 /* discover the head of the list miscast as a sc */
258 if (&sc
->sc_net_debug_item
== &sock_containers
)
261 /* use sc_page to detect real scs in the list */
262 if (sc
->sc_page
!= NULL
) {
271 static void *sc_seq_start(struct seq_file
*seq
, loff_t
*pos
)
273 struct o2net_sock_debug
*sd
= seq
->private;
274 struct o2net_sock_container
*sc
, *dummy_sc
= sd
->dbg_sock
;
276 spin_lock(&o2net_debug_lock
);
277 sc
= next_sc(dummy_sc
);
278 spin_unlock(&o2net_debug_lock
);
283 static void *sc_seq_next(struct seq_file
*seq
, void *v
, loff_t
*pos
)
285 struct o2net_sock_debug
*sd
= seq
->private;
286 struct o2net_sock_container
*sc
, *dummy_sc
= sd
->dbg_sock
;
288 spin_lock(&o2net_debug_lock
);
289 sc
= next_sc(dummy_sc
);
290 list_del_init(&dummy_sc
->sc_net_debug_item
);
292 list_add(&dummy_sc
->sc_net_debug_item
, &sc
->sc_net_debug_item
);
293 spin_unlock(&o2net_debug_lock
);
295 return sc
; /* unused, just needs to be null when done */
298 #ifdef CONFIG_OCFS2_FS_STATS
299 # define sc_send_count(_s) ((_s)->sc_send_count)
300 # define sc_recv_count(_s) ((_s)->sc_recv_count)
301 # define sc_tv_acquiry_total_ns(_s) (ktime_to_ns((_s)->sc_tv_acquiry_total))
302 # define sc_tv_send_total_ns(_s) (ktime_to_ns((_s)->sc_tv_send_total))
303 # define sc_tv_status_total_ns(_s) (ktime_to_ns((_s)->sc_tv_status_total))
304 # define sc_tv_process_total_ns(_s) (ktime_to_ns((_s)->sc_tv_process_total))
306 # define sc_send_count(_s) (0U)
307 # define sc_recv_count(_s) (0U)
308 # define sc_tv_acquiry_total_ns(_s) (0LL)
309 # define sc_tv_send_total_ns(_s) (0LL)
310 # define sc_tv_status_total_ns(_s) (0LL)
311 # define sc_tv_process_total_ns(_s) (0LL)
314 /* So that debugfs.ocfs2 can determine which format is being used */
315 #define O2NET_STATS_STR_VERSION 1
316 static void sc_show_sock_stats(struct seq_file
*seq
,
317 struct o2net_sock_container
*sc
)
322 seq_printf(seq
, "%d,%u,%lu,%lld,%lld,%lld,%lu,%lld\n", O2NET_STATS_STR_VERSION
,
323 sc
->sc_node
->nd_num
, (unsigned long)sc_send_count(sc
),
324 (long long)sc_tv_acquiry_total_ns(sc
),
325 (long long)sc_tv_send_total_ns(sc
),
326 (long long)sc_tv_status_total_ns(sc
),
327 (unsigned long)sc_recv_count(sc
),
328 (long long)sc_tv_process_total_ns(sc
));
331 static void sc_show_sock_container(struct seq_file
*seq
,
332 struct o2net_sock_container
*sc
)
334 struct inet_sock
*inet
= NULL
;
335 __be32 saddr
= 0, daddr
= 0;
336 __be16 sport
= 0, dport
= 0;
342 inet
= inet_sk(sc
->sc_sock
->sk
);
343 /* the stack's structs aren't sparse endian clean */
344 saddr
= (__force __be32
)inet
->inet_saddr
;
345 daddr
= (__force __be32
)inet
->inet_daddr
;
346 sport
= (__force __be16
)inet
->inet_sport
;
347 dport
= (__force __be16
)inet
->inet_dport
;
350 /* XXX sigh, inet-> doesn't have sparse annotation so any
351 * use of it here generates a warning with -Wbitwise */
352 seq_printf(seq
, "%p:\n"
358 " handshake ok: %u\n"
359 " timer: %lld usecs\n"
360 " data ready: %lld usecs\n"
361 " advance start: %lld usecs\n"
362 " advance stop: %lld usecs\n"
363 " func start: %lld usecs\n"
364 " func stop: %lld usecs\n"
365 " func key: 0x%08x\n"
368 atomic_read(&sc
->sc_kref
.refcount
),
369 &saddr
, inet
? ntohs(sport
) : 0,
370 &daddr
, inet
? ntohs(dport
) : 0,
371 sc
->sc_node
->nd_name
,
374 (long long)ktime_to_us(sc
->sc_tv_timer
),
375 (long long)ktime_to_us(sc
->sc_tv_data_ready
),
376 (long long)ktime_to_us(sc
->sc_tv_advance_start
),
377 (long long)ktime_to_us(sc
->sc_tv_advance_stop
),
378 (long long)ktime_to_us(sc
->sc_tv_func_start
),
379 (long long)ktime_to_us(sc
->sc_tv_func_stop
),
384 static int sc_seq_show(struct seq_file
*seq
, void *v
)
386 struct o2net_sock_debug
*sd
= seq
->private;
387 struct o2net_sock_container
*sc
, *dummy_sc
= sd
->dbg_sock
;
389 spin_lock(&o2net_debug_lock
);
390 sc
= next_sc(dummy_sc
);
393 if (sd
->dbg_ctxt
== SHOW_SOCK_CONTAINERS
)
394 sc_show_sock_container(seq
, sc
);
396 sc_show_sock_stats(seq
, sc
);
399 spin_unlock(&o2net_debug_lock
);
404 static void sc_seq_stop(struct seq_file
*seq
, void *v
)
408 static const struct seq_operations sc_seq_ops
= {
409 .start
= sc_seq_start
,
415 static int sc_common_open(struct file
*file
, struct o2net_sock_debug
*sd
)
417 struct o2net_sock_container
*dummy_sc
;
418 struct seq_file
*seq
;
421 dummy_sc
= kmalloc(sizeof(struct o2net_sock_container
), GFP_KERNEL
);
422 if (dummy_sc
== NULL
) {
426 dummy_sc
->sc_page
= NULL
;
428 ret
= seq_open(file
, &sc_seq_ops
);
432 seq
= file
->private_data
;
434 sd
->dbg_sock
= dummy_sc
;
435 o2net_debug_add_sc(dummy_sc
);
444 static int sc_fop_release(struct inode
*inode
, struct file
*file
)
446 struct seq_file
*seq
= file
->private_data
;
447 struct o2net_sock_debug
*sd
= seq
->private;
448 struct o2net_sock_container
*dummy_sc
= sd
->dbg_sock
;
450 o2net_debug_del_sc(dummy_sc
);
451 return seq_release_private(inode
, file
);
454 static int stats_fop_open(struct inode
*inode
, struct file
*file
)
456 struct o2net_sock_debug
*sd
;
458 sd
= kmalloc(sizeof(struct o2net_sock_debug
), GFP_KERNEL
);
462 sd
->dbg_ctxt
= SHOW_SOCK_STATS
;
465 return sc_common_open(file
, sd
);
468 static const struct file_operations stats_seq_fops
= {
469 .open
= stats_fop_open
,
472 .release
= sc_fop_release
,
475 static int sc_fop_open(struct inode
*inode
, struct file
*file
)
477 struct o2net_sock_debug
*sd
;
479 sd
= kmalloc(sizeof(struct o2net_sock_debug
), GFP_KERNEL
);
483 sd
->dbg_ctxt
= SHOW_SOCK_CONTAINERS
;
486 return sc_common_open(file
, sd
);
489 static const struct file_operations sc_seq_fops
= {
493 .release
= sc_fop_release
,
496 static int o2net_fill_bitmap(char *buf
, int len
)
498 unsigned long map
[BITS_TO_LONGS(O2NM_MAX_NODES
)];
501 o2net_fill_node_map(map
, sizeof(map
));
503 while ((i
= find_next_bit(map
, O2NM_MAX_NODES
, i
+ 1)) < O2NM_MAX_NODES
)
504 out
+= snprintf(buf
+ out
, PAGE_SIZE
- out
, "%d ", i
);
505 out
+= snprintf(buf
+ out
, PAGE_SIZE
- out
, "\n");
510 static int nodes_fop_open(struct inode
*inode
, struct file
*file
)
514 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
518 i_size_write(inode
, o2net_fill_bitmap(buf
, PAGE_SIZE
));
520 file
->private_data
= buf
;
525 static int o2net_debug_release(struct inode
*inode
, struct file
*file
)
527 kfree(file
->private_data
);
531 static ssize_t
o2net_debug_read(struct file
*file
, char __user
*buf
,
532 size_t nbytes
, loff_t
*ppos
)
534 return simple_read_from_buffer(buf
, nbytes
, ppos
, file
->private_data
,
535 i_size_read(file
->f_mapping
->host
));
538 static const struct file_operations nodes_fops
= {
539 .open
= nodes_fop_open
,
540 .release
= o2net_debug_release
,
541 .read
= o2net_debug_read
,
542 .llseek
= generic_file_llseek
,
545 void o2net_debugfs_exit(void)
547 debugfs_remove(nodes_dentry
);
548 debugfs_remove(stats_dentry
);
549 debugfs_remove(sc_dentry
);
550 debugfs_remove(nst_dentry
);
551 debugfs_remove(o2net_dentry
);
554 int o2net_debugfs_init(void)
556 umode_t mode
= S_IFREG
|S_IRUSR
;
558 o2net_dentry
= debugfs_create_dir(O2NET_DEBUG_DIR
, NULL
);
560 nst_dentry
= debugfs_create_file(NST_DEBUG_NAME
, mode
,
561 o2net_dentry
, NULL
, &nst_seq_fops
);
563 sc_dentry
= debugfs_create_file(SC_DEBUG_NAME
, mode
,
564 o2net_dentry
, NULL
, &sc_seq_fops
);
566 stats_dentry
= debugfs_create_file(STATS_DEBUG_NAME
, mode
,
567 o2net_dentry
, NULL
, &stats_seq_fops
);
569 nodes_dentry
= debugfs_create_file(NODES_DEBUG_NAME
, mode
,
570 o2net_dentry
, NULL
, &nodes_fops
);
574 o2net_debugfs_exit();
579 #endif /* CONFIG_DEBUG_FS */