bsd/netinet/tcp_debug.c

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * Copyright (c) 1982, 1986, 1993
  24  *      The Regents of the University of California.  All rights reserved.
  25  *
  26  * Redistribution and use in source and binary forms, with or without
  27  * modification, are permitted provided that the following conditions
  28  * are met:
  29  * 1. Redistributions of source code must retain the above copyright
  30  *    notice, this list of conditions and the following disclaimer.
  31  * 2. Redistributions in binary form must reproduce the above copyright
  32  *    notice, this list of conditions and the following disclaimer in the
  33  *    documentation and/or other materials provided with the distribution.
  34  * 3. All advertising materials mentioning features or use of this software
  35  *    must display the following acknowledgement:
  36  *      This product includes software developed by the University of
  37  *      California, Berkeley and its contributors.
  38  * 4. Neither the name of the University nor the names of its contributors
  39  *    may be used to endorse or promote products derived from this software
  40  *    without specific prior written permission.
  41  *
  42  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  43  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  45  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  46  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  47  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  48  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  50  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  51  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52  * SUCH DAMAGE.
  53  *
  54  *      @(#)tcp_debug.c 8.1 (Berkeley) 6/10/93
  55  * $FreeBSD: src/sys/netinet/tcp_debug.c,v 1.16.2.1 2000/07/15 07:14:31 kris Exp $
  56  */
  57
  58
  59 #ifndef INET
  60 #error The option TCPDEBUG requires option INET.
  61 #endif
  62
  63 #if TCPDEBUG
  64 /* load symbolic names */
  65 #define PRUREQUESTS
  66 #define TCPSTATES
  67 #define TCPTIMERS
  68 #define TANAMES
  69 #endif
  70
  71 #include <sys/param.h>
  72 #include <sys/systm.h>
  73 #include <sys/protosw.h>
  74 #include <sys/sysctl.h>
  75 #include <sys/socket.h>
  76
  77 #include <netinet/in.h>
  78 #include <netinet/in_systm.h>
  79 #include <netinet/ip.h>
  80 #if INET6
  81 #include <netinet/ip6.h>
  82 #endif
  83 #include <netinet/ip_var.h>
  84 #include <netinet/tcp.h>
  85 #include <netinet/tcp_fsm.h>
  86 #include <netinet/tcp_timer.h>
  87 #include <netinet/tcp_var.h>
  88 #include <netinet/tcpip.h>
  89 #include <netinet/tcp_debug.h>
  90
  91 #if TCPDEBUG
  92 __private_extern__ int  tcpconsdebug = 0;
  93 SYSCTL_INT(_net_inet_tcp, OID_AUTO, tcpconsdebug, CTLFLAG_RW,
  94     &tcpconsdebug, 0, "Turn tcp debugging on or off");
  95 #endif
  96
  97 static struct tcp_debug tcp_debug[TCP_NDEBUG];
  98 static int      tcp_debx;
  99
 100 /*
 101  * Tcp debug routines
 102  */
 103 void
 104 tcp_trace(act, ostate, tp, ipgen, th, req)
 105         short act, ostate;
 106         struct tcpcb *tp;
 107         void *ipgen;
 108         struct tcphdr *th;
 109         int req;
 110 {
 111 #if INET6
 112         int isipv6;
 113 #endif /* INET6 */
 114         tcp_seq seq, ack;
 115         int len, flags;
 116         struct tcp_debug *td = &tcp_debug[tcp_debx++];
 117
 118 #if INET6
 119         isipv6 = (ipgen != NULL && ((struct ip *)ipgen)->ip_v == 6) ? 1 : 0;
 120 #endif /* INET6 */
 121         td->td_family =
 122 #if INET6
 123                 (isipv6 != 0) ? AF_INET6 :
 124 #endif
 125                 AF_INET;
 126         if (tcp_debx == TCP_NDEBUG)
 127                 tcp_debx = 0;
 128         td->td_time = iptime();
 129         td->td_act = act;
 130         td->td_ostate = ostate;
 131         td->td_tcb = (caddr_t)tp;
 132         if (tp)
 133                 td->td_cb = *tp;
 134         else
 135                 bzero((caddr_t)&td->td_cb, sizeof (*tp));
 136         if (ipgen) {
 137                 switch (td->td_family) {
 138                 case AF_INET:
 139                         bcopy((caddr_t)ipgen, (caddr_t)&td->td_ti.ti_i,
 140                               sizeof(td->td_ti.ti_i));
 141                         bzero((caddr_t)td->td_ip6buf, sizeof(td->td_ip6buf));
 142                         break;
 143 #if INET6
 144                 case AF_INET6:
 145                         bcopy((caddr_t)ipgen, (caddr_t)td->td_ip6buf,
 146                               sizeof(td->td_ip6buf));
 147                         bzero((caddr_t)&td->td_ti.ti_i,
 148                               sizeof(td->td_ti.ti_i));
 149                         break;
 150 #endif
 151                 default:
 152                         bzero((caddr_t)td->td_ip6buf, sizeof(td->td_ip6buf));
 153                         bzero((caddr_t)&td->td_ti.ti_i,
 154                               sizeof(td->td_ti.ti_i));
 155                         break;
 156                 }
 157         } else {
 158                 bzero((caddr_t)&td->td_ti.ti_i, sizeof(td->td_ti.ti_i));
 159                 bzero((caddr_t)td->td_ip6buf, sizeof(td->td_ip6buf));
 160         }
 161         if (th) {
 162                 switch (td->td_family) {
 163                 case AF_INET:
 164                         td->td_ti.ti_t = *th;
 165                         bzero((caddr_t)&td->td_ti6.th, sizeof(td->td_ti6.th));
 166                         break;
 167 #if INET6
 168                 case AF_INET6:
 169                         td->td_ti6.th = *th;
 170                         bzero((caddr_t)&td->td_ti.ti_t,
 171                               sizeof(td->td_ti.ti_t));
 172                         break;
 173 #endif
 174                 default:
 175                         bzero((caddr_t)&td->td_ti.ti_t,
 176                               sizeof(td->td_ti.ti_t));
 177                         bzero((caddr_t)&td->td_ti6.th, sizeof(td->td_ti6.th));
 178                         break;
 179                 }
 180         } else {
 181                 bzero((caddr_t)&td->td_ti.ti_t, sizeof(td->td_ti.ti_t));
 182                 bzero((caddr_t)&td->td_ti6.th, sizeof(td->td_ti6.th));
 183         }
 184         td->td_req = req;
 185 #if TCPDEBUG
 186         if (tcpconsdebug == 0)
 187                 return;
 188         if (tp)
 189                 printf("%x %s:", tp, tcpstates[ostate]);
 190         else
 191                 printf("???????? ");
 192         printf("%s ", tanames[act]);
 193         switch (act) {
 194
 195         case TA_INPUT:
 196         case TA_OUTPUT:
 197         case TA_DROP:
 198                 if (ipgen == NULL || th == NULL)
 199                         break;
 200                 seq = th->th_seq;
 201                 ack = th->th_ack;
 202                 len =
 203 #if INET6
 204                         isipv6 ? ((struct ip6_hdr *)ipgen)->ip6_plen :
 205 #endif
 206                         ((struct ip *)ipgen)->ip_len;
 207                 if (act == TA_OUTPUT) {
 208                         seq = ntohl(seq);
 209                         ack = ntohl(ack);
 210                         len = ntohs((u_short)len);
 211                 }
 212                 if (act == TA_OUTPUT)
 213                         len -= sizeof (struct tcphdr);
 214                 if (len)
 215                         printf("[%x..%x)", seq, seq+len);
 216                 else
 217                         printf("%x", seq);
 218                 printf("@%x, urp=%x", ack, th->th_urp);
 219                 flags = th->th_flags;
 220                 if (flags) {
 221                         char *cp = "<";
 222 #define pf(f) {                                 \
 223         if (th->th_flags & TH_##f) {            \
 224                 printf("%s%s", cp, #f);         \
 225                 cp = ",";                       \
 226         }                                       \
 227 }
 228                         pf(SYN); pf(ACK); pf(FIN); pf(RST); pf(PUSH); pf(URG);
 229                         printf(">");
 230                 }
 231                 break;
 232
 233         case TA_USER:
 234                 printf("%s", prurequests[req&0xff]);
 235                 if ((req & 0xff) == PRU_SLOWTIMO)
 236                         printf("<%s>", tcptimers[req>>8]);
 237                 break;
 238         }
 239         if (tp)
 240                 printf(" -> %s", tcpstates[tp->t_state]);
 241         /* print out internal state of tp !?! */
 242         printf("\n");
 243         if (tp == 0)
 244                 return;
 245         printf(
 246         "\trcv_(nxt,wnd,up) (%lx,%lx,%lx) snd_(una,nxt,max) (%lx,%lx,%lx)\n",
 247             (u_long)tp->rcv_nxt, tp->rcv_wnd, (u_long)tp->rcv_up,
 248             (u_long)tp->snd_una, (u_long)tp->snd_nxt, (u_long)tp->snd_max);
 249         printf("\tsnd_(wl1,wl2,wnd) (%lx,%lx,%lx)\n",
 250             (u_long)tp->snd_wl1, (u_long)tp->snd_wl2, tp->snd_wnd);
 251 #endif /* TCPDEBUG */
 252 }