xref: /openbmc/linux/net/sctp/proc.c (revision 110e6f26)
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 	struct net *net = seq->private;
77 	int i;
78 
79 	for (i = 0; sctp_snmp_list[i].name != NULL; i++)
80 		seq_printf(seq, "%-32s\t%ld\n", sctp_snmp_list[i].name,
81 			   snmp_fold_field(net->sctp.sctp_statistics,
82 				      sctp_snmp_list[i].entry));
83 
84 	return 0;
85 }
86 
87 /* Initialize the seq file operations for 'snmp' object. */
88 static int sctp_snmp_seq_open(struct inode *inode, struct file *file)
89 {
90 	return single_open_net(inode, file, sctp_snmp_seq_show);
91 }
92 
93 static const struct file_operations sctp_snmp_seq_fops = {
94 	.owner	 = THIS_MODULE,
95 	.open	 = sctp_snmp_seq_open,
96 	.read	 = seq_read,
97 	.llseek	 = seq_lseek,
98 	.release = single_release_net,
99 };
100 
101 /* Set up the proc fs entry for 'snmp' object. */
102 int __net_init sctp_snmp_proc_init(struct net *net)
103 {
104 	struct proc_dir_entry *p;
105 
106 	p = proc_create("snmp", S_IRUGO, net->sctp.proc_net_sctp,
107 			&sctp_snmp_seq_fops);
108 	if (!p)
109 		return -ENOMEM;
110 
111 	return 0;
112 }
113 
114 /* Cleanup the proc fs entry for 'snmp' object. */
115 void sctp_snmp_proc_exit(struct net *net)
116 {
117 	remove_proc_entry("snmp", net->sctp.proc_net_sctp);
118 }
119 
120 /* Dump local addresses of an association/endpoint. */
121 static void sctp_seq_dump_local_addrs(struct seq_file *seq, struct sctp_ep_common *epb)
122 {
123 	struct sctp_association *asoc;
124 	struct sctp_sockaddr_entry *laddr;
125 	struct sctp_transport *peer;
126 	union sctp_addr *addr, *primary = NULL;
127 	struct sctp_af *af;
128 
129 	if (epb->type == SCTP_EP_TYPE_ASSOCIATION) {
130 		asoc = sctp_assoc(epb);
131 
132 		peer = asoc->peer.primary_path;
133 		if (unlikely(peer == NULL)) {
134 			WARN(1, "Association %p with NULL primary path!\n", asoc);
135 			return;
136 		}
137 
138 		primary = &peer->saddr;
139 	}
140 
141 	rcu_read_lock();
142 	list_for_each_entry_rcu(laddr, &epb->bind_addr.address_list, list) {
143 		if (!laddr->valid)
144 			continue;
145 
146 		addr = &laddr->a;
147 		af = sctp_get_af_specific(addr->sa.sa_family);
148 		if (primary && af->cmp_addr(addr, primary)) {
149 			seq_printf(seq, "*");
150 		}
151 		af->seq_dump_addr(seq, addr);
152 	}
153 	rcu_read_unlock();
154 }
155 
156 /* Dump remote addresses of an association. */
157 static void sctp_seq_dump_remote_addrs(struct seq_file *seq, struct sctp_association *assoc)
158 {
159 	struct sctp_transport *transport;
160 	union sctp_addr *addr, *primary;
161 	struct sctp_af *af;
162 
163 	primary = &assoc->peer.primary_addr;
164 	list_for_each_entry_rcu(transport, &assoc->peer.transport_addr_list,
165 			transports) {
166 		addr = &transport->ipaddr;
167 
168 		af = sctp_get_af_specific(addr->sa.sa_family);
169 		if (af->cmp_addr(addr, primary)) {
170 			seq_printf(seq, "*");
171 		}
172 		af->seq_dump_addr(seq, addr);
173 	}
174 }
175 
176 static void *sctp_eps_seq_start(struct seq_file *seq, loff_t *pos)
177 {
178 	if (*pos >= sctp_ep_hashsize)
179 		return NULL;
180 
181 	if (*pos < 0)
182 		*pos = 0;
183 
184 	if (*pos == 0)
185 		seq_printf(seq, " ENDPT     SOCK   STY SST HBKT LPORT   UID INODE LADDRS\n");
186 
187 	return (void *)pos;
188 }
189 
190 static void sctp_eps_seq_stop(struct seq_file *seq, void *v)
191 {
192 }
193 
194 
195 static void *sctp_eps_seq_next(struct seq_file *seq, void *v, loff_t *pos)
196 {
197 	if (++*pos >= sctp_ep_hashsize)
198 		return NULL;
199 
200 	return pos;
201 }
202 
203 
204 /* Display sctp endpoints (/proc/net/sctp/eps). */
205 static int sctp_eps_seq_show(struct seq_file *seq, void *v)
206 {
207 	struct sctp_hashbucket *head;
208 	struct sctp_ep_common *epb;
209 	struct sctp_endpoint *ep;
210 	struct sock *sk;
211 	int    hash = *(loff_t *)v;
212 
213 	if (hash >= sctp_ep_hashsize)
214 		return -ENOMEM;
215 
216 	head = &sctp_ep_hashtable[hash];
217 	local_bh_disable();
218 	read_lock(&head->lock);
219 	sctp_for_each_hentry(epb, &head->chain) {
220 		ep = sctp_ep(epb);
221 		sk = epb->sk;
222 		if (!net_eq(sock_net(sk), seq_file_net(seq)))
223 			continue;
224 		seq_printf(seq, "%8pK %8pK %-3d %-3d %-4d %-5d %5u %5lu ", ep, sk,
225 			   sctp_sk(sk)->type, sk->sk_state, hash,
226 			   epb->bind_addr.port,
227 			   from_kuid_munged(seq_user_ns(seq), sock_i_uid(sk)),
228 			   sock_i_ino(sk));
229 
230 		sctp_seq_dump_local_addrs(seq, epb);
231 		seq_printf(seq, "\n");
232 	}
233 	read_unlock(&head->lock);
234 	local_bh_enable();
235 
236 	return 0;
237 }
238 
239 static const struct seq_operations sctp_eps_ops = {
240 	.start = sctp_eps_seq_start,
241 	.next  = sctp_eps_seq_next,
242 	.stop  = sctp_eps_seq_stop,
243 	.show  = sctp_eps_seq_show,
244 };
245 
246 
247 /* Initialize the seq file operations for 'eps' object. */
248 static int sctp_eps_seq_open(struct inode *inode, struct file *file)
249 {
250 	return seq_open_net(inode, file, &sctp_eps_ops,
251 			    sizeof(struct seq_net_private));
252 }
253 
254 static const struct file_operations sctp_eps_seq_fops = {
255 	.open	 = sctp_eps_seq_open,
256 	.read	 = seq_read,
257 	.llseek	 = seq_lseek,
258 	.release = seq_release_net,
259 };
260 
261 /* Set up the proc fs entry for 'eps' object. */
262 int __net_init sctp_eps_proc_init(struct net *net)
263 {
264 	struct proc_dir_entry *p;
265 
266 	p = proc_create("eps", S_IRUGO, net->sctp.proc_net_sctp,
267 			&sctp_eps_seq_fops);
268 	if (!p)
269 		return -ENOMEM;
270 
271 	return 0;
272 }
273 
274 /* Cleanup the proc fs entry for 'eps' object. */
275 void sctp_eps_proc_exit(struct net *net)
276 {
277 	remove_proc_entry("eps", net->sctp.proc_net_sctp);
278 }
279 
280 struct sctp_ht_iter {
281 	struct seq_net_private p;
282 	struct rhashtable_iter hti;
283 };
284 
285 static struct sctp_transport *sctp_transport_get_next(struct seq_file *seq)
286 {
287 	struct sctp_ht_iter *iter = seq->private;
288 	struct sctp_transport *t;
289 
290 	t = rhashtable_walk_next(&iter->hti);
291 	for (; t; t = rhashtable_walk_next(&iter->hti)) {
292 		if (IS_ERR(t)) {
293 			if (PTR_ERR(t) == -EAGAIN)
294 				continue;
295 			break;
296 		}
297 
298 		if (net_eq(sock_net(t->asoc->base.sk), seq_file_net(seq)) &&
299 		    t->asoc->peer.primary_path == t)
300 			break;
301 	}
302 
303 	return t;
304 }
305 
306 static struct sctp_transport *sctp_transport_get_idx(struct seq_file *seq,
307 						     loff_t pos)
308 {
309 	void *obj = SEQ_START_TOKEN;
310 
311 	while (pos && (obj = sctp_transport_get_next(seq)) && !IS_ERR(obj))
312 		pos--;
313 
314 	return obj;
315 }
316 
317 static int sctp_transport_walk_start(struct seq_file *seq)
318 {
319 	struct sctp_ht_iter *iter = seq->private;
320 	int err;
321 
322 	err = rhashtable_walk_init(&sctp_transport_hashtable, &iter->hti);
323 	if (err)
324 		return err;
325 
326 	err = rhashtable_walk_start(&iter->hti);
327 
328 	return err == -EAGAIN ? 0 : err;
329 }
330 
331 static void sctp_transport_walk_stop(struct seq_file *seq)
332 {
333 	struct sctp_ht_iter *iter = seq->private;
334 
335 	rhashtable_walk_stop(&iter->hti);
336 	rhashtable_walk_exit(&iter->hti);
337 }
338 
339 static void *sctp_assocs_seq_start(struct seq_file *seq, loff_t *pos)
340 {
341 	int err = sctp_transport_walk_start(seq);
342 
343 	if (err)
344 		return ERR_PTR(err);
345 
346 	return sctp_transport_get_idx(seq, *pos);
347 }
348 
349 static void sctp_assocs_seq_stop(struct seq_file *seq, void *v)
350 {
351 	sctp_transport_walk_stop(seq);
352 }
353 
354 static void *sctp_assocs_seq_next(struct seq_file *seq, void *v, loff_t *pos)
355 {
356 	++*pos;
357 
358 	return sctp_transport_get_next(seq);
359 }
360 
361 /* Display sctp associations (/proc/net/sctp/assocs). */
362 static int sctp_assocs_seq_show(struct seq_file *seq, void *v)
363 {
364 	struct sctp_transport *transport;
365 	struct sctp_association *assoc;
366 	struct sctp_ep_common *epb;
367 	struct sock *sk;
368 
369 	if (v == SEQ_START_TOKEN) {
370 		seq_printf(seq, " ASSOC     SOCK   STY SST ST HBKT "
371 				"ASSOC-ID TX_QUEUE RX_QUEUE UID INODE LPORT "
372 				"RPORT LADDRS <-> RADDRS "
373 				"HBINT INS OUTS MAXRT T1X T2X RTXC "
374 				"wmema wmemq sndbuf rcvbuf\n");
375 		return 0;
376 	}
377 
378 	transport = (struct sctp_transport *)v;
379 	if (!sctp_transport_hold(transport))
380 		return 0;
381 	assoc = transport->asoc;
382 	epb = &assoc->base;
383 	sk = epb->sk;
384 
385 	seq_printf(seq,
386 		   "%8pK %8pK %-3d %-3d %-2d %-4d "
387 		   "%4d %8d %8d %7u %5lu %-5d %5d ",
388 		   assoc, sk, sctp_sk(sk)->type, sk->sk_state,
389 		   assoc->state, 0,
390 		   assoc->assoc_id,
391 		   assoc->sndbuf_used,
392 		   atomic_read(&assoc->rmem_alloc),
393 		   from_kuid_munged(seq_user_ns(seq), sock_i_uid(sk)),
394 		   sock_i_ino(sk),
395 		   epb->bind_addr.port,
396 		   assoc->peer.port);
397 	seq_printf(seq, " ");
398 	sctp_seq_dump_local_addrs(seq, epb);
399 	seq_printf(seq, "<-> ");
400 	sctp_seq_dump_remote_addrs(seq, assoc);
401 	seq_printf(seq, "\t%8lu %5d %5d %4d %4d %4d %8d "
402 		   "%8d %8d %8d %8d",
403 		assoc->hbinterval, assoc->c.sinit_max_instreams,
404 		assoc->c.sinit_num_ostreams, assoc->max_retrans,
405 		assoc->init_retries, assoc->shutdown_retries,
406 		assoc->rtx_data_chunks,
407 		atomic_read(&sk->sk_wmem_alloc),
408 		sk->sk_wmem_queued,
409 		sk->sk_sndbuf,
410 		sk->sk_rcvbuf);
411 	seq_printf(seq, "\n");
412 
413 	sctp_transport_put(transport);
414 
415 	return 0;
416 }
417 
418 static const struct seq_operations sctp_assoc_ops = {
419 	.start = sctp_assocs_seq_start,
420 	.next  = sctp_assocs_seq_next,
421 	.stop  = sctp_assocs_seq_stop,
422 	.show  = sctp_assocs_seq_show,
423 };
424 
425 /* Initialize the seq file operations for 'assocs' object. */
426 static int sctp_assocs_seq_open(struct inode *inode, struct file *file)
427 {
428 	return seq_open_net(inode, file, &sctp_assoc_ops,
429 			    sizeof(struct sctp_ht_iter));
430 }
431 
432 static const struct file_operations sctp_assocs_seq_fops = {
433 	.open	 = sctp_assocs_seq_open,
434 	.read	 = seq_read,
435 	.llseek	 = seq_lseek,
436 	.release = seq_release_net,
437 };
438 
439 /* Set up the proc fs entry for 'assocs' object. */
440 int __net_init sctp_assocs_proc_init(struct net *net)
441 {
442 	struct proc_dir_entry *p;
443 
444 	p = proc_create("assocs", S_IRUGO, net->sctp.proc_net_sctp,
445 			&sctp_assocs_seq_fops);
446 	if (!p)
447 		return -ENOMEM;
448 
449 	return 0;
450 }
451 
452 /* Cleanup the proc fs entry for 'assocs' object. */
453 void sctp_assocs_proc_exit(struct net *net)
454 {
455 	remove_proc_entry("assocs", net->sctp.proc_net_sctp);
456 }
457 
458 static void *sctp_remaddr_seq_start(struct seq_file *seq, loff_t *pos)
459 {
460 	int err = sctp_transport_walk_start(seq);
461 
462 	if (err)
463 		return ERR_PTR(err);
464 
465 	return sctp_transport_get_idx(seq, *pos);
466 }
467 
468 static void *sctp_remaddr_seq_next(struct seq_file *seq, void *v, loff_t *pos)
469 {
470 	++*pos;
471 
472 	return sctp_transport_get_next(seq);
473 }
474 
475 static void sctp_remaddr_seq_stop(struct seq_file *seq, void *v)
476 {
477 	sctp_transport_walk_stop(seq);
478 }
479 
480 static int sctp_remaddr_seq_show(struct seq_file *seq, void *v)
481 {
482 	struct sctp_association *assoc;
483 	struct sctp_transport *transport, *tsp;
484 
485 	if (v == SEQ_START_TOKEN) {
486 		seq_printf(seq, "ADDR ASSOC_ID HB_ACT RTO MAX_PATH_RTX "
487 				"REM_ADDR_RTX START STATE\n");
488 		return 0;
489 	}
490 
491 	transport = (struct sctp_transport *)v;
492 	if (!sctp_transport_hold(transport))
493 		return 0;
494 	assoc = transport->asoc;
495 
496 	list_for_each_entry_rcu(tsp, &assoc->peer.transport_addr_list,
497 				transports) {
498 		/*
499 		 * The remote address (ADDR)
500 		 */
501 		tsp->af_specific->seq_dump_addr(seq, &tsp->ipaddr);
502 		seq_printf(seq, " ");
503 		/*
504 		 * The association ID (ASSOC_ID)
505 		 */
506 		seq_printf(seq, "%d ", tsp->asoc->assoc_id);
507 
508 		/*
509 		 * If the Heartbeat is active (HB_ACT)
510 		 * Note: 1 = Active, 0 = Inactive
511 		 */
512 		seq_printf(seq, "%d ", timer_pending(&tsp->hb_timer));
513 
514 		/*
515 		 * Retransmit time out (RTO)
516 		 */
517 		seq_printf(seq, "%lu ", tsp->rto);
518 
519 		/*
520 		 * Maximum path retransmit count (PATH_MAX_RTX)
521 		 */
522 		seq_printf(seq, "%d ", tsp->pathmaxrxt);
523 
524 		/*
525 		 * remote address retransmit count (REM_ADDR_RTX)
526 		 * Note: We don't have a way to tally this at the moment
527 		 * so lets just leave it as zero for the moment
528 		 */
529 		seq_puts(seq, "0 ");
530 
531 		/*
532 		 * remote address start time (START).  This is also not
533 		 * currently implemented, but we can record it with a
534 		 * jiffies marker in a subsequent patch
535 		 */
536 		seq_puts(seq, "0 ");
537 
538 		/*
539 		 * The current state of this destination. I.e.
540 		 * SCTP_ACTIVE, SCTP_INACTIVE, ...
541 		 */
542 		seq_printf(seq, "%d", tsp->state);
543 
544 		seq_printf(seq, "\n");
545 	}
546 
547 	sctp_transport_put(transport);
548 
549 	return 0;
550 }
551 
552 static const struct seq_operations sctp_remaddr_ops = {
553 	.start = sctp_remaddr_seq_start,
554 	.next  = sctp_remaddr_seq_next,
555 	.stop  = sctp_remaddr_seq_stop,
556 	.show  = sctp_remaddr_seq_show,
557 };
558 
559 /* Cleanup the proc fs entry for 'remaddr' object. */
560 void sctp_remaddr_proc_exit(struct net *net)
561 {
562 	remove_proc_entry("remaddr", net->sctp.proc_net_sctp);
563 }
564 
565 static int sctp_remaddr_seq_open(struct inode *inode, struct file *file)
566 {
567 	return seq_open_net(inode, file, &sctp_remaddr_ops,
568 			    sizeof(struct sctp_ht_iter));
569 }
570 
571 static const struct file_operations sctp_remaddr_seq_fops = {
572 	.open = sctp_remaddr_seq_open,
573 	.read = seq_read,
574 	.llseek = seq_lseek,
575 	.release = seq_release_net,
576 };
577 
578 int __net_init sctp_remaddr_proc_init(struct net *net)
579 {
580 	struct proc_dir_entry *p;
581 
582 	p = proc_create("remaddr", S_IRUGO, net->sctp.proc_net_sctp,
583 			&sctp_remaddr_seq_fops);
584 	if (!p)
585 		return -ENOMEM;
586 	return 0;
587 }
588