bsd/netinet/tcp_debug.c

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