root/usr.sbin/trpt/trpt.c
/*
 * Copyright (c) 1983, 1988, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * @(#) Copyright (c) 1983, 1988, 1993 The Regents of the University of California.  All rights reserved.
 * @(#)trpt.c   8.1 (Berkeley) 6/6/93
 * $FreeBSD: src/usr.sbin/trpt/trpt.c,v 1.12 2000/01/29 11:49:07 shin Exp $
 */

#include <sys/param.h>
#include <sys/queue.h>
#include <sys/socket.h>
#include <sys/socketvar.h>
#define PRUREQUESTS
#include <sys/protosw.h>
#include <sys/time.h>

#include <net/route.h>
#include <net/if.h>

#include <netinet/in.h>
#include <netinet/in_systm.h>
#include <netinet/ip.h>
#ifdef INET6
#include <netinet/ip6.h>
#endif
#include <netinet/ip_var.h>
#include <netinet/tcp.h>
#define TCPSTATES
#include <netinet/tcp_fsm.h>
#include <netinet/tcp_seq.h>
#define TCPTIMERS
#include <netinet/tcp_timer.h>
#include <netinet/tcp_var.h>
#include <netinet/tcpip.h>
#define TANAMES
#include <netinet/tcp_debug.h>

#include <arpa/inet.h>

#include <err.h>
#include <fcntl.h>
#include <nlist.h>
#include <paths.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>

struct nlist nl[] = {
#define N_TCP_DEBUG     0
        { .n_name = "_tcp_debug" },
#define N_TCP_DEBX      1
        { .n_name = "_tcp_debx" },
        { .n_name = "" },
};

static caddr_t tcp_pcbs[TCP_NDEBUG];
static n_time ntime;
static int aflag, kflag, memf, follow, sflag, tflag;

void dotrace(caddr_t);
void klseek(int, off_t, int);
int numeric(const void *, const void *);
void tcp_trace(short, short, struct tcpcb *, struct tcpcb *,
                        int, void *, struct tcphdr *, int);
static void usage(void);

int
main(int argc, char **argv)
{
        int ch, i, jflag, npcbs;
        const char *syst, *core;

        jflag = npcbs = 0;
        while ((ch = getopt(argc, argv, "afjp:st")) != -1)
                switch (ch) {
                case 'a':
                        ++aflag;
                        break;
                case 'f':
                        ++follow;
                        setlinebuf(stdout);
                        break;
                case 'j':
                        ++jflag;
                        break;
                case 'p':
                        if (npcbs >= TCP_NDEBUG)
                                errx(1, "too many pcb's specified");
                        sscanf(optarg, "%x", (int *)&tcp_pcbs[npcbs++]);
                        break;
                case 's':
                        ++sflag;
                        break;
                case 't':
                        ++tflag;
                        break;
                case '?':
                default:
                        usage();
                }
        argc -= optind;
        argv += optind;

        core = _PATH_KMEM;
        if (argc > 0) {
                syst = *argv;
                argc--, argv++;
                if (argc > 0) {
                        core = *argv;
                        argc--, argv++;
                        ++kflag;
                }
                /*
                 * Discard setgid privileges if not the running kernel so that
                 * bad guys can't print interesting stuff from kernel memory.
                 */
                setgid(getgid());
        } else {
                syst = getbootfile();
        }

        if (nlist(syst, nl) < 0 || !nl[0].n_value)
                errx(1, "%s: no namelist", syst);
        if ((memf = open(core, O_RDONLY)) < 0)
                err(2, "%s", core);
        if (kflag)
                errx(1, "can't do core files yet");
        klseek(memf, (off_t)nl[N_TCP_DEBX].n_value, L_SET);
        if (read(memf, (char *)&tcp_debx, sizeof(tcp_debx)) !=
            sizeof(tcp_debx))
                err(3, "tcp_debx");
        klseek(memf, (off_t)nl[N_TCP_DEBUG].n_value, L_SET);
        if (read(memf, (char *)tcp_debug, sizeof(tcp_debug)) !=
            sizeof(tcp_debug))
                err(3, "tcp_debug");
        /*
         * If no control blocks have been specified, figure
         * out how many distinct one we have and summarize
         * them in tcp_pcbs for sorting the trace records
         * below.
         */
        if (!npcbs) {
                for (i = 0; i < TCP_NDEBUG; i++) {
                        struct tcp_debug *td = &tcp_debug[i];
                        int j;

                        if (td->td_tcb == 0)
                                continue;
                        for (j = 0; j < npcbs; j++)
                                if (tcp_pcbs[j] == td->td_tcb)
                                        break;
                        if (j >= npcbs)
                                tcp_pcbs[npcbs++] = td->td_tcb;
                }
                if (!npcbs)
                        exit(0);
        }
        qsort(tcp_pcbs, npcbs, sizeof(caddr_t), numeric);
        if (jflag) {
                for (i = 0;;) {
                        printf("%p", (void *)tcp_pcbs[i]);
                        if (++i == npcbs)
                                break;
                        fputs(", ", stdout);
                }
                putchar('\n');
        } else {
                for (i = 0; i < npcbs; i++) {
                        printf("\n%p:\n", (void *)tcp_pcbs[i]);
                        dotrace(tcp_pcbs[i]);
                }
        }
        exit(0);
}

static void
usage(void)
{
        fprintf(stderr,
            "usage: trpt [-afjst] [-p hex-address] [system [core]]\n");
        exit(1);
}

void
dotrace(caddr_t tcpcb)
{
        struct tcp_debug *td;
        int i;
        int prev_debx, family;

        prev_debx = tcp_debx;
again:  if (--tcp_debx < 0)
                tcp_debx = TCP_NDEBUG - 1;
        for (i = prev_debx % TCP_NDEBUG; i < TCP_NDEBUG; i++) {
                td = &tcp_debug[i];
                if (tcpcb && td->td_tcb != tcpcb)
                        continue;
                ntime = ntohl(td->td_time);
#ifdef INET6
                family = td->td_family;
#else
                family = AF_INET;
#endif
                switch(family) {
                case AF_INET:
                        tcp_trace(td->td_act, td->td_ostate,
                                  (struct tcpcb *)td->td_tcb,
                                  &td->td_cb, td->td_family, &td->td_ti.ti_i,
                                  &td->td_ti.ti_t, td->td_req);
                        break;
#ifdef INET6
                case AF_INET6:
                        tcp_trace(td->td_act, td->td_ostate,
                                  (struct tcpcb *)td->td_tcb,
                                  &td->td_cb, td->td_family, &td->td_ti6.ip6,
                                  &td->td_ti6.th, td->td_req);
                        break;
#endif
                }
                if (i == tcp_debx)
                        goto done;
        }
        for (i = 0; i <= tcp_debx % TCP_NDEBUG; i++) {
                td = &tcp_debug[i];
                if (tcpcb && td->td_tcb != tcpcb)
                        continue;
                ntime = ntohl(td->td_time);
#ifdef INET6
                family = td->td_family;
#else
                family = AF_INET;
#endif
                switch(family) {
                case AF_INET:
                        tcp_trace(td->td_act, td->td_ostate,
                                  (struct tcpcb *)td->td_tcb,
                                  &td->td_cb, td->td_family, &td->td_ti.ti_i,
                                  &td->td_ti.ti_t, td->td_req);
                        break;
#ifdef INET6
                case AF_INET6:
                        tcp_trace(td->td_act, td->td_ostate,
                                  (struct tcpcb *)td->td_tcb,
                                  &td->td_cb, td->td_family, &td->td_ti6.ip6,
                                  &td->td_ti6.th, td->td_req);
                        break;
#endif
                }
        }
done:   if (follow) {
                prev_debx = tcp_debx + 1;
                if (prev_debx >= TCP_NDEBUG)
                        prev_debx = 0;
                do {
                        sleep(1);
                        klseek(memf, (off_t)nl[N_TCP_DEBX].n_value, L_SET);
                        if (read(memf, (char *)&tcp_debx, sizeof(tcp_debx)) !=
                            sizeof(tcp_debx))
                                err(3, "tcp_debx");
                } while (tcp_debx == prev_debx);
                klseek(memf, (off_t)nl[N_TCP_DEBUG].n_value, L_SET);
                if (read(memf, (char *)tcp_debug, sizeof(tcp_debug)) !=
                    sizeof(tcp_debug))
                        err(3, "tcp_debug");
                goto again;
        }
}

/*
 * Tcp debug routines
 */
/*ARGSUSED*/
void
tcp_trace(short act, short ostate, struct tcpcb *atp __unused,
    struct tcpcb *tp, int family, void *ip, struct tcphdr *th, int req)
{
        tcp_seq seq, ack;
        int flags, len, win, timer;
        struct ip *ip4 = NULL;
#ifdef INET6
        int isipv6 = 0, nopkt = 1;
        struct ip6_hdr *ip6 = NULL;
        char ntop_buf[INET6_ADDRSTRLEN];
#endif

#ifdef INET6
        switch (family) {
        case AF_INET:
                nopkt = 0;
                isipv6 = 0;
                ip4 = (struct ip *)ip;
                break;
        case AF_INET6:
                nopkt = 0;
                isipv6 = 1;
                ip6 = (struct ip6_hdr *)ip;
        case 0:
        default:
                break;
        }
#else
        ip4 = (struct ip *)ip;
#endif
        printf("%03ld %s:%s ",(long)(ntime/10) % 1000, tcpstates[ostate],
            tanames[act]);
        switch (act) {
        case TA_INPUT:
        case TA_OUTPUT:
        case TA_DROP:
#ifdef INET6
                if (nopkt != 0)
                        break;
#endif
                if (aflag) {
                        printf("(src=%s,%u, ",

#ifdef INET6
                               isipv6
                               ? inet_ntop(AF_INET6, &ip6->ip6_src, ntop_buf,
                                           sizeof(ntop_buf)) :
#endif
                               inet_ntoa(ip4->ip_src),
                               ntohs(th->th_sport));
                        printf("dst=%s,%u)",
#ifdef INET6
                               isipv6
                               ? inet_ntop(AF_INET6, &ip6->ip6_dst, ntop_buf,
                                           sizeof(ntop_buf)) :
#endif
                               inet_ntoa(ip4->ip_dst),
                               ntohs(th->th_dport));
                }
                seq = th->th_seq;
                ack = th->th_ack;

                len =
#ifdef INET6
                        isipv6 ? ip6->ip6_plen :
#endif
                        ip4->ip_len;
                win = th->th_win;
                if (act == TA_OUTPUT) {
                        seq = ntohl(seq);
                        ack = ntohl(ack);
                        len = ntohs(len);
                        win = ntohs(win);
                }
                if (act == TA_OUTPUT)
                        len -= sizeof(struct tcphdr);
                if (len)
                        printf("[%lx..%lx)", (u_long)seq, (u_long)(seq + len));
                else
                        printf("%lx", (u_long)seq);
                printf("@%lx", (u_long)ack);
                if (win)
                        printf("(win=%x)", win);
                flags = th->th_flags;
                if (flags) {
                        const char *cp = "<";

#define pf(flag, string) {                                              \
        if (th->th_flags & flag) {                                      \
                printf("%s%s", cp, string);                             \
                cp = ",";                                               \
        }                                                               \
}
                        pf(TH_SYN, "SYN");
                        pf(TH_ACK, "ACK");
                        pf(TH_FIN, "FIN");
                        pf(TH_RST, "RST");
                        pf(TH_PUSH, "PUSH");
                        pf(TH_URG, "URG");
                        printf(">");
                }
                break;
        case TA_USER:
                timer = req >> 8;
                req &= 0xff;
                printf("%s", prurequests[req]);
                if (req == PRU_SLOWTIMO || req == PRU_FASTTIMO)
                        printf("<%s>", tcptimers[timer]);
                break;
        }
        printf(" -> %s", tcpstates[tp->t_state]);
        /* print out internal state of tp !?! */
        printf("\n");
        if (sflag) {
                printf("\trcv_nxt %lx rcv_wnd %lx snd_una %lx snd_nxt %lx snd_max %lx\n",
                    (u_long)tp->rcv_nxt, tp->rcv_wnd,
                    (u_long)tp->snd_una, (u_long)tp->snd_nxt,
                    (u_long)tp->snd_max);
                printf("\tsnd_wl1 %lx snd_wl2 %lx snd_wnd %lx\n",
                    (u_long)tp->snd_wl1,
                    (u_long)tp->snd_wl2, (u_long)tp->snd_wnd);
        }
        /* print out timers? */
#if 0
        /*
         * XXX 
         * kernel now uses callouts, not integer time values.
         */
        if (tflag) {
                char *cp = "\t";
                int i;

                for (i = 0; i < TCPT_NTIMERS; i++) {
                        if (tp->t_timer[i] == 0)
                                continue;
                        printf("%s%s=%d", cp, tcptimers[i], tp->t_timer[i]);
                        if (i == TCPT_REXMT)
                                printf(" (t_rxtshft=%d)", tp->t_rxtshift);
                        cp = ", ";
                }
                if (*cp != '\t')
                        putchar('\n');
        }
#endif
}

int
numeric(const void *v1, const void *v2)
{
        const caddr_t *c1 = v1, *c2 = v2;

        return(*c1 - *c2);
}

void
klseek(int fd, off_t base, int off)
{
        lseek(fd, base, off);
}