usr.bin/netstat/mroute.c

   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$");
  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
  70 static void print_bw_meter(struct bw_meter *bw_meter, int *banner_printed);
  71
  72 void
  73 mroutepr(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                 if (mfcaddr == 0) {
  90                         printf("No IPv4 multicast forwarding configured in "
  91                             "the running system.\n");
  92                         return;
  93                 }
  94                 /*
  95                  * XXX: Try KVM if the module is neither compiled nor loaded.
  96                  * The correct behaviour would be to always use KVM if
  97                  * the -M option is specified to netstat(1).
  98                  */
  99                 kread(mfcaddr, (char *)mfctable, sizeof(mfctable));
 100         }
 101
 102         len = sizeof(viftable);
 103         if (sysctlbyname("net.inet.ip.viftable", viftable, &len, NULL, 0) < 0) {
 104                 warn("sysctl: net.inet.ip.viftable");
 105                 if (vifaddr == 0) {
 106                         printf("No IPv4 multicast forwarding configured in "
 107                             "the running system.\n");
 108                         return;
 109                 }
 110                 /* XXX KVM */
 111                 kread(vifaddr, (char *)viftable, sizeof(viftable));
 112         }
 113
 114         saved_numeric_addr = numeric_addr;
 115         numeric_addr = 1;
 116
 117         banner_printed = 0;
 118         for (vifi = 0, v = viftable; vifi < MAXVIFS; ++vifi, ++v) {
 119                 if (v->v_lcl_addr.s_addr == 0)
 120                         continue;
 121
 122                 maxvif = vifi;
 123                 if (!banner_printed) {
 124                         printf("\nIPv4 Virtual Interface Table\n"
 125                                " Vif   Thresh   Rate   Local-Address   "
 126                                "Remote-Address    Pkts-In   Pkts-Out\n");
 127                         banner_printed = 1;
 128                 }
 129
 130                 printf(" %2u    %6u   %4d   %-15.15s",
 131                                         /* opposite math of add_vif() */
 132                     vifi, v->v_threshold, v->v_rate_limit * 1000 / 1024,
 133                     routename(v->v_lcl_addr.s_addr));
 134                 printf(" %-15.15s", (v->v_flags & VIFF_TUNNEL) ?
 135                     routename(v->v_rmt_addr.s_addr) : "");
 136
 137                 printf(" %9lu  %9lu\n", v->v_pkt_in, v->v_pkt_out);
 138         }
 139         if (!banner_printed)
 140                 printf("\nIPv4 Virtual Interface Table is empty\n");
 141
 142         banner_printed = 0;
 143         for (i = 0; i < MFCTBLSIZ; ++i) {
 144                 m = mfctable[i];
 145                 while(m) {
 146                         /* XXX KVM */
 147                         kread((u_long)m, (char *)&mfc, sizeof mfc);
 148
 149                         if (!banner_printed) {
 150                                 printf("\nIPv4 Multicast Forwarding Table\n"
 151                                        " Origin          Group            "
 152                                        " Packets In-Vif  Out-Vifs:Ttls\n");
 153                                 banner_printed = 1;
 154                         }
 155
 156                         printf(" %-15.15s", routename(mfc.mfc_origin.s_addr));
 157                         printf(" %-15.15s", routename(mfc.mfc_mcastgrp.s_addr));
 158                         printf(" %9lu", mfc.mfc_pkt_cnt);
 159                         printf("  %3d   ", mfc.mfc_parent);
 160                         for (vifi = 0; vifi <= maxvif; vifi++) {
 161                                 if (mfc.mfc_ttls[vifi] > 0)
 162                                         printf(" %u:%u", vifi,
 163                                                mfc.mfc_ttls[vifi]);
 164                         }
 165                         printf("\n");
 166
 167                         /* Print the bw meter information */
 168                         {
 169                                 struct bw_meter bw_meter, *bwm;
 170                                 int banner_printed2 = 0;
 171
 172                                 bwm = mfc.mfc_bw_meter;
 173                                 while (bwm) {
 174                                     /* XXX KVM */
 175                                     kread((u_long)bwm, (char *)&bw_meter,
 176                                                 sizeof bw_meter);
 177                                     print_bw_meter(&bw_meter,
 178                                                 &banner_printed2);
 179                                     bwm = bw_meter.bm_mfc_next;
 180                                 }
 181 #if 0   /* Don't ever print it? */
 182                                 if (! banner_printed2)
 183                                     printf("\n  No Bandwidth Meters\n");
 184 #endif
 185                         }
 186
 187                         m = mfc.mfc_next;
 188                 }
 189         }
 190         if (!banner_printed)
 191                 printf("\nIPv4 Multicast Forwarding Table is empty\n");
 192
 193         printf("\n");
 194         numeric_addr = saved_numeric_addr;
 195 }
 196
 197 static void
 198 print_bw_meter(struct bw_meter *bw_meter, int *banner_printed)
 199 {
 200         char s0[256], s1[256], s2[256], s3[256];
 201         struct timeval now, end, delta;
 202
 203         gettimeofday(&now, NULL);
 204
 205         if (! *banner_printed) {
 206                 printf(" Bandwidth Meters\n");
 207                 printf("  %-30s", "Measured(Start|Packets|Bytes)");
 208                 printf(" %s", "Type");
 209                 printf("  %-30s", "Thresh(Interval|Packets|Bytes)");
 210                 printf(" Remain");
 211                 printf("\n");
 212                 *banner_printed = 1;
 213         }
 214
 215         /* The measured values */
 216         if (bw_meter->bm_flags & BW_METER_UNIT_PACKETS)
 217                 sprintf(s1, "%ju", (uintmax_t)bw_meter->bm_measured.b_packets);
 218         else
 219                 sprintf(s1, "?");
 220         if (bw_meter->bm_flags & BW_METER_UNIT_BYTES)
 221                 sprintf(s2, "%ju", (uintmax_t)bw_meter->bm_measured.b_bytes);
 222         else
 223                 sprintf(s2, "?");
 224         sprintf(s0, "%lu.%lu|%s|%s",
 225                 (u_long)bw_meter->bm_start_time.tv_sec,
 226                 (u_long)bw_meter->bm_start_time.tv_usec,
 227                 s1, s2);
 228         printf("  %-30s", s0);
 229
 230         /* The type of entry */
 231         sprintf(s0, "%s", "?");
 232         if (bw_meter->bm_flags & BW_METER_GEQ)
 233                 sprintf(s0, "%s", ">=");
 234         else if (bw_meter->bm_flags & BW_METER_LEQ)
 235                 sprintf(s0, "%s", "<=");
 236         printf("  %-3s", s0);
 237
 238         /* The threshold values */
 239         if (bw_meter->bm_flags & BW_METER_UNIT_PACKETS)
 240                 sprintf(s1, "%ju", (uintmax_t)bw_meter->bm_threshold.b_packets);
 241         else
 242                 sprintf(s1, "?");
 243         if (bw_meter->bm_flags & BW_METER_UNIT_BYTES)
 244                 sprintf(s2, "%ju", (uintmax_t)bw_meter->bm_threshold.b_bytes);
 245         else
 246                 sprintf(s2, "?");
 247         sprintf(s0, "%lu.%lu|%s|%s",
 248                 (u_long)bw_meter->bm_threshold.b_time.tv_sec,
 249                 (u_long)bw_meter->bm_threshold.b_time.tv_usec,
 250                 s1, s2);
 251         printf("  %-30s", s0);
 252
 253         /* Remaining time */
 254         timeradd(&bw_meter->bm_start_time,
 255                  &bw_meter->bm_threshold.b_time, &end);
 256         if (timercmp(&now, &end, <=)) {
 257                 timersub(&end, &now, &delta);
 258                 sprintf(s3, "%lu.%lu",
 259                         (u_long)delta.tv_sec,
 260                         (u_long)delta.tv_usec);
 261         } else {
 262                 /* Negative time */
 263                 timersub(&now, &end, &delta);
 264                 sprintf(s3, "-%lu.%lu",
 265                         (u_long)delta.tv_sec,
 266                         (u_long)delta.tv_usec);
 267         }
 268         printf(" %s", s3);
 269
 270         printf("\n");
 271 }
 272
 273 void
 274 mrt_stats(u_long mstaddr)
 275 {
 276         struct mrtstat mrtstat;
 277         size_t len = sizeof mrtstat;
 278
 279         if (sysctlbyname("net.inet.ip.mrtstat", &mrtstat, &len,
 280                                 NULL, 0) < 0) {
 281                 warn("sysctl: net.inet.ip.mrtstat");
 282                 /* Compatability with older kernels - candidate for removal */
 283                 if (mstaddr == 0) {
 284                         printf("No IPv4 multicast forwarding configured in "
 285                             "the running system.\n");
 286                         return;
 287                 }
 288                 /* XXX KVM */
 289                 kread(mstaddr, (char *)&mrtstat, sizeof(mrtstat));
 290         }
 291         printf("IPv4 multicast forwarding:\n");
 292
 293 #define p(f, m) if (mrtstat.f || sflag <= 1) \
 294         printf(m, mrtstat.f, plural(mrtstat.f))
 295 #define p2(f, m) if (mrtstat.f || sflag <= 1) \
 296         printf(m, mrtstat.f, plurales(mrtstat.f))
 297
 298         p(mrts_mfc_lookups, "\t%lu multicast forwarding cache lookup%s\n");
 299         p2(mrts_mfc_misses, "\t%lu multicast forwarding cache miss%s\n");
 300         p(mrts_upcalls, "\t%lu upcall%s to multicast routing daemon\n");
 301         p(mrts_upq_ovflw, "\t%lu upcall queue overflow%s\n");
 302         p(mrts_upq_sockfull,
 303             "\t%lu upcall%s dropped due to full socket buffer\n");
 304         p(mrts_cache_cleanups, "\t%lu cache cleanup%s\n");
 305         p(mrts_no_route, "\t%lu datagram%s with no route for origin\n");
 306         p(mrts_bad_tunnel, "\t%lu datagram%s arrived with bad tunneling\n");
 307         p(mrts_cant_tunnel, "\t%lu datagram%s could not be tunneled\n");
 308         p(mrts_wrong_if, "\t%lu datagram%s arrived on wrong interface\n");
 309         p(mrts_drop_sel, "\t%lu datagram%s selectively dropped\n");
 310         p(mrts_q_overflow, "\t%lu datagram%s dropped due to queue overflow\n");
 311         p(mrts_pkt2large, "\t%lu datagram%s dropped for being too large\n");
 312
 313 #undef  p2
 314 #undef  p
 315 }