usr.bin/netstat/mroute.c

   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
  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
 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
 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         u_long pmfchashtbl, pmfctablesize, pviftbl;
 238         int banner_printed;
 239         int saved_numeric_addr;
 240         size_t len;
 241         vifi_t vifi, maxvif;
 242
 243         saved_numeric_addr = numeric_addr;
 244         numeric_addr = 1;
 245
 246         memset(&sin, 0, sizeof(sin));
 247         sin.sin_len = sizeof(sin);
 248         sin.sin_family = AF_INET;
 249
 250         /*
 251          * TODO:
 252          * The VIF table will move to hanging off the struct if_info for
 253          * each IPv4 configured interface. Currently it is statically
 254          * allocated, and retrieved either using KVM or an opaque SYSCTL.
 255          *
 256          * This can't happen until the API documented in multicast(4)
 257          * is itself refactored. The historical reason why VIFs use
 258          * a separate ifindex space is entirely due to the legacy
 259          * capability of the MROUTING code to create IPIP tunnels on
 260          * the fly to support DVMRP. When gif(4) became available, this
 261          * functionality was deprecated, as PIM does not use it.
 262          */
 263         maxvif = 0;
 264         pmfchashtbl = pmfctablesize = pviftbl = 0;
 265
 266         len = sizeof(viftable);
 267         if (live) {
 268                 if (sysctlbyname("net.inet.ip.viftable", viftable, &len, NULL,
 269                     0) < 0) {
 270                         xo_warn("sysctl: net.inet.ip.viftable");
 271                         return;
 272                 }
 273         } else {
 274                 pmfchashtbl = nl[N_MFCHASHTBL].n_value;
 275                 pmfctablesize = nl[N_MFCTABLESIZE].n_value;
 276                 pviftbl = nl[N_VIFTABLE].n_value;
 277
 278                 if (pmfchashtbl == 0 || pmfctablesize == 0 || pviftbl == 0) {
 279                         xo_warnx("No IPv4 MROUTING kernel support.");
 280                         return;
 281                 }
 282
 283                 kread(pviftbl, (char *)viftable, sizeof(viftable));
 284         }
 285
 286         banner_printed = 0;
 287         for (vifi = 0, v = viftable; vifi < MAXVIFS; ++vifi, ++v) {
 288                 if (v->v_lcl_addr.s_addr == 0)
 289                         continue;
 290
 291                 maxvif = vifi;
 292                 if (!banner_printed) {
 293                         xo_emit("\n{T:IPv4 Virtual Interface Table\n"
 294                             " Vif   Thresh   Local-Address   "
 295                             "Remote-Address    Pkts-In   Pkts-Out}\n");
 296                         banner_printed = 1;
 297                         xo_open_list("vif");
 298                 }
 299
 300                 xo_open_instance("vif");
 301                 memcpy(&sin.sin_addr, &v->v_lcl_addr, sizeof(sin.sin_addr));
 302                 xo_emit(" {:vif/%2u}    {:threshold/%6u}   {:route/%-15.15s}",
 303                                         /* opposite math of add_vif() */
 304                     vifi, v->v_threshold,
 305                     routename(sa, numeric_addr));
 306                 memcpy(&sin.sin_addr, &v->v_rmt_addr, sizeof(sin.sin_addr));
 307                 xo_emit(" {:source/%-15.15s}", (v->v_flags & VIFF_TUNNEL) ?
 308                     routename(sa, numeric_addr) : "");
 309
 310                 xo_emit(" {:received-packets/%9lu}  {:sent-packets/%9lu}\n",
 311                     v->v_pkt_in, v->v_pkt_out);
 312                 xo_close_instance("vif");
 313         }
 314         if (banner_printed)
 315                 xo_close_list("vif");
 316         else
 317                 xo_emit("\n{T:IPv4 Virtual Interface Table is empty}\n");
 318
 319         banner_printed = 0;
 320
 321         /*
 322          * TODO:
 323          * The MFC table will move into the AF_INET radix trie in future.
 324          * In 8.x, it becomes a dynamically allocated structure referenced
 325          * by a hashed LIST, allowing more than 256 entries w/o kernel tuning.
 326          *
 327          * If retrieved via opaque SYSCTL, the kernel will coalesce it into
 328          * a static table for us.
 329          * If retrieved via KVM, the hash list pointers must be followed.
 330          */
 331         if (live) {
 332                 struct mfc *mfctable;
 333
 334                 len = 0;
 335                 if (sysctlbyname("net.inet.ip.mfctable", NULL, &len, NULL,
 336                     0) < 0) {
 337                         xo_warn("sysctl: net.inet.ip.mfctable");
 338                         return;
 339                 }
 340
 341                 mfctable = malloc(len);
 342                 if (mfctable == NULL) {
 343                         xo_warnx("malloc %lu bytes", (u_long)len);
 344                         return;
 345                 }
 346                 if (sysctlbyname("net.inet.ip.mfctable", mfctable, &len, NULL,
 347                     0) < 0) {
 348                         free(mfctable);
 349                         xo_warn("sysctl: net.inet.ip.mfctable");
 350                         return;
 351                 }
 352
 353                 m = mfctable;
 354                 while (len >= sizeof(*m)) {
 355                         print_mfc(m++, maxvif, &banner_printed);
 356                         len -= sizeof(*m);
 357                 }
 358                 if (banner_printed)
 359                         xo_close_list("multicast-forwarding-entry");
 360                 if (len != 0)
 361                         xo_warnx("print_mfc: %lu trailing bytes", (u_long)len);
 362
 363                 free(mfctable);
 364         } else {
 365                 LIST_HEAD(, mfc) *mfchashtbl;
 366                 u_long i, mfctablesize;
 367                 struct mfc mfc;
 368                 int error;
 369
 370                 error = kread(pmfctablesize, (char *)&mfctablesize,
 371                     sizeof(u_long));
 372                 if (error) {
 373                         xo_warn("kread: mfctablesize");
 374                         return;
 375                 }
 376
 377                 len = sizeof(*mfchashtbl) * mfctablesize;
 378                 mfchashtbl = malloc(len);
 379                 if (mfchashtbl == NULL) {
 380                         xo_warnx("malloc %lu bytes", (u_long)len);
 381                         return;
 382                 }
 383                 kread(pmfchashtbl, (char *)&mfchashtbl, len);
 384
 385                 for (i = 0; i < mfctablesize; i++) {
 386                         LIST_FOREACH(m, &mfchashtbl[i], mfc_hash) {
 387                                 kread((u_long)m, (char *)&mfc, sizeof(mfc));
 388                                 print_mfc(m, maxvif, &banner_printed);
 389                         }
 390                 }
 391                 if (banner_printed)
 392                         xo_close_list("multicast-forwarding-entry");
 393
 394                 free(mfchashtbl);
 395         }
 396
 397         if (!banner_printed)
 398                 xo_emit("\n{T:IPv4 Multicast Forwarding Table is empty}\n");
 399
 400         xo_emit("\n");
 401         numeric_addr = saved_numeric_addr;
 402 }
 403
 404 void
 405 mrt_stats()
 406 {
 407         struct mrtstat mrtstat;
 408         u_long mstaddr;
 409
 410         mstaddr = nl[N_MRTSTAT].n_value;
 411
 412         if (mstaddr == 0) {
 413                 fprintf(stderr, "No IPv4 MROUTING kernel support.\n");
 414                 return;
 415         }
 416
 417         if (fetch_stats("net.inet.ip.mrtstat", mstaddr, &mrtstat,
 418             sizeof(mrtstat), kread_counters) != 0)
 419                 return;
 420
 421         xo_emit("{T:IPv4 multicast forwarding}:\n");
 422
 423 #define p(f, m) if (mrtstat.f || sflag <= 1) \
 424         xo_emit(m, (uintmax_t)mrtstat.f, plural(mrtstat.f))
 425 #define p2(f, m) if (mrtstat.f || sflag <= 1) \
 426         xo_emit(m, (uintmax_t)mrtstat.f, plurales(mrtstat.f))
 427
 428         xo_open_container("multicast-statistics");
 429
 430         p(mrts_mfc_lookups, "\t{:cache-lookups/%ju} "
 431             "{N:/multicast forwarding cache lookup%s}\n");
 432         p2(mrts_mfc_misses, "\t{:cache-misses/%ju} "
 433             "{N:/multicast forwarding cache miss%s}\n");
 434         p(mrts_upcalls, "\t{:upcalls-total/%ju} "
 435             "{N:/upcall%s to multicast routing daemon}\n");
 436         p(mrts_upq_ovflw, "\t{:upcall-overflows/%ju} "
 437             "{N:/upcall queue overflow%s}\n");
 438         p(mrts_upq_sockfull,
 439             "\t{:upcalls-dropped-full-buffer/%ju} "
 440             "{N:/upcall%s dropped due to full socket buffer}\n");
 441         p(mrts_cache_cleanups, "\t{:cache-cleanups/%ju} "
 442             "{N:/cache cleanup%s}\n");
 443         p(mrts_no_route, "\t{:dropped-no-origin/%ju} "
 444             "{N:/datagram%s with no route for origin}\n");
 445         p(mrts_bad_tunnel, "\t{:dropped-bad-tunnel/%ju} "
 446             "{N:/datagram%s arrived with bad tunneling}\n");
 447         p(mrts_cant_tunnel, "\t{:dropped-could-not-tunnel/%ju} "
 448             "{N:/datagram%s could not be tunneled}\n");
 449         p(mrts_wrong_if, "\t{:dropped-wrong-incoming-interface/%ju} "
 450             "{N:/datagram%s arrived on wrong interface}\n");
 451         p(mrts_drop_sel, "\t{:dropped-selectively/%ju} "
 452             "{N:/datagram%s selectively dropped}\n");
 453         p(mrts_q_overflow, "\t{:dropped-queue-overflow/%ju} "
 454             "{N:/datagram%s dropped due to queue overflow}\n");
 455         p(mrts_pkt2large, "\t{:dropped-too-large/%ju} "
 456             "{N:/datagram%s dropped for being too large}\n");
 457
 458 #undef  p2
 459 #undef  p
 460 }