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