bsd/netinet/tcp_debug.c

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