mroute.c revision 160787
1/*
2 * Copyright (c) 1989 Stephen Deering
3 * Copyright (c) 1992, 1993
4 *	The Regents of the University of California.  All rights reserved.
5 *
6 * This code is derived from software contributed to Berkeley by
7 * Stephen Deering of Stanford University.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 *    must display the following acknowledgement:
19 *	This product includes software developed by the University of
20 *	California, Berkeley and its contributors.
21 * 4. Neither the name of the University nor the names of its contributors
22 *    may be used to endorse or promote products derived from this software
23 *    without specific prior written permission.
24 *
25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * SUCH DAMAGE.
36 *
37 *	@(#)mroute.c	8.2 (Berkeley) 4/28/95
38 */
39
40#include <sys/cdefs.h>
41__FBSDID("$FreeBSD: head/usr.bin/netstat/mroute.c 160787 2006-07-28 16:09:19Z yar $");
42
43/*
44 * Print multicast routing structures and statistics.
45 *
46 * MROUTING 1.0
47 */
48
49#include <sys/param.h>
50#include <sys/queue.h>
51#include <sys/socket.h>
52#include <sys/socketvar.h>
53#include <sys/sysctl.h>
54#include <sys/protosw.h>
55#include <sys/mbuf.h>
56#include <sys/time.h>
57
58#include <net/if.h>
59#include <netinet/in.h>
60#include <netinet/igmp.h>
61#include <net/route.h>
62#include <netinet/ip_mroute.h>
63
64#include <err.h>
65#include <stdint.h>
66#include <stdio.h>
67#include <stdlib.h>
68#include "netstat.h"
69
70static void print_bw_meter(struct bw_meter *bw_meter, int *banner_printed);
71
72void
73mroutepr(u_long mfcaddr, u_long vifaddr)
74{
75	struct mfc *mfctable[MFCTBLSIZ];
76	struct vif viftable[MAXVIFS];
77	struct mfc mfc, *m;
78	struct vif *v;
79	vifi_t vifi;
80	int i;
81	int banner_printed;
82	int saved_numeric_addr;
83	vifi_t maxvif = 0;
84	size_t len;
85
86	len = sizeof(mfctable);
87	if (sysctlbyname("net.inet.ip.mfctable", mfctable, &len, NULL, 0) < 0) {
88		warn("sysctl: net.inet.ip.mfctable");
89		/* Compatability with older kernels - candidate for removal */
90		if (mfcaddr == 0) {
91			printf("No IPv4 multicast routing compiled into this system.\n");
92			return;
93		}
94
95		kread(mfcaddr, (char *)mfctable, sizeof(mfctable));
96	}
97
98	len = sizeof(viftable);
99	if (sysctlbyname("net.inet.ip.viftable", viftable, &len, NULL, 0) < 0) {
100		warn("sysctl: net.inet.ip.viftable");
101		/* Compatability with older kernels - candidate for removal */
102		if (vifaddr == 0) {
103			printf("No IPv4 multicast routing compiled into this system.\n");
104			return;
105		}
106
107		kread(vifaddr, (char *)viftable, sizeof(viftable));
108	}
109
110	saved_numeric_addr = numeric_addr;
111	numeric_addr = 1;
112
113	banner_printed = 0;
114	for (vifi = 0, v = viftable; vifi < MAXVIFS; ++vifi, ++v) {
115		if (v->v_lcl_addr.s_addr == 0)
116			continue;
117
118		maxvif = vifi;
119		if (!banner_printed) {
120			printf("\nVirtual Interface Table\n"
121			       " Vif   Thresh   Rate   Local-Address   "
122			       "Remote-Address    Pkts-In   Pkts-Out\n");
123			banner_printed = 1;
124		}
125
126		printf(" %2u    %6u   %4d   %-15.15s",
127					/* opposite math of add_vif() */
128		    vifi, v->v_threshold, v->v_rate_limit * 1000 / 1024,
129		    routename(v->v_lcl_addr.s_addr));
130		printf(" %-15.15s", (v->v_flags & VIFF_TUNNEL) ?
131		    routename(v->v_rmt_addr.s_addr) : "");
132
133		printf(" %9lu  %9lu\n", v->v_pkt_in, v->v_pkt_out);
134	}
135	if (!banner_printed)
136		printf("\nVirtual Interface Table is empty\n");
137
138	banner_printed = 0;
139	for (i = 0; i < MFCTBLSIZ; ++i) {
140		m = mfctable[i];
141		while(m) {
142			kread((u_long)m, (char *)&mfc, sizeof mfc);
143
144			if (!banner_printed) {
145				printf("\nIPv4 Multicast Forwarding Cache\n"
146				       " Origin          Group            "
147				       " Packets In-Vif  Out-Vifs:Ttls\n");
148				banner_printed = 1;
149			}
150
151			printf(" %-15.15s", routename(mfc.mfc_origin.s_addr));
152			printf(" %-15.15s", routename(mfc.mfc_mcastgrp.s_addr));
153			printf(" %9lu", mfc.mfc_pkt_cnt);
154			printf("  %3d   ", mfc.mfc_parent);
155			for (vifi = 0; vifi <= maxvif; vifi++) {
156				if (mfc.mfc_ttls[vifi] > 0)
157					printf(" %u:%u", vifi,
158					       mfc.mfc_ttls[vifi]);
159			}
160			printf("\n");
161
162			/* Print the bw meter information */
163			{
164				struct bw_meter bw_meter, *bwm;
165				int banner_printed2 = 0;
166
167				bwm = mfc.mfc_bw_meter;
168				while (bwm) {
169				    kread((u_long)bwm, (char *)&bw_meter,
170						sizeof bw_meter);
171				    print_bw_meter(&bw_meter,
172						&banner_printed2);
173				    bwm = bw_meter.bm_mfc_next;
174				}
175#if 0	/* Don't ever print it? */
176				if (! banner_printed2)
177				    printf("\n  No Bandwidth Meters\n");
178#endif
179			}
180
181			m = mfc.mfc_next;
182		}
183	}
184	if (!banner_printed)
185		printf("\nMulticast Routing Table is empty\n");
186
187	printf("\n");
188	numeric_addr = saved_numeric_addr;
189}
190
191static void
192print_bw_meter(struct bw_meter *bw_meter, int *banner_printed)
193{
194	char s0[256], s1[256], s2[256], s3[256];
195	struct timeval now, end, delta;
196
197	gettimeofday(&now, NULL);
198
199	if (! *banner_printed) {
200		printf(" Bandwidth Meters\n");
201		printf("  %-30s", "Measured(Start|Packets|Bytes)");
202		printf(" %s", "Type");
203		printf("  %-30s", "Thresh(Interval|Packets|Bytes)");
204		printf(" Remain");
205		printf("\n");
206		*banner_printed = 1;
207	}
208
209	/* The measured values */
210	if (bw_meter->bm_flags & BW_METER_UNIT_PACKETS)
211		sprintf(s1, "%ju", (uintmax_t)bw_meter->bm_measured.b_packets);
212	else
213		sprintf(s1, "?");
214	if (bw_meter->bm_flags & BW_METER_UNIT_BYTES)
215		sprintf(s2, "%ju", (uintmax_t)bw_meter->bm_measured.b_bytes);
216	else
217		sprintf(s2, "?");
218	sprintf(s0, "%lu.%lu|%s|%s",
219		(u_long)bw_meter->bm_start_time.tv_sec,
220		(u_long)bw_meter->bm_start_time.tv_usec,
221		s1, s2);
222	printf("  %-30s", s0);
223
224	/* The type of entry */
225	sprintf(s0, "%s", "?");
226	if (bw_meter->bm_flags & BW_METER_GEQ)
227		sprintf(s0, "%s", ">=");
228	else if (bw_meter->bm_flags & BW_METER_LEQ)
229		sprintf(s0, "%s", "<=");
230	printf("  %-3s", s0);
231
232	/* The threshold values */
233	if (bw_meter->bm_flags & BW_METER_UNIT_PACKETS)
234		sprintf(s1, "%ju", (uintmax_t)bw_meter->bm_threshold.b_packets);
235	else
236		sprintf(s1, "?");
237	if (bw_meter->bm_flags & BW_METER_UNIT_BYTES)
238		sprintf(s2, "%ju", (uintmax_t)bw_meter->bm_threshold.b_bytes);
239	else
240		sprintf(s2, "?");
241	sprintf(s0, "%lu.%lu|%s|%s",
242		(u_long)bw_meter->bm_threshold.b_time.tv_sec,
243		(u_long)bw_meter->bm_threshold.b_time.tv_usec,
244		s1, s2);
245	printf("  %-30s", s0);
246
247	/* Remaining time */
248	timeradd(&bw_meter->bm_start_time,
249		 &bw_meter->bm_threshold.b_time, &end);
250	if (timercmp(&now, &end, <=)) {
251		timersub(&end, &now, &delta);
252		sprintf(s3, "%lu.%lu",
253			(u_long)delta.tv_sec,
254			(u_long)delta.tv_usec);
255	} else {
256		/* Negative time */
257		timersub(&now, &end, &delta);
258		sprintf(s3, "-%lu.%lu",
259			(u_long)delta.tv_sec,
260			(u_long)delta.tv_usec);
261	}
262	printf(" %s", s3);
263
264	printf("\n");
265}
266
267void
268mrt_stats(u_long mstaddr)
269{
270	struct mrtstat mrtstat;
271	size_t len = sizeof mrtstat;
272
273	if (sysctlbyname("net.inet.ip.mrtstat", &mrtstat, &len,
274				NULL, 0) < 0) {
275		warn("sysctl: net.inet.ip.mrtstat");
276		/* Compatability with older kernels - candidate for removal */
277		if (mstaddr == 0) {
278			printf("No IPv4 multicast routing compiled into this system.\n");
279			return;
280		}
281
282		kread(mstaddr, (char *)&mrtstat, sizeof(mrtstat));
283	}
284	printf("IPv4 multicast forwarding:\n");
285
286#define	p(f, m) if (mrtstat.f || sflag <= 1) \
287	printf(m, mrtstat.f, plural(mrtstat.f))
288#define	p2(f, m) if (mrtstat.f || sflag <= 1) \
289	printf(m, mrtstat.f, plurales(mrtstat.f))
290
291	p(mrts_mfc_lookups, "\t%lu multicast forwarding cache lookup%s\n");
292	p2(mrts_mfc_misses, "\t%lu multicast forwarding cache miss%s\n");
293	p(mrts_upcalls, "\t%lu upcall%s to mrouted\n");
294	p(mrts_upq_ovflw, "\t%lu upcall queue overflow%s\n");
295	p(mrts_upq_sockfull,
296	    "\t%lu upcall%s dropped due to full socket buffer\n");
297	p(mrts_cache_cleanups, "\t%lu cache cleanup%s\n");
298	p(mrts_no_route, "\t%lu datagram%s with no route for origin\n");
299	p(mrts_bad_tunnel, "\t%lu datagram%s arrived with bad tunneling\n");
300	p(mrts_cant_tunnel, "\t%lu datagram%s could not be tunneled\n");
301	p(mrts_wrong_if, "\t%lu datagram%s arrived on wrong interface\n");
302	p(mrts_drop_sel, "\t%lu datagram%s selectively dropped\n");
303	p(mrts_q_overflow, "\t%lu datagram%s dropped due to queue overflow\n");
304	p(mrts_pkt2large, "\t%lu datagram%s dropped for being too large\n");
305
306#undef	p2
307#undef	p
308}
309