xref: /netbsd-src/usr.bin/netstat/mroute.c (revision d7198e62f3565aa328f57629aedc2a84514f056f)
1 /*	$NetBSD: mroute.c,v 1.27 2022/09/01 10:10:20 msaitoh Exp $	*/
2 
3 /*
4  * Copyright (c) 1992, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Stephen Deering of Stanford University.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	from: @(#)mroute.c	8.1 (Berkeley) 6/6/93
35  */
36 
37 /*
38  * Copyright (c) 1989 Stephen Deering
39  *
40  * This code is derived from software contributed to Berkeley by
41  * Stephen Deering of Stanford University.
42  *
43  * Redistribution and use in source and binary forms, with or without
44  * modification, are permitted provided that the following conditions
45  * are met:
46  * 1. Redistributions of source code must retain the above copyright
47  *    notice, this list of conditions and the following disclaimer.
48  * 2. Redistributions in binary form must reproduce the above copyright
49  *    notice, this list of conditions and the following disclaimer in the
50  *    documentation and/or other materials provided with the distribution.
51  * 3. All advertising materials mentioning features or use of this software
52  *    must display the following acknowledgement:
53  *	This product includes software developed by the University of
54  *	California, Berkeley and its contributors.
55  * 4. Neither the name of the University nor the names of its contributors
56  *    may be used to endorse or promote products derived from this software
57  *    without specific prior written permission.
58  *
59  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69  * SUCH DAMAGE.
70  *
71  *	from: @(#)mroute.c	8.1 (Berkeley) 6/6/93
72  */
73 
74 #include <sys/cdefs.h>
75 #ifndef lint
76 #if 0
77 static char sccsid[] = "from: @(#)mroute.c	8.1 (Berkeley) 6/6/93";
78 #else
79 __RCSID("$NetBSD: mroute.c,v 1.27 2022/09/01 10:10:20 msaitoh Exp $");
80 #endif
81 #endif /* not lint */
82 
83 /*
84  * Print multicast routing structures and statistics.
85  *
86  * MROUTING 1.0
87  */
88 
89 #include <sys/param.h>
90 #include <sys/socket.h>
91 #include <sys/socketvar.h>
92 #include <sys/protosw.h>
93 
94 #include <net/if.h>
95 #include <net/route.h>
96 #include <netinet/in.h>
97 #include <netinet/igmp.h>
98 #define _KERNEL
99 #include <netinet/ip_mroute.h>
100 #undef _KERNEL
101 
102 #include <stdio.h>
103 #include <stdlib.h>
104 #include <kvm.h>
105 #include "netstat.h"
106 #include "rtutil.h"
107 
108 static char *pktscale(u_long);
109 static void print_bw_meter(struct bw_meter *, int *);
110 
111 static char *
pktscale(u_long n)112 pktscale(u_long n)
113 {
114 	static char buf[20];
115 	char t;
116 
117 	if (n < 1024)
118 		t = ' ';
119 	else if (n < 1024 * 1024) {
120 		t = 'k';
121 		n /= 1024;
122 	} else {
123 		t = 'm';
124 		n /= 1048576;
125 	}
126 
127 	(void)snprintf(buf, sizeof buf, "%lu%c", n, t);
128 	return buf;
129 }
130 
131 void
mroutepr(u_long mrpaddr,u_long mfchashtbladdr,u_long mfchashaddr,u_long vifaddr)132 mroutepr(u_long mrpaddr, u_long mfchashtbladdr, u_long mfchashaddr,
133 	u_long vifaddr)
134 {
135 	u_int mrtproto;
136 	LIST_HEAD(, mfc) *mfchashtbl;
137 	u_long mfchash, i;
138 	struct vif viftable[MAXVIFS];
139 	struct mfc *mfcp, mfc;
140 	struct vif *v;
141 	vifi_t vifi;
142 	int banner_printed;
143 	int saved_numeric_addr;
144 	int numvifs;
145 	int nmfc;		/* No. of cache entries */
146 
147 	if (mrpaddr == 0) {
148 		printf("ip_mrtproto: symbol not in namelist\n");
149 		return;
150 	}
151 
152 	kread(mrpaddr, (char *)&mrtproto, sizeof(mrtproto));
153 	switch (mrtproto) {
154 	case 0:
155 		printf("no multicast routing compiled into this system\n");
156 		return;
157 
158 	case IGMP_DVMRP:
159 		break;
160 
161 	default:
162 		printf("multicast routing protocol %u, unknown\n", mrtproto);
163 		return;
164 	}
165 
166 	if (mfchashtbladdr == 0) {
167 		printf("mfchashtbl: symbol not in namelist\n");
168 		return;
169 	}
170 	if (mfchashaddr == 0) {
171 		printf("mfchash: symbol not in namelist\n");
172 		return;
173 	}
174 	if (vifaddr == 0) {
175 		printf("viftable: symbol not in namelist\n");
176 		return;
177 	}
178 
179 	saved_numeric_addr = numeric_addr;
180 	numeric_addr = 1;
181 
182 	kread(vifaddr, (char *)&viftable, sizeof(viftable));
183 	banner_printed = 0;
184 	numvifs = 0;
185 
186 	for (vifi = 0, v = viftable; vifi < MAXVIFS; ++vifi, ++v) {
187 		if (v->v_lcl_addr.s_addr == 0)
188 			continue;
189 		numvifs = vifi;
190 
191 		if (!banner_printed) {
192 			printf("\nVirtual Interface Table\n %s%s",
193 			    "Vif  Thresh  Limit  Local-Address    ",
194 			    "Remote-Address   Pkt_in  Pkt_out\n");
195 			banner_printed = 1;
196 		}
197 
198 		printf(" %3u     %3u  %5u  %-15.15s",
199 		    vifi, v->v_threshold, v->v_rate_limit,
200 		    routename4(v->v_lcl_addr.s_addr, nflag));
201 		printf("  %-15.15s  %6lu  %7lu\n", (v->v_flags & VIFF_TUNNEL) ?
202 		    routename4(v->v_rmt_addr.s_addr, nflag) : "",
203 		    v->v_pkt_in, v->v_pkt_out);
204 	}
205 	if (!banner_printed)
206 		printf("\nVirtual Interface Table is empty\n");
207 
208 	kread(mfchashtbladdr, (char *)&mfchashtbl, sizeof(mfchashtbl));
209 	kread(mfchashaddr, (char *)&mfchash, sizeof(mfchash));
210 	banner_printed = 0;
211 	nmfc = 0;
212 
213 	if (mfchashtbl != 0)
214 	for (i = 0; i <= mfchash; ++i) {
215 		kread((u_long)&mfchashtbl[i], (char *)&mfcp, sizeof(mfcp));
216 
217 		for (; mfcp != 0; mfcp = mfc.mfc_hash.le_next) {
218 			if (!banner_printed) {
219 				printf("\nMulticast Forwarding Cache\n %s%s",
220 				    "Hash  Origin           Mcastgroup       ",
221 				    "Traffic  In-Vif  Out-Vifs/Forw-ttl\n");
222 				banner_printed = 1;
223 			}
224 
225 			kread((u_long)mfcp, (char *)&mfc, sizeof(mfc));
226 			printf("  %3lu  %-15.15s",
227 			    i, routename4(mfc.mfc_origin.s_addr, nflag));
228 			printf("  %-15.15s  %7s     %3u ",
229 			    routename4(mfc.mfc_mcastgrp.s_addr, nflag),
230 			    pktscale(mfc.mfc_pkt_cnt), mfc.mfc_parent);
231 			for (vifi = 0; vifi <= numvifs; ++vifi)
232 				if (mfc.mfc_ttls[vifi])
233 					printf(" %u/%u", vifi,
234 					    mfc.mfc_ttls[vifi]);
235 
236 			printf("\n");
237 
238 			/* Print the bw meter information */
239 			{
240 				struct bw_meter bw_meter, *bwm;
241 				int banner_printed2 = 0;
242 
243 				bwm = mfc.mfc_bw_meter;
244 				while (bwm) {
245 					kread((u_long)bwm,
246 					    (char *)&bw_meter,
247 					    sizeof bw_meter);
248 					print_bw_meter(&bw_meter,
249 					    &banner_printed2);
250 					bwm = bw_meter.bm_mfc_next;
251 				}
252 #if 0	/* Don't ever print it? */
253 				if (! banner_printed2)
254 				    printf("\n  No Bandwidth Meters\n");
255 #endif
256 			}
257 
258 			nmfc++;
259 		}
260 	}
261 	if (!banner_printed)
262 		printf("\nMulticast Forwarding Cache is empty\n");
263 	else
264 		printf("\nTotal no. of entries in cache: %d\n", nmfc);
265 
266 	printf("\n");
267 	numeric_addr = saved_numeric_addr;
268 }
269 
270 static void
print_bw_meter(struct bw_meter * bw_meter,int * banner_printed)271 print_bw_meter(struct bw_meter *bw_meter, int *banner_printed)
272 {
273 	char s0[256*3], s1[256], s2[256], s3[256];
274 	struct timeval now, end, delta;
275 
276 	gettimeofday(&now, NULL);
277 
278 	if (! *banner_printed) {
279 		printf(" Bandwidth Meters\n");
280 		printf("  %-30s", "Measured(Start|Packets|Bytes)");
281 		printf(" %s", "Type");
282 		printf("  %-30s", "Thresh(Interval|Packets|Bytes)");
283 		printf(" Remain");
284 		printf("\n");
285 		*banner_printed = 1;
286 	}
287 
288 	/* The measured values */
289 	if (bw_meter->bm_flags & BW_METER_UNIT_PACKETS)
290 		snprintf(s1, sizeof s1, "%llu",
291 		    (unsigned long long)bw_meter->bm_measured.b_packets);
292 	else
293 		snprintf(s1, sizeof s1, "?");
294 	if (bw_meter->bm_flags & BW_METER_UNIT_BYTES)
295 		snprintf(s2, sizeof s2, "%llu",
296 		    (unsigned long long)bw_meter->bm_measured.b_bytes);
297 	else
298 		snprintf(s2, sizeof s2, "?");
299 	snprintf(s0, sizeof s0, "%lld.%ld|%s|%s",
300 		(long long)bw_meter->bm_start_time.tv_sec,
301 		(long)bw_meter->bm_start_time.tv_usec,
302 		s1, s2);
303 	printf("  %-30s", s0);
304 
305 	/* The type of entry */
306 	snprintf(s0, sizeof s0, "%s", "?");
307 	if (bw_meter->bm_flags & BW_METER_GEQ)
308 		snprintf(s0, sizeof s0, "%s", ">=");
309 	else if (bw_meter->bm_flags & BW_METER_LEQ)
310 		snprintf(s0, sizeof s0, "%s", "<=");
311 	printf("  %-3s", s0);
312 
313 	/* The threshold values */
314 	if (bw_meter->bm_flags & BW_METER_UNIT_PACKETS)
315 		snprintf(s1, sizeof s1, "%llu",
316 		    (unsigned long long)bw_meter->bm_threshold.b_packets);
317 	else
318 		snprintf(s1, sizeof s1, "?");
319 	if (bw_meter->bm_flags & BW_METER_UNIT_BYTES)
320 		snprintf(s2, sizeof s2, "%llu",
321 		    (unsigned long long)bw_meter->bm_threshold.b_bytes);
322 	else
323 		snprintf(s2, sizeof s2, "?");
324 	snprintf(s0, sizeof s0, "%lld.%ld|%s|%s",
325 		(long long)bw_meter->bm_threshold.b_time.tv_sec,
326 		(long)bw_meter->bm_threshold.b_time.tv_usec,
327 		s1, s2);
328 	printf("  %-30s", s0);
329 
330 	/* Remaining time */
331 	timeradd(&bw_meter->bm_start_time,
332 		 &bw_meter->bm_threshold.b_time, &end);
333 	if (timercmp(&now, &end, <=)) {
334 		timersub(&end, &now, &delta);
335 		snprintf(s3, sizeof s3, "%lld.%ld",
336 		    (long long)delta.tv_sec, (long)delta.tv_usec);
337 	} else {
338 		/* Negative time */
339 		timersub(&now, &end, &delta);
340 		snprintf(s3, sizeof s3, "-%lld.%ld",
341 		    (long long)delta.tv_sec, (long)delta.tv_usec);
342 	}
343 	printf(" %s", s3);
344 
345 	printf("\n");
346 }
347 
348 void
mrt_stats(u_long mrpaddr,u_long mstaddr)349 mrt_stats(u_long mrpaddr, u_long mstaddr)
350 {
351 	u_int mrtproto;
352 	struct mrtstat mrtstat;
353 
354 	if (mrpaddr == 0) {
355 		printf("ip_mrtproto: symbol not in namelist\n");
356 		return;
357 	}
358 
359 	kread(mrpaddr, (char *)&mrtproto, sizeof(mrtproto));
360 	switch (mrtproto) {
361 	case 0:
362 		printf("no multicast routing compiled into this system\n");
363 		return;
364 
365 	case IGMP_DVMRP:
366 		break;
367 
368 	default:
369 		printf("multicast routing protocol %u, unknown\n", mrtproto);
370 		return;
371 	}
372 
373 	if (mstaddr == 0) {
374 		printf("mrtstat: symbol not in namelist\n");
375 		return;
376 	}
377 
378 	kread(mstaddr, (char *)&mrtstat, sizeof(mrtstat));
379 	printf("multicast routing:\n");
380 	printf("\t%lu datagram%s with no route for origin\n",
381 	    mrtstat.mrts_no_route, plural(mrtstat.mrts_no_route));
382 	printf("\t%lu upcall%s made to mrouted\n",
383 	    mrtstat.mrts_upcalls, plural(mrtstat.mrts_upcalls));
384 	printf("\t%lu datagram%s with malformed tunnel options\n",
385 	    mrtstat.mrts_bad_tunnel, plural(mrtstat.mrts_bad_tunnel));
386 	printf("\t%lu datagram%s with no room for tunnel options\n",
387 	    mrtstat.mrts_cant_tunnel, plural(mrtstat.mrts_cant_tunnel));
388 	printf("\t%lu datagram%s arrived on wrong interface\n",
389 	    mrtstat.mrts_wrong_if, plural(mrtstat.mrts_wrong_if));
390 	printf("\t%lu datagram%s dropped due to upcall Q overflow\n",
391 	    mrtstat.mrts_upq_ovflw, plural(mrtstat.mrts_upq_ovflw));
392 	printf("\t%lu datagram%s dropped due to upcall socket overflow\n",
393 	    mrtstat.mrts_upq_sockfull, plural(mrtstat.mrts_upq_sockfull));
394 	printf("\t%lu datagram%s cleaned up by the cache\n",
395 	    mrtstat.mrts_cache_cleanups, plural(mrtstat.mrts_cache_cleanups));
396 	printf("\t%lu datagram%s dropped selectively by ratelimiter\n",
397 	    mrtstat.mrts_drop_sel, plural(mrtstat.mrts_drop_sel));
398 	printf("\t%lu datagram%s dropped - bucket Q overflow\n",
399 	    mrtstat.mrts_q_overflow, plural(mrtstat.mrts_q_overflow));
400 	printf("\t%lu datagram%s dropped - larger than bkt size\n",
401 	    mrtstat.mrts_pkt2large, plural(mrtstat.mrts_pkt2large));
402 }
403