usr.bin/systat/ifstat.c

   1 /*
   2  * Copyright (c) 2003, Trent Nelson, <trent@arpa.com>.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTIFSTAT_ERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD: src/usr.bin/systat/ifstat.c,v 1.1 2003/01/04 22:07:24 phk Exp $
  29  * $DragonFly: src/usr.bin/systat/ifstat.c,v 1.1 2003/11/08 09:30:32 asmodai Exp $
  30  */
  31
  32 #include <sys/types.h>
  33 #include <sys/socket.h>
  34 #include <sys/sysctl.h>
  35 #include <sys/time.h>
  36 #include <sys/queue.h>
  37 #include <net/if.h>
  38 #include <net/if_mib.h>
  39 #include <net/if_types.h>       /* For IFT_ETHER */
  40
  41 #include <stdio.h>
  42 #include <stdlib.h>
  43 #include <unistd.h>
  44 #include <float.h>
  45 #include <err.h>
  46
  47 #include "systat.h"
  48 #include "extern.h"
  49 #include "mode.h"
  50 #include "convtbl.h"
  51
  52                                 /* Column numbers */
  53
  54 #define C1      0               /*  0-19 */
  55 #define C2      20              /* 20-39 */
  56 #define C3      40              /* 40-59 */
  57 #define C4      60              /* 60-80 */
  58 #define C5      80              /* Used for label positioning. */
  59
  60 static  int col0 = 0;
  61 static  int col1 = C1;
  62 static  int col2 = C2;
  63 static  int col3 = C3;
  64 static  int col4 = C4;
  65 static  int col5 = C5;
  66
  67
  68 SLIST_HEAD(, if_stat)           curlist;
  69 SLIST_HEAD(, if_stat_disp)      displist;
  70
  71 struct if_stat {
  72         SLIST_ENTRY(if_stat)     link;
  73         char    if_name[IF_NAMESIZE];
  74         struct  ifmibdata if_mib;
  75         struct  timeval tv;
  76         struct  timeval tv_lastchanged;
  77         u_long  if_in_curtraffic;
  78         u_long  if_out_curtraffic;
  79         u_long  if_in_traffic_peak;
  80         u_long  if_out_traffic_peak;
  81         u_int   if_row;                 /* Index into ifmib sysctl */
  82         u_int   if_ypos;                /* 0 if not being displayed */
  83         u_int   display;
  84 };
  85
  86 extern   u_int curscale;
  87
  88 static   void  right_align_string(const struct if_stat *);
  89 static   void  getifmibdata(const int, struct ifmibdata *);
  90 static   void  sort_interface_list(void);
  91 static   u_int getifnum(void);
  92
  93 #define IFSTAT_ERR(n, s)        do {                                    \
  94         putchar('\f');                                                   \
  95         closeifstat(wnd);                                               \
  96         err((n), (s));                                                  \
  97 } while (0)
  98
  99 #define STARTING_ROW    (8)
 100 #define ROW_SPACING     (3)
 101
 102 #define TOPLINE 5
 103 #define TOPLABEL \
 104 "      Interface           Traffic               Peak                Total"
 105
 106 #define CLEAR_LINE(y, x)        do {                                    \
 107         wmove(wnd, y, x);                                               \
 108         wclrtoeol(wnd);                                                 \
 109 } while (0)
 110
 111 #define IN_col2         (ifp->if_in_curtraffic)
 112 #define OUT_col2        (ifp->if_out_curtraffic)
 113 #define IN_col3         (ifp->if_in_traffic_peak)
 114 #define OUT_col3        (ifp->if_out_traffic_peak)
 115 #define IN_col4         (ifp->if_mib.ifmd_data.ifi_ibytes)
 116 #define OUT_col4        (ifp->if_mib.ifmd_data.ifi_obytes)
 117
 118 #define EMPTY_COLUMN    "                    "
 119 #define CLEAR_COLUMN(y, x)      mvprintw((y), (x), "%20s", EMPTY_COLUMN);
 120
 121 #define DOPUTRATE(c, r, d)      do {                                    \
 122         CLEAR_COLUMN(r, c);                                             \
 123         mvprintw(r, (c), "%10.3f %s%s  ",                               \
 124                  convert(d##_##c, curscale),                            \
 125                  get_string(d##_##c, curscale),                         \
 126                  "/s");                                                 \
 127 } while (0)
 128
 129 #define DOPUTTOTAL(c, r, d)     do {                                    \
 130         CLEAR_COLUMN((r), (c));                                         \
 131         mvprintw((r), (c), "%12.3f %s  ",                               \
 132                  convert(d##_##c, SC_AUTO),                             \
 133                  get_string(d##_##c, SC_AUTO));                         \
 134 } while (0)
 135
 136 #define PUTRATE(c, r)   do {                                            \
 137         DOPUTRATE(c, (r), IN);                                          \
 138         DOPUTRATE(c, (r)+1, OUT);                                       \
 139 } while (0)
 140
 141 #define PUTTOTAL(c, r)  do {                                            \
 142         DOPUTTOTAL(c, (r), IN);                                         \
 143         DOPUTTOTAL(c, (r)+1, OUT);                                      \
 144 } while (0)
 145
 146 #define PUTNAME(p) do {                                                 \
 147         mvprintw(p->if_ypos, 0, "%s", p->if_name);                      \
 148         mvprintw(p->if_ypos, col2-3, "%s", (const char *)"in");         \
 149         mvprintw(p->if_ypos+1, col2-3, "%s", (const char *)"out");      \
 150 } while (0)
 151
 152
 153 WINDOW *
 154 openifstat(void)
 155 {
 156         return (subwin(stdscr, LINES-1-5, 0, 5, 0));
 157 }
 158
 159 void
 160 closeifstat(WINDOW *w)
 161 {
 162         struct if_stat  *node = NULL;
 163
 164         while (!SLIST_EMPTY(&curlist)) {
 165                 node = SLIST_FIRST(&curlist);
 166                 SLIST_REMOVE_HEAD(&curlist, link);
 167                 free(node);
 168         }
 169
 170         if (w != NULL) {
 171                 wclear(w);
 172                 wrefresh(w);
 173                 delwin(w);
 174         }
 175
 176         return;
 177 }
 178
 179
 180 void
 181 labelifstat(void)
 182 {
 183
 184         wmove(wnd, TOPLINE, 0);
 185         wclrtoeol(wnd);
 186         mvprintw(TOPLINE, 0, "%s", TOPLABEL);
 187
 188         return;
 189 }
 190
 191 void
 192 showifstat(void)
 193 {
 194         struct  if_stat *ifp = NULL;
 195         SLIST_FOREACH(ifp, &curlist, link) {
 196                 if (ifp->display == 0)
 197                         continue;
 198                 PUTNAME(ifp);
 199                 PUTRATE(col2, ifp->if_ypos);
 200                 PUTRATE(col3, ifp->if_ypos);
 201                 PUTTOTAL(col4, ifp->if_ypos);
 202         }
 203
 204         return;
 205 }
 206
 207 int
 208 initifstat(void)
 209 {
 210         struct   if_stat *p = NULL;
 211         u_int    n = 0, i = 0;
 212
 213         n = getifnum();
 214         if (n <= 0)
 215                 return -1;
 216
 217         SLIST_INIT(&curlist);
 218
 219         for (i = 0; i < n; i++) {
 220                 p = (struct if_stat *)malloc(sizeof(struct if_stat));
 221                 if (p == NULL)
 222                         IFSTAT_ERR(1, "out of memory");
 223                 memset((void *)p, 0, sizeof(struct if_stat));
 224                 SLIST_INSERT_HEAD(&curlist, p, link);
 225                 p->if_row = i+1;
 226                 getifmibdata(p->if_row, &p->if_mib);
 227                 right_align_string(p);
 228
 229                 /*
 230                  * Initially, we only display interfaces that have
 231                  * received some traffic.
 232                  */
 233                 if (p->if_mib.ifmd_data.ifi_ibytes != 0)
 234                         p->display = 1;
 235         }
 236
 237         sort_interface_list();
 238
 239         return 1;
 240 }
 241
 242 void
 243 fetchifstat(void)
 244 {
 245         struct  if_stat *ifp = NULL;
 246         struct  timeval tv, new_tv, old_tv;
 247         double  elapsed = 0.0;
 248         u_int   new_inb, new_outb, old_inb, old_outb = 0;
 249         u_int   error = 0;
 250         u_int   we_need_to_sort_interface_list = 0;
 251
 252         SLIST_FOREACH(ifp, &curlist, link) {
 253                 /*
 254                  * Grab a copy of the old input/output values before we
 255                  * call getifmibdata().
 256                  */
 257                 old_inb = ifp->if_mib.ifmd_data.ifi_ibytes;
 258                 old_outb = ifp->if_mib.ifmd_data.ifi_obytes;
 259                 ifp->tv_lastchanged = ifp->if_mib.ifmd_data.ifi_lastchange;
 260
 261                 error = gettimeofday(&new_tv, (struct timezone *)0);
 262                 if (error)
 263                         IFSTAT_ERR(2, "error getting time of day");
 264                 (void)getifmibdata(ifp->if_row, &ifp->if_mib);
 265
 266
 267                 new_inb = ifp->if_mib.ifmd_data.ifi_ibytes;
 268                 new_outb = ifp->if_mib.ifmd_data.ifi_obytes;
 269
 270                 /* Display interface if it's received some traffic. */
 271                 if (new_inb > 0 && old_inb == 0) {
 272                         ifp->display = 1;
 273                         we_need_to_sort_interface_list++;
 274                 }
 275
 276                 /*
 277                  * The rest is pretty trivial.  Calculate the new values
 278                  * for our current traffic rates, and while we're there,
 279                  * see if we have new peak rates.
 280                  */
 281                 old_tv = ifp->tv;
 282                 timersub(&new_tv, &old_tv, &tv);
 283                 elapsed = tv.tv_sec + (tv.tv_usec * 1e-6);
 284
 285                 ifp->if_in_curtraffic = new_inb - old_inb;
 286                 ifp->if_out_curtraffic = new_outb - old_outb;
 287
 288                 /*
 289                  * Rather than divide by the time specified on the comm-
 290                  * and line, we divide by ``elapsed'' as this is likely
 291                  * to be more accurate.
 292                  */
 293                 ifp->if_in_curtraffic /= elapsed;
 294                 ifp->if_out_curtraffic /= elapsed;
 295
 296                 if (ifp->if_in_curtraffic > ifp->if_in_traffic_peak)
 297                         ifp->if_in_traffic_peak = ifp->if_in_curtraffic;
 298
 299                 if (ifp->if_out_curtraffic > ifp->if_out_traffic_peak)
 300                         ifp->if_out_traffic_peak = ifp->if_out_curtraffic;
 301
 302                 ifp->tv.tv_sec = new_tv.tv_sec;
 303                 ifp->tv.tv_usec = new_tv.tv_usec;
 304
 305         }
 306
 307         if (we_need_to_sort_interface_list)
 308                 sort_interface_list();
 309
 310         return;
 311 }
 312
 313 /*
 314  * We want to right justify our interface names against the first column
 315  * (first sixteen or so characters), so we need to do some alignment.
 316  */
 317 static void
 318 right_align_string(const struct if_stat *ifp)
 319 {
 320         int      str_len = 0, pad_len = 0;
 321         char    *newstr = NULL, *ptr = NULL;
 322
 323         if (ifp == NULL || ifp->if_mib.ifmd_name == NULL)
 324                 return;
 325         else {
 326                 /* string length + '\0' */
 327                 str_len = strlen(ifp->if_mib.ifmd_name)+1;
 328                 pad_len = IF_NAMESIZE-(str_len);
 329
 330                 newstr = (char *)ifp->if_name;
 331                 ptr = newstr + pad_len;
 332                 (void)memset((void *)newstr, (int)' ', IF_NAMESIZE);
 333                 (void)strncpy(ptr, (const char *)&ifp->if_mib.ifmd_name,
 334                               str_len);
 335         }
 336
 337         return;
 338 }
 339
 340 /*
 341  * This function iterates through our list of interfaces, identifying
 342  * those that are to be displayed (ifp->display = 1).  For each interf-
 343  * rface that we're displaying, we generate an appropriate position for
 344  * it on the screen (ifp->if_ypos).
 345  *
 346  * This function is called any time a change is made to an interface's
 347  * ``display'' state.
 348  */
 349 void
 350 sort_interface_list(void)
 351 {
 352         struct  if_stat *ifp = NULL;
 353         u_int   y = 0;
 354
 355         y = STARTING_ROW;
 356         SLIST_FOREACH(ifp, &curlist, link) {
 357                 if (ifp->display) {
 358                         ifp->if_ypos = y;
 359                         y += ROW_SPACING;
 360                 }
 361         }
 362 }
 363
 364 static
 365 unsigned int
 366 getifnum(void)
 367 {
 368         int     error   = 0;
 369         u_int   data    = 0;
 370         size_t  datalen = 0;
 371         static  int name[] = { CTL_NET,
 372                                PF_LINK,
 373                                NETLINK_GENERIC,
 374                                IFMIB_SYSTEM,
 375                                IFMIB_IFCOUNT };
 376
 377         datalen = sizeof(data);
 378         error = sysctl(name,
 379                        5,
 380                        (void *)&data,
 381                        (size_t *)&datalen,
 382                        (void *)NULL,
 383                        (size_t)0);
 384         if (error)
 385                 IFSTAT_ERR(1, "sysctl error");
 386         return data;
 387 }
 388
 389 static void
 390 getifmibdata(int row, struct ifmibdata *data)
 391 {
 392         int     error   = 0;
 393         size_t  datalen = 0;
 394         static  int name[] = { CTL_NET,
 395                                PF_LINK,
 396                                NETLINK_GENERIC,
 397                                IFMIB_IFDATA,
 398                                0,
 399                                IFDATA_GENERAL };
 400         datalen = sizeof(*data);
 401         name[4] = row;
 402
 403         error = sysctl(name,
 404                        6,
 405                        (void *)data,
 406                        (size_t *)&datalen,
 407                        (void *)NULL,
 408                        (size_t)0);
 409         if (error)
 410                 IFSTAT_ERR(2, "sysctl error getting interface data");
 411 }
 412
 413 int
 414 cmdifstat(char *cmd, char *args)
 415 {
 416         int     retval = 0;
 417
 418         retval = ifcmd(cmd, args);
 419         /* ifcmd() returns 1 on success */
 420         if (retval == 1) {
 421                 showifstat();
 422                 refresh();
 423         }
 424
 425         return retval;
 426 }