usr.bin/pppstats/pppstats.c

/*
 * print PPP statistics:
 *  pppstats [-a|-d] [-v|-r|-z] [-c count] [-w wait] [interface]
 *
 *   -a Show absolute values rather than deltas
 *   -d Show data rate (kB/s) rather than bytes
 *   -v Show more stats for VJ TCP header compression
 *   -r Show compression ratio
 *   -z Show compression statistics instead of default display
 *
 * History:
 *      perkins@cps.msu.edu: Added compression statistics and alternate
 *                display. 11/94
 *  Brad Parker (brad@cayman.com) 6/92
 *
 * from the original "slstats" by Van Jacobson
 *
 * Copyright (c) 2000-2001 by Sun Microsystems, Inc.
 * All rights reserved.
 *
 * Copyright (c) 1989 Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms are permitted
 * provided that the above copyright notice and this paragraph are
 * duplicated in all such forms and that any documentation,
 * advertising materials, and other materials related to such
 * distribution and use acknowledge that the software was developed
 * by the University of California, Berkeley.  The name of the
 * University may not be used to endorse or promote products derived
 * from this software without specific prior written permission.
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 */

#ifndef __STDC__
#define const
#endif

#pragma ident   "%Z%%M% %I% %E% SMI"

#ifndef lint
static const char rcsid[] = "$Id: pppstats.c,v 1.27 1999/08/13 06:46:23 paulus Exp $";
#endif

#include <stdio.h>
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <errno.h>
#include <signal.h>
#include <fcntl.h>
#include <unistd.h>
#include <sys/param.h>
#include <sys/types.h>
#include <sys/ioctl.h>

#ifndef STREAMS
#if defined(_linux_) && defined(__powerpc__) \
    && (__GLIBC__ == 2 && __GLIBC_MINOR__ == 0)
/* kludge alert! */
#undef __GLIBC__
#endif
#include <sys/socket.h>     /* *BSD, Linux, NeXT, Ultrix etc. */
#ifndef _linux_
#include <net/if.h>
#include <net/ppp_defs.h>
#include <net/if_ppp.h>
#else
/* Linux */
#if __GLIBC__ >= 2
#include <asm/types.h>      /* glibc 2 conflicts with linux/types.h */
#include <net/if.h>
#else
#include <linux/types.h>
#include <linux/if.h>
#endif
#include <linux/ppp_defs.h>
#include <linux/if_ppp.h>
#endif /* _linux_ */

#else   /* STREAMS */
#include <sys/stropts.h>    /* SVR4, Solaris 2, SunOS 4, OSF/1, etc. */
#include <net/ppp_defs.h>
#include <net/pppio.h>

#ifdef PPPIO_GETSTAT64
#define ppp_stats64 ppp_stats64
#endif
#endif  /* STREAMS */

#ifndef ppp_stats64
#define ppp_stats64 ppp_stats
#endif

static int  vflag, rflag, zflag;    /* select type of display */
static int  aflag;          /* print absolute values, not deltas */
static int  dflag;          /* print data rates, not bytes */
static int  interval, count;
static int  infinite;
static int  unit;
static int  s;          /* socket or /dev/ppp file descriptor */
static int  signalled;      /* set if alarm goes off "early" */
static char *progname;
static char *interface;

#if defined(SUNOS4) || defined(ULTRIX) || defined(NeXT)
extern int optind;
extern char *optarg;
#endif

/*
 * If PPP_DRV_NAME is not defined, use the legacy "ppp" as the
 * device name.
 */
#if !defined(PPP_DRV_NAME)
#define PPP_DRV_NAME    "ppp"
#endif /* !defined(PPP_DRV_NAME) */

static void usage __P((void));
static void catchalarm __P((int));
static void get_ppp_stats __P((struct ppp_stats64 *));
static void get_ppp_cstats __P((struct ppp_comp_stats *));
static void intpr __P((void));

int main __P((int, char *argv[]));

static void
usage()
{
    (void) fprintf(stderr,
    "Usage: %s [-a|-d] [-v|-r|-z] [-c count] [-w wait] [interface]\n",
    progname);
    exit(1);
}

/*
 * Called if an interval expires before intpr has completed a loop.
 * Sets a flag to not wait for the alarm.
 */
/* ARGSUSED */
static void
catchalarm(arg)
    int arg;
{
    signalled = 1;
}


#ifndef STREAMS
static void
get_ppp_stats(curp)
    struct ppp_stats64 *curp;
{
    struct ifpppstatsreq req;

    (void) memset (&req, 0, sizeof (req));

#ifdef _linux_
    req.stats_ptr = (caddr_t) &req.stats;
#undef ifr_name
#define ifr_name ifr__name
#endif

    strncpy(req.ifr_name, interface, sizeof(req.ifr_name));
    if (ioctl(s, SIOCGPPPSTATS, &req) < 0) {
    (void) fprintf(stderr, "%s: ", progname);
    if (errno == ENOTTY)
        (void) fprintf(stderr, "kernel support missing\n");
    else
        perror("couldn't get PPP statistics");
    exit(1);
    }
    *curp = req.stats;
}

static void
get_ppp_cstats(csp)
    struct ppp_comp_stats *csp;
{
    struct ifpppcstatsreq creq;

    (void) memset (&creq, 0, sizeof (creq));

#ifdef _linux_
    creq.stats_ptr = (caddr_t) &creq.stats;
#undef  ifr_name
#define ifr_name ifr__name
#endif

    strncpy(creq.ifr_name, interface, sizeof(creq.ifr_name));
    if (ioctl(s, SIOCGPPPCSTATS, &creq) < 0) {
    (void) fprintf(stderr, "%s: ", progname);
    if (errno == ENOTTY) {
        (void) fprintf(stderr, "no kernel compression support\n");
        if (zflag)
        exit(1);
        rflag = 0;
    } else {
        perror("couldn't get PPP compression stats");
        exit(1);
    }
    }

#ifdef _linux_
    if (creq.stats.c.bytes_out == 0) {
    creq.stats.c.bytes_out = creq.stats.c.comp_bytes + creq.stats.c.inc_bytes;
    creq.stats.c.in_count = creq.stats.c.unc_bytes;
    }
    if (creq.stats.c.bytes_out == 0)
    creq.stats.c.ratio = 0.0;
    else
    creq.stats.c.ratio = 256.0 * creq.stats.c.in_count /
                 creq.stats.c.bytes_out;

    if (creq.stats.d.bytes_out == 0) {
    creq.stats.d.bytes_out = creq.stats.d.comp_bytes + creq.stats.d.inc_bytes;
    creq.stats.d.in_count = creq.stats.d.unc_bytes;
    }
    if (creq.stats.d.bytes_out == 0)
    creq.stats.d.ratio = 0.0;
    else
    creq.stats.d.ratio = 256.0 * creq.stats.d.in_count /
                 creq.stats.d.bytes_out;
#endif

    *csp = creq.stats;
}

#else   /* STREAMS */

static int
strioctl(fd, cmd, ptr, ilen, olen)
    int fd, cmd, ilen, olen;
    char *ptr;
{
    struct strioctl str;

    str.ic_cmd = cmd;
    str.ic_timout = 0;
    str.ic_len = ilen;
    str.ic_dp = ptr;
    if (ioctl(fd, I_STR, &str) == -1)
    return -1;
    if (str.ic_len != olen)
    (void) fprintf(stderr,
        "strioctl: expected %d bytes, got %d for cmd %x\n",
        olen, str.ic_len, cmd);
    return 0;
}

static void
get_ppp_stats(curp)
    struct ppp_stats64 *curp;
{
#ifdef PPPIO_GETSTAT64
    struct ppp_stats oldstat;
    if (strioctl(s, PPPIO_GETSTAT64, (char *)curp, 0, sizeof(*curp)) >= 0)
    return;
    if (strioctl(s, PPPIO_GETSTAT, (char *)&oldstat, 0, sizeof(oldstat)) >= 0) {
    curp->p.ppp_ibytes = oldstat.p.ppp_ibytes;
    curp->p.ppp_ipackets = oldstat.p.ppp_ipackets;
    curp->p.ppp_ierrors = oldstat.p.ppp_ierrors;
    curp->p.ppp_obytes = oldstat.p.ppp_obytes;
    curp->p.ppp_opackets = oldstat.p.ppp_opackets;
    curp->p.ppp_oerrors = oldstat.p.ppp_oerrors;
    curp->vj = oldstat.vj;
    return;
    }
#else
    if (strioctl(s, PPPIO_GETSTAT, (char *)curp, 0, sizeof(*curp)) >= 0)
    return;
#endif

    (void) fprintf(stderr, "%s: ", progname);
    if (errno == EINVAL)
    (void) fprintf(stderr, "kernel support missing\n");
    else
    perror("couldn't get PPP statistics");
    exit(1);
}

static void
get_ppp_cstats(csp)
    struct ppp_comp_stats *csp;
{
    if (strioctl(s, PPPIO_GETCSTAT, (char *)csp, 0, sizeof(*csp)) < 0) {
    (void) fprintf(stderr, "%s: ", progname);
    if (errno == ENOTTY) {
        (void) fprintf(stderr, "no kernel compression support\n");
        if (zflag)
        exit(1);
        rflag = 0;
    } else {
        perror("couldn't get PPP compression statistics");
        exit(1);
    }
    }
}

#endif /* STREAMS */

#define MAX0(a)     ((int)(a) > 0? (a): 0)
#define V(offset)   MAX0(cur.offset - old.offset)
#define W(offset)   MAX0(ccs.offset - ocs.offset)

#define RATIO(c, i, u)  ((c) == 0? 1.0: (u) / ((double)(c) + (i)))
#define CRATE(x)    RATIO(W(x.comp_bytes), W(x.inc_bytes), W(x.unc_bytes))

#define KBPS(n)     ((n) / (interval * 1000.0))

/*
 * Print a running summary of interface statistics.
 * Repeat display every interval seconds, showing statistics
 * collected over that interval.  Assumes that interval is non-zero.
 * First line printed is cumulative.
 */
static void
intpr()
{
    register int line = 0;
    sigset_t oldmask, mask;
    char *bunit;
    int ratef = 0;
    struct ppp_stats64 cur, old;
    struct ppp_comp_stats ccs, ocs;

    (void) memset(&old, 0, sizeof(old));
    (void) memset(&ocs, 0, sizeof(ocs));

    for (;;) {
    get_ppp_stats(&cur);
    if (zflag || rflag)
        get_ppp_cstats(&ccs);

    (void)signal(SIGALRM, catchalarm);
    signalled = 0;
    (void)alarm(interval);

    if ((line % 20) == 0) {
        if (zflag) {
        (void) printf("IN:  COMPRESSED  INCOMPRESSIBLE   COMP | ");
        (void) printf("OUT: COMPRESSED  INCOMPRESSIBLE   COMP\n");
        bunit = dflag? "KB/S": "BYTE";
        (void) printf("    %s   PACK     %s   PACK  RATIO | ", bunit,
            bunit);
        (void) printf("    %s   PACK     %s   PACK  RATIO", bunit,
            bunit);
        } else {
        (void) printf("%8.8s %6.6s %6.6s",
               "IN", "PACK", "VJCOMP");

        if (!rflag)
            (void) printf(" %6.6s %6.6s", "VJUNC", "VJERR");
        if (vflag)
            (void) printf(" %6.6s %6.6s", "VJTOSS", "NON-VJ");
        if (rflag)
            (void) printf(" %6.6s %6.6s", "RATIO", "UBYTE");
        (void) printf("  | %8.8s %6.6s %6.6s",
               "OUT", "PACK", "VJCOMP");

        if (!rflag)
            (void) printf(" %6.6s %6.6s", "VJUNC", "NON-VJ");
        if (vflag)
            (void) printf(" %6.6s %6.6s", "VJSRCH", "VJMISS");
        if (rflag)
            (void) printf(" %6.6s %6.6s", "RATIO", "UBYTE");
        }
        (void) putchar('\n');
    }

    if (zflag) {
        if (ratef) {
        (void) printf("%8.3f %6u %8.3f %6u %6.2f",
               KBPS(W(d.comp_bytes)),
               W(d.comp_packets),
               KBPS(W(d.inc_bytes)),
               W(d.inc_packets),
               ccs.d.ratio / 256.0);
        (void) printf(" | %8.3f %6u %8.3f %6u %6.2f",
               KBPS(W(c.comp_bytes)),
               W(c.comp_packets),
               KBPS(W(c.inc_bytes)),
               W(c.inc_packets),
               ccs.c.ratio / 256.0);
        } else {
        (void) printf("%8u %6u %8u %6u %6.2f",
               W(d.comp_bytes),
               W(d.comp_packets),
               W(d.inc_bytes),
               W(d.inc_packets),
               ccs.d.ratio / 256.0);
        (void) printf(" | %8u %6u %8u %6u %6.2f",
               W(c.comp_bytes),
               W(c.comp_packets),
               W(c.inc_bytes),
               W(c.inc_packets),
               ccs.c.ratio / 256.0);
        }

    } else {
        if (ratef)
        (void) printf("%8.3f", KBPS(V(p.ppp_ibytes)));
        else
        (void) printf("%8" PPP_COUNTER_F, V(p.ppp_ibytes));
        (void) printf(" %6" PPP_COUNTER_F " %6u",
           V(p.ppp_ipackets),
           V(vj.vjs_compressedin));
        if (!rflag)
        (void) printf(" %6u %6u",
               V(vj.vjs_uncompressedin),
               V(vj.vjs_errorin));
        if (vflag)
        (void) printf(" %6u %6" PPP_COUNTER_F,
               V(vj.vjs_tossed),
               V(p.ppp_ipackets) - V(vj.vjs_compressedin)
               - V(vj.vjs_uncompressedin) - V(vj.vjs_errorin));
        if (rflag) {
        (void) printf(" %6.2f ", CRATE(d));
        if (ratef)
            (void) printf("%6.2f", KBPS(W(d.unc_bytes)));
        else
            (void) printf("%6u", W(d.unc_bytes));
        }
        if (ratef)
        (void) printf("  | %8.3f", KBPS(V(p.ppp_obytes)));
        else
        (void) printf("  | %8" PPP_COUNTER_F, V(p.ppp_obytes));
        (void) printf(" %6" PPP_COUNTER_F " %6u",
           V(p.ppp_opackets),
           V(vj.vjs_compressed));
        if (!rflag)
        (void) printf(" %6u %6" PPP_COUNTER_F,
               V(vj.vjs_packets) - V(vj.vjs_compressed),
               V(p.ppp_opackets) - V(vj.vjs_packets));
        if (vflag)
        (void) printf(" %6u %6u",
               V(vj.vjs_searches),
               V(vj.vjs_misses));
        if (rflag) {
        (void) printf(" %6.2f ", CRATE(c));
        if (ratef)
            (void) printf("%6.2f", KBPS(W(c.unc_bytes)));
        else
            (void) printf("%6u", W(c.unc_bytes));
        }

    }

    (void) putchar('\n');
    (void) fflush(stdout);
    line++;

    count--;
    if (!infinite && !count)
        break;

    (void) sigemptyset(&mask);
    (void) sigaddset(&mask, SIGALRM);
    (void) sigprocmask(SIG_BLOCK, &mask, &oldmask);
    if (!signalled) {
        (void) sigemptyset(&mask);
        (void) sigsuspend(&mask);
    }
    (void) sigprocmask(SIG_SETMASK, &oldmask, NULL);
    signalled = 0;
    (void)alarm(interval);

    if (!aflag) {
        old = cur;
        ocs = ccs;
        ratef = dflag;
    }
    }
}

int
main(argc, argv)
    int argc;
    char *argv[];
{
    int c;
#ifdef STREAMS
    char *dev;
#endif

    interface = PPP_DRV_NAME "0";
    if ((progname = strrchr(argv[0], '/')) == NULL)
    progname = argv[0];
    else
    ++progname;

    while ((c = getopt(argc, argv, "advrzc:w:")) != -1) {
    switch (c) {
    case 'a':
        ++aflag;
        break;
    case 'd':
        ++dflag;
        break;
    case 'v':
        ++vflag;
        break;
    case 'r':
        ++rflag;
        break;
    case 'z':
        ++zflag;
        break;
    case 'c':
        count = atoi(optarg);
        if (count <= 0)
        usage();
        break;
    case 'w':
        interval = atoi(optarg);
        if (interval <= 0)
        usage();
        break;
    default:
        usage();
    }
    }
    argc -= optind;
    argv += optind;

    if (!interval && count)
    interval = 5;
    if (interval && !count)
    infinite = 1;
    if (!interval && !count)
    count = 1;
    if (aflag)
    dflag = 0;

    if (argc > 1)
    usage();
    if (argc > 0)
    interface = argv[0];

    if (sscanf(interface, PPP_DRV_NAME "%d", &unit) != 1) {
    (void) fprintf(stderr, "%s: invalid interface '%s' specified\n",
        progname, interface);
    }

#ifndef STREAMS
    {
    struct ifreq ifr;

    s = socket(AF_INET, SOCK_DGRAM, 0);
    if (s < 0) {
        (void) fprintf(stderr, "%s: ", progname);
        perror("couldn't create IP socket");
        exit(1);
    }

#ifdef _linux_
#undef  ifr_name
#define ifr_name ifr_ifrn.ifrn_name
#endif
    strncpy(ifr.ifr_name, interface, sizeof(ifr.ifr_name));
    if (ioctl(s, SIOCGIFFLAGS, (caddr_t)&ifr) < 0) {
        (void) fprintf(stderr, "%s: nonexistent interface '%s' specified\n",
            progname, interface);
        exit(1);
    }
    }

#else   /* STREAMS */
#ifdef __osf__
    dev = "/dev/streams/ppp";
#else
    dev = "/dev/" PPP_DRV_NAME;
#endif
    if ((s = open(dev, O_RDONLY)) < 0) {
    (void) fprintf(stderr, "%s: couldn't open ", progname);
    perror(dev);
    exit(1);
    }
    if (strioctl(s, PPPIO_ATTACH, (char *)&unit, sizeof(int), 0) < 0) {
    (void) fprintf(stderr, "%s: " PPP_DRV_NAME "%d is not available\n",
        progname, unit);
    exit(1);
    }

#endif  /* STREAMS */

    intpr();
    return (0);
}