2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1982, 1986, 1993
5 * The Regents of the University of California.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
32 * @(#)tcp_debug.c 8.1 (Berkeley) 6/10/93
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
39 #include "opt_inet6.h"
40 #include "opt_tcpdebug.h"
43 /* load symbolic names */
50 #include <sys/param.h>
51 #include <sys/systm.h>
52 #include <sys/kernel.h>
55 #include <sys/mutex.h>
56 #include <sys/socket.h>
58 #include <netinet/in.h>
59 #include <netinet/in_systm.h>
60 #include <netinet/ip.h>
62 #include <netinet/ip6.h>
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>
73 static int tcpconsdebug = 0;
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.
82 static struct tcp_debug tcp_debug[TCP_NDEBUG];
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).
90 struct mtx tcp_debug_mtx;
91 MTX_SYSINIT(tcp_debug_mtx, &tcp_debug_mtx, "tcp_debug_mtx", MTX_DEF);
94 * Save TCP state at a given moment; optionally, both tcpcb and TCP packet
95 * header state will be saved.
98 tcp_trace(short act, short ostate, struct tcpcb *tp, void *ipgen,
99 struct tcphdr *th, int req)
106 struct tcp_debug *td;
108 mtx_lock(&tcp_debug_mtx);
109 td = &tcp_debug[tcp_debx++];
110 if (tcp_debx == TCP_NDEBUG)
112 bzero(td, sizeof(*td));
114 isipv6 = (ipgen != NULL && ((struct ip *)ipgen)->ip_v == 6) ? 1 : 0;
118 (isipv6 != 0) ? AF_INET6 :
122 td->td_time = iptime();
125 td->td_ostate = ostate;
126 td->td_tcb = (caddr_t)tp;
130 switch (td->td_family) {
133 bcopy(ipgen, &td->td_ti.ti_i, sizeof(td->td_ti.ti_i));
138 bcopy(ipgen, td->td_ip6buf, sizeof(td->td_ip6buf));
144 switch (td->td_family) {
147 td->td_ti.ti_t = *th;
158 mtx_unlock(&tcp_debug_mtx);
160 if (tcpconsdebug == 0)
163 printf("%p %s:", tp, tcpstates[ostate]);
166 printf("%s ", tanames[act]);
171 if (ipgen == NULL || th == NULL)
177 isipv6 ? ntohs(((struct ip6_hdr *)ipgen)->ip6_plen) :
179 ntohs(((struct ip *)ipgen)->ip_len);
180 if (act == TA_OUTPUT) {
184 if (act == TA_OUTPUT)
185 len -= sizeof (struct tcphdr);
187 printf("[%x..%x)", seq, seq+len);
190 printf("@%x, urp=%x", ack, th->th_urp);
191 flags = tcp_get_flags(th);
195 if (tcp_get_flags(th) & TH_##f) { \
196 printf("%s%s", cp, #f); \
200 pf(SYN); pf(ACK); pf(FIN); pf(RST); pf(PUSH); pf(URG);
206 printf("%s", prurequests[req&0xff]);
207 if ((req & 0xff) == PRU_SLOWTIMO)
208 printf("<%s>", tcptimers[req>>8]);
212 printf(" -> %s", tcpstates[tp->t_state]);
213 /* print out internal state of tp !?! */
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 */