1 /*-
2 * SPDX-License-Identifier: BSD-4-Clause
3 *
4 * Copyright (c) 1989 Stephen Deering
5 * Copyright (c) 1992, 1993
6 * The Regents of the University of California. All rights reserved.
7 *
8 * This code is derived from software contributed to Berkeley by
9 * Stephen Deering of Stanford University.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the University of
22 * California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 * may be used to endorse or promote products derived from this software
25 * without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * SUCH DAMAGE.
38 *
39 * @(#)mroute.c 8.2 (Berkeley) 4/28/95
40 */
41
42 #include <sys/cdefs.h>
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
63 #define _NETSTAT 1
64 #include <netinet/ip_mroute.h>
65 #undef _NETSTAT_
66
67 #include <err.h>
68 #include <stdint.h>
69 #include <stdio.h>
70 #include <stdlib.h>
71 #include <stdbool.h>
72 #include <string.h>
73 #include <libxo/xo.h>
74 #include "netstat.h"
75 #include "nl_defs.h"
76
77 static void print_bw_meter(struct bw_meter *, int *);
78 static void print_mfc(struct mfc *, int, int *);
79
80 static void
print_bw_meter(struct bw_meter * bw_meter,int * banner_printed)81 print_bw_meter(struct bw_meter *bw_meter, int *banner_printed)
82 {
83 char s1[256], s2[256], s3[256];
84 struct timeval now, end, delta;
85
86 gettimeofday(&now, NULL);
87
88 if (! *banner_printed) {
89 xo_open_list("bandwidth-meter");
90 xo_emit(" {T:Bandwidth Meters}\n");
91 xo_emit(" {T:/%-30s}", "Measured(Start|Packets|Bytes)");
92 xo_emit(" {T:/%s}", "Type");
93 xo_emit(" {T:/%-30s}", "Thresh(Interval|Packets|Bytes)");
94 xo_emit(" {T:Remain}");
95 xo_emit("\n");
96 *banner_printed = 1;
97 }
98
99 xo_open_instance("bandwidth-meter");
100
101 /* The measured values */
102 if (bw_meter->bm_flags & BW_METER_UNIT_PACKETS) {
103 snprintf(s1, sizeof(s1), "%ju",
104 (uintmax_t)bw_meter->bm_measured.b_packets);
105 xo_emit("{e:measured-packets/%ju}",
106 (uintmax_t)bw_meter->bm_measured.b_packets);
107 } else
108 strcpy(s1, "?");
109 if (bw_meter->bm_flags & BW_METER_UNIT_BYTES) {
110 snprintf(s2, sizeof(s2), "%ju",
111 (uintmax_t)bw_meter->bm_measured.b_bytes);
112 xo_emit("{e:measured-bytes/%ju}",
113 (uintmax_t)bw_meter->bm_measured.b_bytes);
114 } else
115 strcpy(s2, "?");
116 xo_emit(" {[:-30}{:start-time/%lu.%06lu}|{q:measured-packets/%s}"
117 "|{q:measured-bytes%s}{]:}",
118 (u_long)bw_meter->bm_start_time.tv_sec,
119 (u_long)bw_meter->bm_start_time.tv_usec, s1, s2);
120
121 /* The type of entry */
122 xo_emit(" {t:type/%-3s}", (bw_meter->bm_flags & BW_METER_GEQ) ? ">=" :
123 (bw_meter->bm_flags & BW_METER_LEQ) ? "<=" : "?");
124
125 /* The threshold values */
126 if (bw_meter->bm_flags & BW_METER_UNIT_PACKETS) {
127 snprintf(s1, sizeof(s1), "%ju",
128 (uintmax_t)bw_meter->bm_threshold.b_packets);
129 xo_emit("{e:threshold-packets/%ju}",
130 (uintmax_t)bw_meter->bm_threshold.b_packets);
131 } else
132 strcpy(s1, "?");
133 if (bw_meter->bm_flags & BW_METER_UNIT_BYTES) {
134 snprintf(s2, sizeof(s2), "%ju",
135 (uintmax_t)bw_meter->bm_threshold.b_bytes);
136 xo_emit("{e:threshold-bytes/%ju}",
137 (uintmax_t)bw_meter->bm_threshold.b_bytes);
138 } else
139 strcpy(s2, "?");
140
141 xo_emit(" {[:-30}{:threshold-time/%lu.%06lu}|{q:threshold-packets/%s}"
142 "|{q:threshold-bytes%s}{]:}",
143 (u_long)bw_meter->bm_threshold.b_time.tv_sec,
144 (u_long)bw_meter->bm_threshold.b_time.tv_usec, s1, s2);
145
146 /* Remaining time */
147 timeradd(&bw_meter->bm_start_time,
148 &bw_meter->bm_threshold.b_time, &end);
149 if (timercmp(&now, &end, <=)) {
150 timersub(&end, &now, &delta);
151 snprintf(s3, sizeof(s3), "%lu.%06lu",
152 (u_long)delta.tv_sec,
153 (u_long)delta.tv_usec);
154 } else {
155 /* Negative time */
156 timersub(&now, &end, &delta);
157 snprintf(s3, sizeof(s3), "-%lu.06%lu",
158 (u_long)delta.tv_sec,
159 (u_long)delta.tv_usec);
160 }
161 xo_emit(" {:remaining-time/%s}", s3);
162
163 xo_open_instance("bandwidth-meter");
164
165 xo_emit("\n");
166 }
167
168 static void
print_mfc(struct mfc * m,int maxvif,int * banner_printed)169 print_mfc(struct mfc *m, int maxvif, int *banner_printed)
170 {
171 struct sockaddr_in sin;
172 struct sockaddr *sa = (struct sockaddr *)&sin;
173 struct bw_meter bw_meter, *bwm;
174 int bw_banner_printed;
175 int error;
176 vifi_t vifi;
177
178 bw_banner_printed = 0;
179 memset(&sin, 0, sizeof(sin));
180 sin.sin_len = sizeof(sin);
181 sin.sin_family = AF_INET;
182
183 if (! *banner_printed) {
184 xo_open_list("multicast-forwarding-entry");
185 xo_emit("\n{T:IPv4 Multicast Forwarding Table}\n"
186 " {T:Origin} {T:Group} "
187 " {T:Packets In-Vif} {T:Out-Vifs:Ttls}\n");
188 *banner_printed = 1;
189 }
190
191 memcpy(&sin.sin_addr, &m->mfc_origin, sizeof(sin.sin_addr));
192 xo_emit(" {:origin-address/%-15.15s}", routename(sa, numeric_addr));
193 memcpy(&sin.sin_addr, &m->mfc_mcastgrp, sizeof(sin.sin_addr));
194 xo_emit(" {:group-address/%-15.15s}",
195 routename(sa, numeric_addr));
196 xo_emit(" {:sent-packets/%9lu}", m->mfc_pkt_cnt);
197 xo_emit(" {:parent/%3d} ", m->mfc_parent);
198 xo_open_list("vif-ttl");
199 for (vifi = 0; vifi <= maxvif; vifi++) {
200 if (m->mfc_ttls[vifi] > 0) {
201 xo_open_instance("vif-ttl");
202 xo_emit(" {k:vif/%u}:{:ttl/%u}", vifi,
203 m->mfc_ttls[vifi]);
204 xo_close_instance("vif-ttl");
205 }
206 }
207 xo_close_list("vif-ttl");
208 xo_emit("\n");
209
210 /*
211 * XXX We break the rules and try to use KVM to read the
212 * bandwidth meters, they are not retrievable via sysctl yet.
213 */
214 bwm = m->mfc_bw_meter_leq;
215 while (bwm != NULL) {
216 error = kread((u_long)bwm, (char *)&bw_meter,
217 sizeof(bw_meter));
218 if (error)
219 break;
220 print_bw_meter(&bw_meter, &bw_banner_printed);
221 bwm = bw_meter.bm_mfc_next;
222 }
223 bwm = m->mfc_bw_meter_geq;
224 while (bwm != NULL) {
225 error = kread((u_long)bwm, (char *)&bw_meter,
226 sizeof(bw_meter));
227 if (error)
228 break;
229 print_bw_meter(&bw_meter, &bw_banner_printed);
230 bwm = bw_meter.bm_mfc_next;
231 }
232 if (banner_printed)
233 xo_close_list("bandwidth-meter");
234 }
235
236 void
mroutepr(void)237 mroutepr(void)
238 {
239 struct sockaddr_in sin;
240 struct sockaddr *sa = (struct sockaddr *)&sin;
241 struct vif viftable[MAXVIFS];
242 struct vif *v;
243 struct mfc *m;
244 u_long pmfchashtbl, pmfctablesize, pviftbl;
245 int banner_printed;
246 int saved_numeric_addr;
247 size_t len;
248 vifi_t vifi, maxvif;
249
250 saved_numeric_addr = numeric_addr;
251 numeric_addr = 1;
252
253 memset(&sin, 0, sizeof(sin));
254 sin.sin_len = sizeof(sin);
255 sin.sin_family = AF_INET;
256
257 /*
258 * TODO:
259 * The VIF table will move to hanging off the struct if_info for
260 * each IPv4 configured interface. Currently it is statically
261 * allocated, and retrieved either using KVM or an opaque SYSCTL.
262 *
263 * This can't happen until the API documented in multicast(4)
264 * is itself refactored. The historical reason why VIFs use
265 * a separate ifindex space is entirely due to the legacy
266 * capability of the MROUTING code to create IPIP tunnels on
267 * the fly to support DVMRP. When gif(4) became available, this
268 * functionality was deprecated, as PIM does not use it.
269 */
270 maxvif = 0;
271 pmfchashtbl = pmfctablesize = pviftbl = 0;
272
273 len = sizeof(viftable);
274 if (live) {
275 if (sysctlbyname("net.inet.ip.viftable", viftable, &len, NULL,
276 0) < 0) {
277 xo_warn("sysctl: net.inet.ip.viftable");
278 return;
279 }
280 } else {
281 pmfchashtbl = nl[N_MFCHASHTBL].n_value;
282 pmfctablesize = nl[N_MFCTABLESIZE].n_value;
283 pviftbl = nl[N_VIFTABLE].n_value;
284
285 if (pmfchashtbl == 0 || pmfctablesize == 0 || pviftbl == 0) {
286 xo_warnx("No IPv4 MROUTING kernel support.");
287 return;
288 }
289
290 kread(pviftbl, (char *)viftable, sizeof(viftable));
291 }
292
293 banner_printed = 0;
294 for (vifi = 0, v = viftable; vifi < MAXVIFS; ++vifi, ++v) {
295 if (v->v_lcl_addr.s_addr == 0)
296 continue;
297
298 maxvif = vifi;
299 if (!banner_printed) {
300 xo_emit("\n{T:IPv4 Virtual Interface Table\n"
301 " Vif Thresh Local-Address "
302 "Remote-Address Pkts-In Pkts-Out}\n");
303 banner_printed = 1;
304 xo_open_list("vif");
305 }
306
307 xo_open_instance("vif");
308 memcpy(&sin.sin_addr, &v->v_lcl_addr, sizeof(sin.sin_addr));
309 xo_emit(" {:vif/%2u} {:threshold/%6u} {:route/%-15.15s}",
310 /* opposite math of add_vif() */
311 vifi, v->v_threshold,
312 routename(sa, numeric_addr));
313 memcpy(&sin.sin_addr, &v->v_rmt_addr, sizeof(sin.sin_addr));
314 xo_emit(" {:source/%-15.15s}", (v->v_flags & VIFF_TUNNEL) ?
315 routename(sa, numeric_addr) : "");
316
317 xo_emit(" {:received-packets/%9lu} {:sent-packets/%9lu}\n",
318 v->v_pkt_in, v->v_pkt_out);
319 xo_close_instance("vif");
320 }
321 if (banner_printed)
322 xo_close_list("vif");
323 else
324 xo_emit("\n{T:IPv4 Virtual Interface Table is empty}\n");
325
326 banner_printed = 0;
327
328 /*
329 * TODO:
330 * The MFC table will move into the AF_INET radix trie in future.
331 * In 8.x, it becomes a dynamically allocated structure referenced
332 * by a hashed LIST, allowing more than 256 entries w/o kernel tuning.
333 *
334 * If retrieved via opaque SYSCTL, the kernel will coalesce it into
335 * a static table for us.
336 * If retrieved via KVM, the hash list pointers must be followed.
337 */
338 if (live) {
339 struct mfc *mfctable;
340
341 len = 0;
342 if (sysctlbyname("net.inet.ip.mfctable", NULL, &len, NULL,
343 0) < 0) {
344 xo_warn("sysctl: net.inet.ip.mfctable");
345 return;
346 }
347
348 mfctable = malloc(len);
349 if (mfctable == NULL) {
350 xo_warnx("malloc %lu bytes", (u_long)len);
351 return;
352 }
353 if (sysctlbyname("net.inet.ip.mfctable", mfctable, &len, NULL,
354 0) < 0) {
355 free(mfctable);
356 xo_warn("sysctl: net.inet.ip.mfctable");
357 return;
358 }
359
360 m = mfctable;
361 while (len >= sizeof(*m)) {
362 print_mfc(m++, maxvif, &banner_printed);
363 len -= sizeof(*m);
364 }
365 if (banner_printed)
366 xo_close_list("multicast-forwarding-entry");
367 if (len != 0)
368 xo_warnx("print_mfc: %lu trailing bytes", (u_long)len);
369
370 free(mfctable);
371 } else {
372 LIST_HEAD(, mfc) *mfchashtbl;
373 u_long i, mfctablesize;
374 struct mfc mfc;
375 int error;
376
377 error = kread(pmfctablesize, (char *)&mfctablesize,
378 sizeof(u_long));
379 if (error) {
380 xo_warn("kread: mfctablesize");
381 return;
382 }
383
384 len = sizeof(*mfchashtbl) * mfctablesize;
385 mfchashtbl = malloc(len);
386 if (mfchashtbl == NULL) {
387 xo_warnx("malloc %lu bytes", (u_long)len);
388 return;
389 }
390 kread(pmfchashtbl, (char *)&mfchashtbl, len);
391
392 for (i = 0; i < mfctablesize; i++) {
393 LIST_FOREACH(m, &mfchashtbl[i], mfc_hash) {
394 kread((u_long)m, (char *)&mfc, sizeof(mfc));
395 print_mfc(m, maxvif, &banner_printed);
396 }
397 }
398 if (banner_printed)
399 xo_close_list("multicast-forwarding-entry");
400
401 free(mfchashtbl);
402 }
403
404 if (!banner_printed)
405 xo_emit("\n{T:IPv4 Multicast Forwarding Table is empty}\n");
406
407 xo_emit("\n");
408 numeric_addr = saved_numeric_addr;
409 }
410
411 void
mrt_stats(void)412 mrt_stats(void)
413 {
414 struct mrtstat mrtstat;
415 u_long mstaddr;
416
417 mstaddr = nl[N_MRTSTAT].n_value;
418
419 if (fetch_stats("net.inet.ip.mrtstat", mstaddr, &mrtstat,
420 sizeof(mrtstat), kread_counters) != 0) {
421 if ((live && errno == ENOENT) || (!live && mstaddr == 0))
422 fprintf(stderr, "No IPv4 MROUTING kernel support.\n");
423 return;
424 }
425
426 xo_emit("{T:IPv4 multicast forwarding}:\n");
427
428 #define p(f, m) if (mrtstat.f || sflag <= 1) \
429 xo_emit(m, (uintmax_t)mrtstat.f, plural(mrtstat.f))
430 #define p2(f, m) if (mrtstat.f || sflag <= 1) \
431 xo_emit(m, (uintmax_t)mrtstat.f, plurales(mrtstat.f))
432
433 xo_open_container("multicast-statistics");
434
435 p(mrts_mfc_lookups, "\t{:cache-lookups/%ju} "
436 "{N:/multicast forwarding cache lookup%s}\n");
437 p2(mrts_mfc_misses, "\t{:cache-misses/%ju} "
438 "{N:/multicast forwarding cache miss%s}\n");
439 p(mrts_upcalls, "\t{:upcalls-total/%ju} "
440 "{N:/upcall%s to multicast routing daemon}\n");
441 p(mrts_upq_ovflw, "\t{:upcall-overflows/%ju} "
442 "{N:/upcall queue overflow%s}\n");
443 p(mrts_upq_sockfull,
444 "\t{:upcalls-dropped-full-buffer/%ju} "
445 "{N:/upcall%s dropped due to full socket buffer}\n");
446 p(mrts_cache_cleanups, "\t{:cache-cleanups/%ju} "
447 "{N:/cache cleanup%s}\n");
448 p(mrts_no_route, "\t{:dropped-no-origin/%ju} "
449 "{N:/datagram%s with no route for origin}\n");
450 p(mrts_bad_tunnel, "\t{:dropped-bad-tunnel/%ju} "
451 "{N:/datagram%s arrived with bad tunneling}\n");
452 p(mrts_cant_tunnel, "\t{:dropped-could-not-tunnel/%ju} "
453 "{N:/datagram%s could not be tunneled}\n");
454 p(mrts_wrong_if, "\t{:dropped-wrong-incoming-interface/%ju} "
455 "{N:/datagram%s arrived on wrong interface}\n");
456 p(mrts_drop_sel, "\t{:dropped-selectively/%ju} "
457 "{N:/datagram%s selectively dropped}\n");
458 p(mrts_q_overflow, "\t{:dropped-queue-overflow/%ju} "
459 "{N:/datagram%s dropped due to queue overflow}\n");
460 p(mrts_pkt2large, "\t{:dropped-too-large/%ju} "
461 "{N:/datagram%s dropped for being too large}\n");
462
463 #undef p2
464 #undef p
465 }
466