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 __FBSDID("$FreeBSD$");
44
45 /*
46 * Print multicast routing structures and statistics.
47 *
48 * MROUTING 1.0
49 */
50
51 #include <sys/param.h>
52 #include <sys/queue.h>
53 #include <sys/socket.h>
54 #include <sys/socketvar.h>
55 #include <sys/sysctl.h>
56 #include <sys/protosw.h>
57 #include <sys/mbuf.h>
58 #include <sys/time.h>
59
60 #include <net/if.h>
61 #include <netinet/in.h>
62 #include <netinet/igmp.h>
63 #include <net/route.h>
64
65 #define _KERNEL 1
66 #include <netinet/ip_mroute.h>
67 #undef _KERNEL
68
69 #include <err.h>
70 #include <stdint.h>
71 #include <stdio.h>
72 #include <stdlib.h>
73 #include <stdbool.h>
74 #include <string.h>
75 #include <libxo/xo.h>
76 #include "netstat.h"
77 #include "nl_defs.h"
78
79 static void print_bw_meter(struct bw_meter *, int *);
80 static void print_mfc(struct mfc *, int, int *);
81
82 static void
print_bw_meter(struct bw_meter * bw_meter,int * banner_printed)83 print_bw_meter(struct bw_meter *bw_meter, int *banner_printed)
84 {
85 char s1[256], s2[256], s3[256];
86 struct timeval now, end, delta;
87
88 gettimeofday(&now, NULL);
89
90 if (! *banner_printed) {
91 xo_open_list("bandwidth-meter");
92 xo_emit(" {T:Bandwidth Meters}\n");
93 xo_emit(" {T:/%-30s}", "Measured(Start|Packets|Bytes)");
94 xo_emit(" {T:/%s}", "Type");
95 xo_emit(" {T:/%-30s}", "Thresh(Interval|Packets|Bytes)");
96 xo_emit(" {T:Remain}");
97 xo_emit("\n");
98 *banner_printed = 1;
99 }
100
101 xo_open_instance("bandwidth-meter");
102
103 /* The measured values */
104 if (bw_meter->bm_flags & BW_METER_UNIT_PACKETS) {
105 snprintf(s1, sizeof(s1), "%ju",
106 (uintmax_t)bw_meter->bm_measured.b_packets);
107 xo_emit("{e:measured-packets/%ju}",
108 (uintmax_t)bw_meter->bm_measured.b_packets);
109 } else
110 strcpy(s1, "?");
111 if (bw_meter->bm_flags & BW_METER_UNIT_BYTES) {
112 snprintf(s2, sizeof(s2), "%ju",
113 (uintmax_t)bw_meter->bm_measured.b_bytes);
114 xo_emit("{e:measured-bytes/%ju}",
115 (uintmax_t)bw_meter->bm_measured.b_bytes);
116 } else
117 strcpy(s2, "?");
118 xo_emit(" {[:-30}{:start-time/%lu.%06lu}|{q:measured-packets/%s}"
119 "|{q:measured-bytes%s}{]:}",
120 (u_long)bw_meter->bm_start_time.tv_sec,
121 (u_long)bw_meter->bm_start_time.tv_usec, s1, s2);
122
123 /* The type of entry */
124 xo_emit(" {t:type/%-3s}", (bw_meter->bm_flags & BW_METER_GEQ) ? ">=" :
125 (bw_meter->bm_flags & BW_METER_LEQ) ? "<=" : "?");
126
127 /* The threshold values */
128 if (bw_meter->bm_flags & BW_METER_UNIT_PACKETS) {
129 snprintf(s1, sizeof(s1), "%ju",
130 (uintmax_t)bw_meter->bm_threshold.b_packets);
131 xo_emit("{e:threshold-packets/%ju}",
132 (uintmax_t)bw_meter->bm_threshold.b_packets);
133 } else
134 strcpy(s1, "?");
135 if (bw_meter->bm_flags & BW_METER_UNIT_BYTES) {
136 snprintf(s2, sizeof(s2), "%ju",
137 (uintmax_t)bw_meter->bm_threshold.b_bytes);
138 xo_emit("{e:threshold-bytes/%ju}",
139 (uintmax_t)bw_meter->bm_threshold.b_bytes);
140 } else
141 strcpy(s2, "?");
142
143 xo_emit(" {[:-30}{:threshold-time/%lu.%06lu}|{q:threshold-packets/%s}"
144 "|{q:threshold-bytes%s}{]:}",
145 (u_long)bw_meter->bm_threshold.b_time.tv_sec,
146 (u_long)bw_meter->bm_threshold.b_time.tv_usec, s1, s2);
147
148 /* Remaining time */
149 timeradd(&bw_meter->bm_start_time,
150 &bw_meter->bm_threshold.b_time, &end);
151 if (timercmp(&now, &end, <=)) {
152 timersub(&end, &now, &delta);
153 snprintf(s3, sizeof(s3), "%lu.%06lu",
154 (u_long)delta.tv_sec,
155 (u_long)delta.tv_usec);
156 } else {
157 /* Negative time */
158 timersub(&now, &end, &delta);
159 snprintf(s3, sizeof(s3), "-%lu.06%lu",
160 (u_long)delta.tv_sec,
161 (u_long)delta.tv_usec);
162 }
163 xo_emit(" {:remaining-time/%s}", s3);
164
165 xo_open_instance("bandwidth-meter");
166
167 xo_emit("\n");
168 }
169
170 static void
print_mfc(struct mfc * m,int maxvif,int * banner_printed)171 print_mfc(struct mfc *m, int maxvif, int *banner_printed)
172 {
173 struct sockaddr_in sin;
174 struct sockaddr *sa = (struct sockaddr *)&sin;
175 struct bw_meter bw_meter, *bwm;
176 int bw_banner_printed;
177 int error;
178 vifi_t vifi;
179
180 bw_banner_printed = 0;
181 memset(&sin, 0, sizeof(sin));
182 sin.sin_len = sizeof(sin);
183 sin.sin_family = AF_INET;
184
185 if (! *banner_printed) {
186 xo_open_list("multicast-forwarding-entry");
187 xo_emit("\n{T:IPv4 Multicast Forwarding Table}\n"
188 " {T:Origin} {T:Group} "
189 " {T:Packets In-Vif} {T:Out-Vifs:Ttls}\n");
190 *banner_printed = 1;
191 }
192
193 memcpy(&sin.sin_addr, &m->mfc_origin, sizeof(sin.sin_addr));
194 xo_emit(" {:origin-address/%-15.15s}", routename(sa, numeric_addr));
195 memcpy(&sin.sin_addr, &m->mfc_mcastgrp, sizeof(sin.sin_addr));
196 xo_emit(" {:group-address/%-15.15s}",
197 routename(sa, numeric_addr));
198 xo_emit(" {:sent-packets/%9lu}", m->mfc_pkt_cnt);
199 xo_emit(" {:parent/%3d} ", m->mfc_parent);
200 xo_open_list("vif-ttl");
201 for (vifi = 0; vifi <= maxvif; vifi++) {
202 if (m->mfc_ttls[vifi] > 0) {
203 xo_open_instance("vif-ttl");
204 xo_emit(" {k:vif/%u}:{:ttl/%u}", vifi,
205 m->mfc_ttls[vifi]);
206 xo_close_instance("vif-ttl");
207 }
208 }
209 xo_close_list("vif-ttl");
210 xo_emit("\n");
211
212 /*
213 * XXX We break the rules and try to use KVM to read the
214 * bandwidth meters, they are not retrievable via sysctl yet.
215 */
216 bwm = m->mfc_bw_meter;
217 while (bwm != NULL) {
218 error = kread((u_long)bwm, (char *)&bw_meter,
219 sizeof(bw_meter));
220 if (error)
221 break;
222 print_bw_meter(&bw_meter, &bw_banner_printed);
223 bwm = bw_meter.bm_mfc_next;
224 }
225 if (banner_printed)
226 xo_close_list("bandwidth-meter");
227 }
228
229 void
mroutepr()230 mroutepr()
231 {
232 struct sockaddr_in sin;
233 struct sockaddr *sa = (struct sockaddr *)&sin;
234 struct vif viftable[MAXVIFS];
235 struct vif *v;
236 struct mfc *m;
237 #ifndef FSTACK
238 u_long pmfchashtbl, pmfctablesize, pviftbl;
239 #endif
240 int banner_printed;
241 int saved_numeric_addr;
242 size_t len;
243 vifi_t vifi, maxvif;
244
245 saved_numeric_addr = numeric_addr;
246 numeric_addr = 1;
247
248 memset(&sin, 0, sizeof(sin));
249 sin.sin_len = sizeof(sin);
250 sin.sin_family = AF_INET;
251
252 /*
253 * TODO:
254 * The VIF table will move to hanging off the struct if_info for
255 * each IPv4 configured interface. Currently it is statically
256 * allocated, and retrieved either using KVM or an opaque SYSCTL.
257 *
258 * This can't happen until the API documented in multicast(4)
259 * is itself refactored. The historical reason why VIFs use
260 * a separate ifindex space is entirely due to the legacy
261 * capability of the MROUTING code to create IPIP tunnels on
262 * the fly to support DVMRP. When gif(4) became available, this
263 * functionality was deprecated, as PIM does not use it.
264 */
265 maxvif = 0;
266 #ifndef FSTACK
267 pmfchashtbl = pmfctablesize = pviftbl = 0;
268 #endif
269
270 len = sizeof(viftable);
271 if (live) {
272 if (sysctlbyname("net.inet.ip.viftable", viftable, &len, NULL,
273 0) < 0) {
274 xo_warn("sysctl: net.inet.ip.viftable");
275 return;
276 }
277 } else {
278 #ifndef FSTACK
279 pmfchashtbl = nl[N_MFCHASHTBL].n_value;
280 pmfctablesize = nl[N_MFCTABLESIZE].n_value;
281 pviftbl = nl[N_VIFTABLE].n_value;
282
283 if (pmfchashtbl == 0 || pmfctablesize == 0 || pviftbl == 0) {
284 xo_warnx("No IPv4 MROUTING kernel support.");
285 return;
286 }
287
288 kread(pviftbl, (char *)viftable, sizeof(viftable));
289 #endif
290 }
291
292 banner_printed = 0;
293 for (vifi = 0, v = viftable; vifi < MAXVIFS; ++vifi, ++v) {
294 if (v->v_lcl_addr.s_addr == 0)
295 continue;
296
297 maxvif = vifi;
298 if (!banner_printed) {
299 xo_emit("\n{T:IPv4 Virtual Interface Table\n"
300 " Vif Thresh Local-Address "
301 "Remote-Address Pkts-In Pkts-Out}\n");
302 banner_printed = 1;
303 xo_open_list("vif");
304 }
305
306 xo_open_instance("vif");
307 memcpy(&sin.sin_addr, &v->v_lcl_addr, sizeof(sin.sin_addr));
308 xo_emit(" {:vif/%2u} {:threshold/%6u} {:route/%-15.15s}",
309 /* opposite math of add_vif() */
310 vifi, v->v_threshold,
311 routename(sa, numeric_addr));
312 memcpy(&sin.sin_addr, &v->v_rmt_addr, sizeof(sin.sin_addr));
313 xo_emit(" {:source/%-15.15s}", (v->v_flags & VIFF_TUNNEL) ?
314 routename(sa, numeric_addr) : "");
315
316 xo_emit(" {:received-packets/%9lu} {:sent-packets/%9lu}\n",
317 v->v_pkt_in, v->v_pkt_out);
318 xo_close_instance("vif");
319 }
320 if (banner_printed)
321 xo_close_list("vif");
322 else
323 xo_emit("\n{T:IPv4 Virtual Interface Table is empty}\n");
324
325 banner_printed = 0;
326
327 /*
328 * TODO:
329 * The MFC table will move into the AF_INET radix trie in future.
330 * In 8.x, it becomes a dynamically allocated structure referenced
331 * by a hashed LIST, allowing more than 256 entries w/o kernel tuning.
332 *
333 * If retrieved via opaque SYSCTL, the kernel will coalesce it into
334 * a static table for us.
335 * If retrieved via KVM, the hash list pointers must be followed.
336 */
337 if (live) {
338 struct mfc *mfctable;
339
340 len = 0;
341 if (sysctlbyname("net.inet.ip.mfctable", NULL, &len, NULL,
342 0) < 0) {
343 xo_warn("sysctl: net.inet.ip.mfctable");
344 return;
345 }
346
347 mfctable = malloc(len);
348 if (mfctable == NULL) {
349 xo_warnx("malloc %lu bytes", (u_long)len);
350 return;
351 }
352 if (sysctlbyname("net.inet.ip.mfctable", mfctable, &len, NULL,
353 0) < 0) {
354 free(mfctable);
355 xo_warn("sysctl: net.inet.ip.mfctable");
356 return;
357 }
358
359 m = mfctable;
360 while (len >= sizeof(*m)) {
361 print_mfc(m++, maxvif, &banner_printed);
362 len -= sizeof(*m);
363 }
364 if (banner_printed)
365 xo_close_list("multicast-forwarding-entry");
366 if (len != 0)
367 xo_warnx("print_mfc: %lu trailing bytes", (u_long)len);
368
369 free(mfctable);
370 } else {
371 #ifndef FSTACK
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 #endif
403 }
404
405 if (!banner_printed)
406 xo_emit("\n{T:IPv4 Multicast Forwarding Table is empty}\n");
407
408 xo_emit("\n");
409 numeric_addr = saved_numeric_addr;
410 }
411
412 void
mrt_stats()413 mrt_stats()
414 {
415 struct mrtstat mrtstat;
416 u_long mstaddr;
417
418 mstaddr = nl[N_MRTSTAT].n_value;
419
420 if (fetch_stats("net.inet.ip.mrtstat", mstaddr, &mrtstat,
421 sizeof(mrtstat), kread_counters) != 0) {
422 if ((live && errno == ENOENT) || (!live && mstaddr == 0))
423 fprintf(stderr, "No IPv4 MROUTING kernel support.\n");
424 return;
425 }
426
427 xo_emit("{T:IPv4 multicast forwarding}:\n");
428
429 #define p(f, m) if (mrtstat.f || sflag <= 1) \
430 xo_emit(m, (uintmax_t)mrtstat.f, plural(mrtstat.f))
431 #define p2(f, m) if (mrtstat.f || sflag <= 1) \
432 xo_emit(m, (uintmax_t)mrtstat.f, plurales(mrtstat.f))
433
434 xo_open_container("multicast-statistics");
435
436 p(mrts_mfc_lookups, "\t{:cache-lookups/%ju} "
437 "{N:/multicast forwarding cache lookup%s}\n");
438 p2(mrts_mfc_misses, "\t{:cache-misses/%ju} "
439 "{N:/multicast forwarding cache miss%s}\n");
440 p(mrts_upcalls, "\t{:upcalls-total/%ju} "
441 "{N:/upcall%s to multicast routing daemon}\n");
442 p(mrts_upq_ovflw, "\t{:upcall-overflows/%ju} "
443 "{N:/upcall queue overflow%s}\n");
444 p(mrts_upq_sockfull,
445 "\t{:upcalls-dropped-full-buffer/%ju} "
446 "{N:/upcall%s dropped due to full socket buffer}\n");
447 p(mrts_cache_cleanups, "\t{:cache-cleanups/%ju} "
448 "{N:/cache cleanup%s}\n");
449 p(mrts_no_route, "\t{:dropped-no-origin/%ju} "
450 "{N:/datagram%s with no route for origin}\n");
451 p(mrts_bad_tunnel, "\t{:dropped-bad-tunnel/%ju} "
452 "{N:/datagram%s arrived with bad tunneling}\n");
453 p(mrts_cant_tunnel, "\t{:dropped-could-not-tunnel/%ju} "
454 "{N:/datagram%s could not be tunneled}\n");
455 p(mrts_wrong_if, "\t{:dropped-wrong-incoming-interface/%ju} "
456 "{N:/datagram%s arrived on wrong interface}\n");
457 p(mrts_drop_sel, "\t{:dropped-selectively/%ju} "
458 "{N:/datagram%s selectively dropped}\n");
459 p(mrts_q_overflow, "\t{:dropped-queue-overflow/%ju} "
460 "{N:/datagram%s dropped due to queue overflow}\n");
461 p(mrts_pkt2large, "\t{:dropped-too-large/%ju} "
462 "{N:/datagram%s dropped for being too large}\n");
463
464 #undef p2
465 #undef p
466 }
467