sys/netinet/tcp_debug.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1993
   5  *      The Regents of the University of California.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      @(#)tcp_debug.c 8.1 (Berkeley) 6/10/93
  33  */
  34
  35 #include <sys/cdefs.h>
  36 __FBSDID("$FreeBSD$");
  37
  38 #include "opt_inet.h"
  39 #include "opt_inet6.h"
  40 #include "opt_tcpdebug.h"
  41
  42 #ifdef TCPDEBUG
  43 /* load symbolic names */
  44 #define PRUREQUESTS
  45 #define TCPSTATES
  46 #define TCPTIMERS
  47 #define TANAMES
  48 #endif
  49
  50 #include <sys/param.h>
  51 #include <sys/systm.h>
  52 #include <sys/kernel.h>
  53 #include <sys/lock.h>
  54 #include <sys/mbuf.h>
  55 #include <sys/mutex.h>
  56 #include <sys/socket.h>
  57
  58 #include <netinet/in.h>
  59 #include <netinet/in_systm.h>
  60 #include <netinet/ip.h>
  61 #ifdef INET6
  62 #include <netinet/ip6.h>
  63 #endif
  64 #include <netinet/ip_var.h>
  65 #include <netinet/tcp.h>
  66 #include <netinet/tcp_fsm.h>
  67 #include <netinet/tcp_timer.h>
  68 #include <netinet/tcp_var.h>
  69 #include <netinet/tcpip.h>
  70 #include <netinet/tcp_debug.h>
  71
  72 #ifdef TCPDEBUG
  73 static int              tcpconsdebug = 0;
  74 #endif
  75
  76 /*
  77  * Global ring buffer of TCP debugging state.  Each entry captures a snapshot
  78  * of TCP connection state at any given moment.  tcp_debx addresses at the
  79  * next available slot.  There is no explicit export of this data structure;
  80  * it will be read via /dev/kmem by debugging tools.
  81  */
  82 static struct tcp_debug tcp_debug[TCP_NDEBUG];
  83 static int              tcp_debx;
  84
  85 /*
  86  * All global state is protected by tcp_debug_mtx; tcp_trace() is split into
  87  * two parts, one of which saves connection and other state into the global
  88  * array (locked by tcp_debug_mtx).
  89  */
  90 struct mtx              tcp_debug_mtx;
  91 MTX_SYSINIT(tcp_debug_mtx, &tcp_debug_mtx, "tcp_debug_mtx", MTX_DEF);
  92
  93 /*
  94  * Save TCP state at a given moment; optionally, both tcpcb and TCP packet
  95  * header state will be saved.
  96  */
  97 void
  98 tcp_trace(short act, short ostate, struct tcpcb *tp, void *ipgen,
  99     struct tcphdr *th, int req)
 100 {
 101 #ifdef INET6
 102         int isipv6;
 103 #endif /* INET6 */
 104         tcp_seq seq, ack;
 105         int len, flags;
 106         struct tcp_debug *td;
 107
 108         mtx_lock(&tcp_debug_mtx);
 109         td = &tcp_debug[tcp_debx++];
 110         if (tcp_debx == TCP_NDEBUG)
 111                 tcp_debx = 0;
 112         bzero(td, sizeof(*td));
 113 #ifdef INET6
 114         isipv6 = (ipgen != NULL && ((struct ip *)ipgen)->ip_v == 6) ? 1 : 0;
 115 #endif /* INET6 */
 116         td->td_family =
 117 #ifdef INET6
 118             (isipv6 != 0) ? AF_INET6 :
 119 #endif
 120             AF_INET;
 121 #ifdef INET
 122         td->td_time = iptime();
 123 #endif
 124         td->td_act = act;
 125         td->td_ostate = ostate;
 126         td->td_tcb = (caddr_t)tp;
 127         if (tp != NULL)
 128                 td->td_cb = *tp;
 129         if (ipgen != NULL) {
 130                 switch (td->td_family) {
 131 #ifdef INET
 132                 case AF_INET:
 133                         bcopy(ipgen, &td->td_ti.ti_i, sizeof(td->td_ti.ti_i));
 134                         break;
 135 #endif
 136 #ifdef INET6
 137                 case AF_INET6:
 138                         bcopy(ipgen, td->td_ip6buf, sizeof(td->td_ip6buf));
 139                         break;
 140 #endif
 141                 }
 142         }
 143         if (th != NULL) {
 144                 switch (td->td_family) {
 145 #ifdef INET
 146                 case AF_INET:
 147                         td->td_ti.ti_t = *th;
 148                         break;
 149 #endif
 150 #ifdef INET6
 151                 case AF_INET6:
 152                         td->td_ti6.th = *th;
 153                         break;
 154 #endif
 155                 }
 156         }
 157         td->td_req = req;
 158         mtx_unlock(&tcp_debug_mtx);
 159 #ifdef TCPDEBUG
 160         if (tcpconsdebug == 0)
 161                 return;
 162         if (tp != NULL)
 163                 printf("%p %s:", tp, tcpstates[ostate]);
 164         else
 165                 printf("???????? ");
 166         printf("%s ", tanames[act]);
 167         switch (act) {
 168         case TA_INPUT:
 169         case TA_OUTPUT:
 170         case TA_DROP:
 171                 if (ipgen == NULL || th == NULL)
 172                         break;
 173                 seq = th->th_seq;
 174                 ack = th->th_ack;
 175                 len =
 176 #ifdef INET6
 177                     isipv6 ? ntohs(((struct ip6_hdr *)ipgen)->ip6_plen) :
 178 #endif
 179                     ntohs(((struct ip *)ipgen)->ip_len);
 180                 if (act == TA_OUTPUT) {
 181                         seq = ntohl(seq);
 182                         ack = ntohl(ack);
 183                 }
 184                 if (act == TA_OUTPUT)
 185                         len -= sizeof (struct tcphdr);
 186                 if (len)
 187                         printf("[%x..%x)", seq, seq+len);
 188                 else
 189                         printf("%x", seq);
 190                 printf("@%x, urp=%x", ack, th->th_urp);
 191                 flags = tcp_get_flags(th);
 192                 if (flags) {
 193                         char *cp = "<";
 194 #define pf(f) {                                 \
 195         if (tcp_get_flags(th) & TH_##f) {       \
 196                 printf("%s%s", cp, #f);         \
 197                 cp = ",";                       \
 198         }                                       \
 199 }
 200                         pf(SYN); pf(ACK); pf(FIN); pf(RST); pf(PUSH); pf(URG);
 201                         printf(">");
 202                 }
 203                 break;
 204
 205         case TA_USER:
 206                 printf("%s", prurequests[req&0xff]);
 207                 if ((req & 0xff) == PRU_SLOWTIMO)
 208                         printf("<%s>", tcptimers[req>>8]);
 209                 break;
 210         }
 211         if (tp != NULL)
 212                 printf(" -> %s", tcpstates[tp->t_state]);
 213         /* print out internal state of tp !?! */
 214         printf("\n");
 215         if (tp == NULL)
 216                 return;
 217         printf(
 218         "\trcv_(nxt,wnd,up) (%lx,%lx,%lx) snd_(una,nxt,max) (%lx,%lx,%lx)\n",
 219             (u_long)tp->rcv_nxt, (u_long)tp->rcv_wnd, (u_long)tp->rcv_up,
 220             (u_long)tp->snd_una, (u_long)tp->snd_nxt, (u_long)tp->snd_max);
 221         printf("\tsnd_(wl1,wl2,wnd) (%lx,%lx,%lx)\n",
 222             (u_long)tp->snd_wl1, (u_long)tp->snd_wl2, (u_long)tp->snd_wnd);
 223 #endif /* TCPDEBUG */
 224 }