xref: /linux/net/sctp/proc.c (revision f79e4d5f92a129a1159c973735007d4ddc8541f3)
1 /* SCTP kernel implementation
2  * Copyright (c) 2003 International Business Machines, Corp.
3  *
4  * This file is part of the SCTP kernel implementation
5  *
6  * This SCTP implementation is free software;
7  * you can redistribute it and/or modify it under the terms of
8  * the GNU General Public License as published by
9  * the Free Software Foundation; either version 2, or (at your option)
10  * any later version.
11  *
12  * This SCTP implementation is distributed in the hope that it
13  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
14  *                 ************************
15  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  * See the GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with GNU CC; see the file COPYING.  If not, see
20  * <http://www.gnu.org/licenses/>.
21  *
22  * Please send any bug reports or fixes you make to the
23  * email address(es):
24  *    lksctp developers <linux-sctp@vger.kernel.org>
25  *
26  * Written or modified by:
27  *    Sridhar Samudrala <sri@us.ibm.com>
28  */
29 
30 #include <linux/types.h>
31 #include <linux/seq_file.h>
32 #include <linux/init.h>
33 #include <linux/export.h>
34 #include <net/sctp/sctp.h>
35 #include <net/ip.h> /* for snmp_fold_field */
36 
37 static const struct snmp_mib sctp_snmp_list[] = {
38 	SNMP_MIB_ITEM("SctpCurrEstab", SCTP_MIB_CURRESTAB),
39 	SNMP_MIB_ITEM("SctpActiveEstabs", SCTP_MIB_ACTIVEESTABS),
40 	SNMP_MIB_ITEM("SctpPassiveEstabs", SCTP_MIB_PASSIVEESTABS),
41 	SNMP_MIB_ITEM("SctpAborteds", SCTP_MIB_ABORTEDS),
42 	SNMP_MIB_ITEM("SctpShutdowns", SCTP_MIB_SHUTDOWNS),
43 	SNMP_MIB_ITEM("SctpOutOfBlues", SCTP_MIB_OUTOFBLUES),
44 	SNMP_MIB_ITEM("SctpChecksumErrors", SCTP_MIB_CHECKSUMERRORS),
45 	SNMP_MIB_ITEM("SctpOutCtrlChunks", SCTP_MIB_OUTCTRLCHUNKS),
46 	SNMP_MIB_ITEM("SctpOutOrderChunks", SCTP_MIB_OUTORDERCHUNKS),
47 	SNMP_MIB_ITEM("SctpOutUnorderChunks", SCTP_MIB_OUTUNORDERCHUNKS),
48 	SNMP_MIB_ITEM("SctpInCtrlChunks", SCTP_MIB_INCTRLCHUNKS),
49 	SNMP_MIB_ITEM("SctpInOrderChunks", SCTP_MIB_INORDERCHUNKS),
50 	SNMP_MIB_ITEM("SctpInUnorderChunks", SCTP_MIB_INUNORDERCHUNKS),
51 	SNMP_MIB_ITEM("SctpFragUsrMsgs", SCTP_MIB_FRAGUSRMSGS),
52 	SNMP_MIB_ITEM("SctpReasmUsrMsgs", SCTP_MIB_REASMUSRMSGS),
53 	SNMP_MIB_ITEM("SctpOutSCTPPacks", SCTP_MIB_OUTSCTPPACKS),
54 	SNMP_MIB_ITEM("SctpInSCTPPacks", SCTP_MIB_INSCTPPACKS),
55 	SNMP_MIB_ITEM("SctpT1InitExpireds", SCTP_MIB_T1_INIT_EXPIREDS),
56 	SNMP_MIB_ITEM("SctpT1CookieExpireds", SCTP_MIB_T1_COOKIE_EXPIREDS),
57 	SNMP_MIB_ITEM("SctpT2ShutdownExpireds", SCTP_MIB_T2_SHUTDOWN_EXPIREDS),
58 	SNMP_MIB_ITEM("SctpT3RtxExpireds", SCTP_MIB_T3_RTX_EXPIREDS),
59 	SNMP_MIB_ITEM("SctpT4RtoExpireds", SCTP_MIB_T4_RTO_EXPIREDS),
60 	SNMP_MIB_ITEM("SctpT5ShutdownGuardExpireds", SCTP_MIB_T5_SHUTDOWN_GUARD_EXPIREDS),
61 	SNMP_MIB_ITEM("SctpDelaySackExpireds", SCTP_MIB_DELAY_SACK_EXPIREDS),
62 	SNMP_MIB_ITEM("SctpAutocloseExpireds", SCTP_MIB_AUTOCLOSE_EXPIREDS),
63 	SNMP_MIB_ITEM("SctpT3Retransmits", SCTP_MIB_T3_RETRANSMITS),
64 	SNMP_MIB_ITEM("SctpPmtudRetransmits", SCTP_MIB_PMTUD_RETRANSMITS),
65 	SNMP_MIB_ITEM("SctpFastRetransmits", SCTP_MIB_FAST_RETRANSMITS),
66 	SNMP_MIB_ITEM("SctpInPktSoftirq", SCTP_MIB_IN_PKT_SOFTIRQ),
67 	SNMP_MIB_ITEM("SctpInPktBacklog", SCTP_MIB_IN_PKT_BACKLOG),
68 	SNMP_MIB_ITEM("SctpInPktDiscards", SCTP_MIB_IN_PKT_DISCARDS),
69 	SNMP_MIB_ITEM("SctpInDataChunkDiscards", SCTP_MIB_IN_DATA_CHUNK_DISCARDS),
70 	SNMP_MIB_SENTINEL
71 };
72 
73 /* Display sctp snmp mib statistics(/proc/net/sctp/snmp). */
74 static int sctp_snmp_seq_show(struct seq_file *seq, void *v)
75 {
76 	unsigned long buff[SCTP_MIB_MAX];
77 	struct net *net = seq->private;
78 	int i;
79 
80 	memset(buff, 0, sizeof(unsigned long) * SCTP_MIB_MAX);
81 
82 	snmp_get_cpu_field_batch(buff, sctp_snmp_list,
83 				 net->sctp.sctp_statistics);
84 	for (i = 0; sctp_snmp_list[i].name; i++)
85 		seq_printf(seq, "%-32s\t%ld\n", sctp_snmp_list[i].name,
86 						buff[i]);
87 
88 	return 0;
89 }
90 
91 /* Dump local addresses of an association/endpoint. */
92 static void sctp_seq_dump_local_addrs(struct seq_file *seq, struct sctp_ep_common *epb)
93 {
94 	struct sctp_association *asoc;
95 	struct sctp_sockaddr_entry *laddr;
96 	struct sctp_transport *peer;
97 	union sctp_addr *addr, *primary = NULL;
98 	struct sctp_af *af;
99 
100 	if (epb->type == SCTP_EP_TYPE_ASSOCIATION) {
101 		asoc = sctp_assoc(epb);
102 
103 		peer = asoc->peer.primary_path;
104 		if (unlikely(peer == NULL)) {
105 			WARN(1, "Association %p with NULL primary path!\n", asoc);
106 			return;
107 		}
108 
109 		primary = &peer->saddr;
110 	}
111 
112 	rcu_read_lock();
113 	list_for_each_entry_rcu(laddr, &epb->bind_addr.address_list, list) {
114 		if (!laddr->valid)
115 			continue;
116 
117 		addr = &laddr->a;
118 		af = sctp_get_af_specific(addr->sa.sa_family);
119 		if (primary && af->cmp_addr(addr, primary)) {
120 			seq_printf(seq, "*");
121 		}
122 		af->seq_dump_addr(seq, addr);
123 	}
124 	rcu_read_unlock();
125 }
126 
127 /* Dump remote addresses of an association. */
128 static void sctp_seq_dump_remote_addrs(struct seq_file *seq, struct sctp_association *assoc)
129 {
130 	struct sctp_transport *transport;
131 	union sctp_addr *addr, *primary;
132 	struct sctp_af *af;
133 
134 	primary = &assoc->peer.primary_addr;
135 	list_for_each_entry_rcu(transport, &assoc->peer.transport_addr_list,
136 			transports) {
137 		addr = &transport->ipaddr;
138 
139 		af = sctp_get_af_specific(addr->sa.sa_family);
140 		if (af->cmp_addr(addr, primary)) {
141 			seq_printf(seq, "*");
142 		}
143 		af->seq_dump_addr(seq, addr);
144 	}
145 }
146 
147 static void *sctp_eps_seq_start(struct seq_file *seq, loff_t *pos)
148 {
149 	if (*pos >= sctp_ep_hashsize)
150 		return NULL;
151 
152 	if (*pos < 0)
153 		*pos = 0;
154 
155 	if (*pos == 0)
156 		seq_printf(seq, " ENDPT     SOCK   STY SST HBKT LPORT   UID INODE LADDRS\n");
157 
158 	return (void *)pos;
159 }
160 
161 static void sctp_eps_seq_stop(struct seq_file *seq, void *v)
162 {
163 }
164 
165 
166 static void *sctp_eps_seq_next(struct seq_file *seq, void *v, loff_t *pos)
167 {
168 	if (++*pos >= sctp_ep_hashsize)
169 		return NULL;
170 
171 	return pos;
172 }
173 
174 
175 /* Display sctp endpoints (/proc/net/sctp/eps). */
176 static int sctp_eps_seq_show(struct seq_file *seq, void *v)
177 {
178 	struct sctp_hashbucket *head;
179 	struct sctp_ep_common *epb;
180 	struct sctp_endpoint *ep;
181 	struct sock *sk;
182 	int    hash = *(loff_t *)v;
183 
184 	if (hash >= sctp_ep_hashsize)
185 		return -ENOMEM;
186 
187 	head = &sctp_ep_hashtable[hash];
188 	read_lock_bh(&head->lock);
189 	sctp_for_each_hentry(epb, &head->chain) {
190 		ep = sctp_ep(epb);
191 		sk = epb->sk;
192 		if (!net_eq(sock_net(sk), seq_file_net(seq)))
193 			continue;
194 		seq_printf(seq, "%8pK %8pK %-3d %-3d %-4d %-5d %5u %5lu ", ep, sk,
195 			   sctp_sk(sk)->type, sk->sk_state, hash,
196 			   epb->bind_addr.port,
197 			   from_kuid_munged(seq_user_ns(seq), sock_i_uid(sk)),
198 			   sock_i_ino(sk));
199 
200 		sctp_seq_dump_local_addrs(seq, epb);
201 		seq_printf(seq, "\n");
202 	}
203 	read_unlock_bh(&head->lock);
204 
205 	return 0;
206 }
207 
208 static const struct seq_operations sctp_eps_ops = {
209 	.start = sctp_eps_seq_start,
210 	.next  = sctp_eps_seq_next,
211 	.stop  = sctp_eps_seq_stop,
212 	.show  = sctp_eps_seq_show,
213 };
214 
215 struct sctp_ht_iter {
216 	struct seq_net_private p;
217 	struct rhashtable_iter hti;
218 	int start_fail;
219 };
220 
221 static void *sctp_transport_seq_start(struct seq_file *seq, loff_t *pos)
222 {
223 	struct sctp_ht_iter *iter = seq->private;
224 
225 	sctp_transport_walk_start(&iter->hti);
226 
227 	iter->start_fail = 0;
228 	return sctp_transport_get_idx(seq_file_net(seq), &iter->hti, *pos);
229 }
230 
231 static void sctp_transport_seq_stop(struct seq_file *seq, void *v)
232 {
233 	struct sctp_ht_iter *iter = seq->private;
234 
235 	if (iter->start_fail)
236 		return;
237 	sctp_transport_walk_stop(&iter->hti);
238 }
239 
240 static void *sctp_transport_seq_next(struct seq_file *seq, void *v, loff_t *pos)
241 {
242 	struct sctp_ht_iter *iter = seq->private;
243 
244 	++*pos;
245 
246 	return sctp_transport_get_next(seq_file_net(seq), &iter->hti);
247 }
248 
249 /* Display sctp associations (/proc/net/sctp/assocs). */
250 static int sctp_assocs_seq_show(struct seq_file *seq, void *v)
251 {
252 	struct sctp_transport *transport;
253 	struct sctp_association *assoc;
254 	struct sctp_ep_common *epb;
255 	struct sock *sk;
256 
257 	if (v == SEQ_START_TOKEN) {
258 		seq_printf(seq, " ASSOC     SOCK   STY SST ST HBKT "
259 				"ASSOC-ID TX_QUEUE RX_QUEUE UID INODE LPORT "
260 				"RPORT LADDRS <-> RADDRS "
261 				"HBINT INS OUTS MAXRT T1X T2X RTXC "
262 				"wmema wmemq sndbuf rcvbuf\n");
263 		return 0;
264 	}
265 
266 	transport = (struct sctp_transport *)v;
267 	if (!sctp_transport_hold(transport))
268 		return 0;
269 	assoc = transport->asoc;
270 	epb = &assoc->base;
271 	sk = epb->sk;
272 
273 	seq_printf(seq,
274 		   "%8pK %8pK %-3d %-3d %-2d %-4d "
275 		   "%4d %8d %8d %7u %5lu %-5d %5d ",
276 		   assoc, sk, sctp_sk(sk)->type, sk->sk_state,
277 		   assoc->state, 0,
278 		   assoc->assoc_id,
279 		   assoc->sndbuf_used,
280 		   atomic_read(&assoc->rmem_alloc),
281 		   from_kuid_munged(seq_user_ns(seq), sock_i_uid(sk)),
282 		   sock_i_ino(sk),
283 		   epb->bind_addr.port,
284 		   assoc->peer.port);
285 	seq_printf(seq, " ");
286 	sctp_seq_dump_local_addrs(seq, epb);
287 	seq_printf(seq, "<-> ");
288 	sctp_seq_dump_remote_addrs(seq, assoc);
289 	seq_printf(seq, "\t%8lu %5d %5d %4d %4d %4d %8d "
290 		   "%8d %8d %8d %8d",
291 		assoc->hbinterval, assoc->stream.incnt,
292 		assoc->stream.outcnt, assoc->max_retrans,
293 		assoc->init_retries, assoc->shutdown_retries,
294 		assoc->rtx_data_chunks,
295 		refcount_read(&sk->sk_wmem_alloc),
296 		sk->sk_wmem_queued,
297 		sk->sk_sndbuf,
298 		sk->sk_rcvbuf);
299 	seq_printf(seq, "\n");
300 
301 	sctp_transport_put(transport);
302 
303 	return 0;
304 }
305 
306 static const struct seq_operations sctp_assoc_ops = {
307 	.start = sctp_transport_seq_start,
308 	.next  = sctp_transport_seq_next,
309 	.stop  = sctp_transport_seq_stop,
310 	.show  = sctp_assocs_seq_show,
311 };
312 
313 static int sctp_remaddr_seq_show(struct seq_file *seq, void *v)
314 {
315 	struct sctp_association *assoc;
316 	struct sctp_transport *transport, *tsp;
317 
318 	if (v == SEQ_START_TOKEN) {
319 		seq_printf(seq, "ADDR ASSOC_ID HB_ACT RTO MAX_PATH_RTX "
320 				"REM_ADDR_RTX START STATE\n");
321 		return 0;
322 	}
323 
324 	transport = (struct sctp_transport *)v;
325 	if (!sctp_transport_hold(transport))
326 		return 0;
327 	assoc = transport->asoc;
328 
329 	list_for_each_entry_rcu(tsp, &assoc->peer.transport_addr_list,
330 				transports) {
331 		/*
332 		 * The remote address (ADDR)
333 		 */
334 		tsp->af_specific->seq_dump_addr(seq, &tsp->ipaddr);
335 		seq_printf(seq, " ");
336 		/*
337 		 * The association ID (ASSOC_ID)
338 		 */
339 		seq_printf(seq, "%d ", tsp->asoc->assoc_id);
340 
341 		/*
342 		 * If the Heartbeat is active (HB_ACT)
343 		 * Note: 1 = Active, 0 = Inactive
344 		 */
345 		seq_printf(seq, "%d ", timer_pending(&tsp->hb_timer));
346 
347 		/*
348 		 * Retransmit time out (RTO)
349 		 */
350 		seq_printf(seq, "%lu ", tsp->rto);
351 
352 		/*
353 		 * Maximum path retransmit count (PATH_MAX_RTX)
354 		 */
355 		seq_printf(seq, "%d ", tsp->pathmaxrxt);
356 
357 		/*
358 		 * remote address retransmit count (REM_ADDR_RTX)
359 		 * Note: We don't have a way to tally this at the moment
360 		 * so lets just leave it as zero for the moment
361 		 */
362 		seq_puts(seq, "0 ");
363 
364 		/*
365 		 * remote address start time (START).  This is also not
366 		 * currently implemented, but we can record it with a
367 		 * jiffies marker in a subsequent patch
368 		 */
369 		seq_puts(seq, "0 ");
370 
371 		/*
372 		 * The current state of this destination. I.e.
373 		 * SCTP_ACTIVE, SCTP_INACTIVE, ...
374 		 */
375 		seq_printf(seq, "%d", tsp->state);
376 
377 		seq_printf(seq, "\n");
378 	}
379 
380 	sctp_transport_put(transport);
381 
382 	return 0;
383 }
384 
385 static const struct seq_operations sctp_remaddr_ops = {
386 	.start = sctp_transport_seq_start,
387 	.next  = sctp_transport_seq_next,
388 	.stop  = sctp_transport_seq_stop,
389 	.show  = sctp_remaddr_seq_show,
390 };
391 
392 /* Set up the proc fs entry for the SCTP protocol. */
393 int __net_init sctp_proc_init(struct net *net)
394 {
395 	net->sctp.proc_net_sctp = proc_net_mkdir(net, "sctp", net->proc_net);
396 	if (!net->sctp.proc_net_sctp)
397 		return -ENOMEM;
398 	if (!proc_create_net_single("snmp", 0444, net->sctp.proc_net_sctp,
399 			 sctp_snmp_seq_show, NULL))
400 		goto cleanup;
401 	if (!proc_create_net("eps", 0444, net->sctp.proc_net_sctp,
402 			&sctp_eps_ops, sizeof(struct seq_net_private)))
403 		goto cleanup;
404 	if (!proc_create_net("assocs", 0444, net->sctp.proc_net_sctp,
405 			&sctp_assoc_ops, sizeof(struct sctp_ht_iter)))
406 		goto cleanup;
407 	if (!proc_create_net("remaddr", 0444, net->sctp.proc_net_sctp,
408 			&sctp_remaddr_ops, sizeof(struct sctp_ht_iter)))
409 		goto cleanup;
410 	return 0;
411 
412 cleanup:
413 	remove_proc_subtree("sctp", net->proc_net);
414 	net->sctp.proc_net_sctp = NULL;
415 	return -ENOMEM;
416 }
417