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