xref: /openbmc/linux/net/sctp/objcnt.c (revision 367b8112)
1 /* SCTP kernel implementation
2  * (C) Copyright IBM Corp. 2001, 2004
3  *
4  * This file is part of the SCTP kernel implementation
5  *
6  * Support for memory object debugging.  This allows one to monitor the
7  * object allocations/deallocations for types instrumented for this
8  * via the proc fs.
9  *
10  * This SCTP implementation is free software;
11  * you can redistribute it and/or modify it under the terms of
12  * the GNU General Public License as published by
13  * the Free Software Foundation; either version 2, or (at your option)
14  * any later version.
15  *
16  * This SCTP implementation is distributed in the hope that it
17  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
18  *                 ************************
19  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
20  * See the GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with GNU CC; see the file COPYING.  If not, write to
24  * the Free Software Foundation, 59 Temple Place - Suite 330,
25  * Boston, MA 02111-1307, USA.
26  *
27  * Please send any bug reports or fixes you make to the
28  * email address(es):
29  *    lksctp developers <lksctp-developers@lists.sourceforge.net>
30  *
31  * Or submit a bug report through the following website:
32  *    http://www.sf.net/projects/lksctp
33  *
34  * Written or modified by:
35  *    Jon Grimm             <jgrimm@us.ibm.com>
36  *
37  * Any bugs reported given to us we will try to fix... any fixes shared will
38  * be incorporated into the next SCTP release.
39  */
40 
41 #include <linux/kernel.h>
42 #include <net/sctp/sctp.h>
43 
44 /*
45  * Global counters to count raw object allocation counts.
46  * To add new counters, choose a unique suffix for the variable
47  * name as the helper macros key off this suffix to make
48  * life easier for the programmer.
49  */
50 
51 SCTP_DBG_OBJCNT(sock);
52 SCTP_DBG_OBJCNT(ep);
53 SCTP_DBG_OBJCNT(transport);
54 SCTP_DBG_OBJCNT(assoc);
55 SCTP_DBG_OBJCNT(bind_addr);
56 SCTP_DBG_OBJCNT(bind_bucket);
57 SCTP_DBG_OBJCNT(chunk);
58 SCTP_DBG_OBJCNT(addr);
59 SCTP_DBG_OBJCNT(ssnmap);
60 SCTP_DBG_OBJCNT(datamsg);
61 SCTP_DBG_OBJCNT(keys);
62 
63 /* An array to make it easy to pretty print the debug information
64  * to the proc fs.
65  */
66 static sctp_dbg_objcnt_entry_t sctp_dbg_objcnt[] = {
67 	SCTP_DBG_OBJCNT_ENTRY(sock),
68 	SCTP_DBG_OBJCNT_ENTRY(ep),
69 	SCTP_DBG_OBJCNT_ENTRY(assoc),
70 	SCTP_DBG_OBJCNT_ENTRY(transport),
71 	SCTP_DBG_OBJCNT_ENTRY(chunk),
72 	SCTP_DBG_OBJCNT_ENTRY(bind_addr),
73 	SCTP_DBG_OBJCNT_ENTRY(bind_bucket),
74 	SCTP_DBG_OBJCNT_ENTRY(addr),
75 	SCTP_DBG_OBJCNT_ENTRY(ssnmap),
76 	SCTP_DBG_OBJCNT_ENTRY(datamsg),
77 	SCTP_DBG_OBJCNT_ENTRY(keys),
78 };
79 
80 /* Callback from procfs to read out objcount information.
81  * Walk through the entries in the sctp_dbg_objcnt array, dumping
82  * the raw object counts for each monitored type.
83  */
84 static int sctp_objcnt_seq_show(struct seq_file *seq, void *v)
85 {
86 	int i, len;
87 
88 	i = (int)*(loff_t *)v;
89 	seq_printf(seq, "%s: %d%n", sctp_dbg_objcnt[i].label,
90 				atomic_read(sctp_dbg_objcnt[i].counter), &len);
91 	seq_printf(seq, "%*s\n", 127 - len, "");
92 	return 0;
93 }
94 
95 static void *sctp_objcnt_seq_start(struct seq_file *seq, loff_t *pos)
96 {
97 	return (*pos >= ARRAY_SIZE(sctp_dbg_objcnt)) ? NULL : (void *)pos;
98 }
99 
100 static void sctp_objcnt_seq_stop(struct seq_file *seq, void *v)
101 {
102 }
103 
104 static void * sctp_objcnt_seq_next(struct seq_file *seq, void *v, loff_t *pos)
105 {
106 	++*pos;
107 	return (*pos >= ARRAY_SIZE(sctp_dbg_objcnt)) ? NULL : (void *)pos;
108 }
109 
110 static const struct seq_operations sctp_objcnt_seq_ops = {
111 	.start = sctp_objcnt_seq_start,
112 	.next  = sctp_objcnt_seq_next,
113 	.stop  = sctp_objcnt_seq_stop,
114 	.show  = sctp_objcnt_seq_show,
115 };
116 
117 static int sctp_objcnt_seq_open(struct inode *inode, struct file *file)
118 {
119 	return seq_open(file, &sctp_objcnt_seq_ops);
120 }
121 
122 static const struct file_operations sctp_objcnt_ops = {
123 	.open	 = sctp_objcnt_seq_open,
124 	.read	 = seq_read,
125 	.llseek	 = seq_lseek,
126 	.release = seq_release,
127 };
128 
129 /* Initialize the objcount in the proc filesystem.  */
130 void sctp_dbg_objcnt_init(void)
131 {
132 	struct proc_dir_entry *ent;
133 
134 	ent = proc_create("sctp_dbg_objcnt", 0,
135 			  proc_net_sctp, &sctp_objcnt_ops);
136 	if (!ent)
137 		printk(KERN_WARNING
138 			"sctp_dbg_objcnt: Unable to create /proc entry.\n");
139 }
140 
141 /* Cleanup the objcount entry in the proc filesystem.  */
142 void sctp_dbg_objcnt_exit(void)
143 {
144 	remove_proc_entry("sctp_dbg_objcnt", proc_net_sctp);
145 }
146 
147 
148