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