xref: /openbsd-src/sys/netinet/tcp_debug.c (revision ae3cb403620ab940fbaabb3055fac045a63d56b7)
1 /*	$OpenBSD: tcp_debug.c,v 1.24 2017/05/18 11:38:07 mpi Exp $	*/
2 /*	$NetBSD: tcp_debug.c,v 1.10 1996/02/13 23:43:36 christos Exp $	*/
3 
4 /*
5  * Copyright (c) 1982, 1986, 1993
6  *	The Regents of the University of California.  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  *	@(#)COPYRIGHT	1.1 (NRL) 17 January 1995
33  *
34  * NRL grants permission for redistribution and use in source and binary
35  * forms, with or without modification, of the software and documentation
36  * created at NRL provided that the following conditions are met:
37  *
38  * 1. Redistributions of source code must retain the above copyright
39  *    notice, this list of conditions and the following disclaimer.
40  * 2. Redistributions in binary form must reproduce the above copyright
41  *    notice, this list of conditions and the following disclaimer in the
42  *    documentation and/or other materials provided with the distribution.
43  * 3. All advertising materials mentioning features or use of this software
44  *    must display the following acknowledgements:
45  * 	This product includes software developed by the University of
46  * 	California, Berkeley and its contributors.
47  * 	This product includes software developed at the Information
48  * 	Technology Division, US Naval Research Laboratory.
49  * 4. Neither the name of the NRL nor the names of its contributors
50  *    may be used to endorse or promote products derived from this software
51  *    without specific prior written permission.
52  *
53  * THE SOFTWARE PROVIDED BY NRL IS PROVIDED BY NRL AND CONTRIBUTORS ``AS
54  * IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
55  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
56  * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL NRL OR
57  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
58  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
59  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
60  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
61  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
62  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
63  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
64  *
65  * The views and conclusions contained in the software and documentation
66  * are those of the authors and should not be interpreted as representing
67  * official policies, either expressed or implied, of the US Naval
68  * Research Laboratory (NRL).
69  */
70 
71 #ifdef 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/mbuf.h>
82 #include <sys/socket.h>
83 #include <sys/protosw.h>
84 
85 #include <net/route.h>
86 
87 #include <netinet/in.h>
88 #include <netinet/in_systm.h>
89 #include <netinet/ip.h>
90 #include <netinet/in_pcb.h>
91 #include <netinet/ip_var.h>
92 #include <netinet/tcp.h>
93 #include <netinet/tcp_timer.h>
94 #include <netinet/tcp_var.h>
95 #include <netinet/tcp_debug.h>
96 #include <netinet/tcp_fsm.h>
97 
98 #ifdef INET6
99 #include <netinet/ip6.h>
100 #endif /* INET6 */
101 
102 #ifdef TCPDEBUG
103 int	tcpconsdebug = 0;
104 #endif
105 
106 struct	tcp_debug tcp_debug[TCP_NDEBUG];
107 int	tcp_debx;
108 
109 /*
110  * Tcp debug routines
111  */
112 void
113 tcp_trace(short act, short ostate, struct tcpcb *tp, caddr_t headers,
114    int req, int len)
115 {
116 #ifdef TCPDEBUG
117 	tcp_seq seq, ack;
118 	int flags;
119 #endif
120 	struct tcp_debug *td = &tcp_debug[tcp_debx++];
121 	struct tcpiphdr *ti = (struct tcpiphdr *)headers;
122 	struct tcphdr *th;
123 #ifdef INET6
124 	struct tcpipv6hdr *ti6 = (struct tcpipv6hdr *)ti;
125 #endif
126 
127 	if (tcp_debx == TCP_NDEBUG)
128 		tcp_debx = 0;
129 	td->td_time = iptime();
130 	td->td_act = act;
131 	td->td_ostate = ostate;
132 	td->td_tcb = (caddr_t)tp;
133 	if (tp)
134 		td->td_cb = *tp;
135 	else
136 		bzero((caddr_t)&td->td_cb, sizeof (*tp));
137 	switch (tp->pf) {
138 #ifdef INET6
139 	case PF_INET6:
140 		if (ti6) {
141 			th = &ti6->ti6_t;
142 			td->td_ti6 = *ti6;
143 			td->td_ti6.ti6_plen = len;
144 		} else
145 			bzero(&td->td_ti6, sizeof(struct tcpipv6hdr));
146 		break;
147 #endif /* INET6 */
148 	case PF_INET:
149 		if (ti) {
150 			th = &ti->ti_t;
151 			td->td_ti = *ti;
152 			td->td_ti.ti_len = len;
153 		} else
154 			bzero(&td->td_ti, sizeof(struct tcpiphdr));
155 		break;
156 	default:
157 		return;
158 	}
159 
160 	td->td_req = req;
161 #ifdef TCPDEBUG
162 	if (tcpconsdebug == 0)
163 		return;
164 	if (tp)
165 		printf("%x %s:", tp, tcpstates[ostate]);
166 	else
167 		printf("???????? ");
168 	printf("%s ", tanames[act]);
169 	switch (act) {
170 
171 	case TA_INPUT:
172 	case TA_OUTPUT:
173 	case TA_DROP:
174 		if (ti == 0)
175 			break;
176 		seq = th->th_seq;
177 		ack = th->th_ack;
178 		if (act == TA_OUTPUT) {
179 			seq = ntohl(seq);
180 			ack = ntohl(ack);
181 		}
182 		if (len)
183 			printf("[%x..%x)", seq, seq+len);
184 		else
185 			printf("%x", seq);
186 		printf("@%x, urp=%x", ack, th->th_urp);
187 		flags = th->th_flags;
188 		if (flags) {
189 			char *cp = "<";
190 #define pf(f) { if (th->th_flags&TH_##f) { printf("%s%s", cp, "f"); cp = ","; } }
191 			pf(SYN); pf(ACK); pf(FIN); pf(RST); pf(PUSH); pf(URG);
192 			printf(">");
193 		}
194 		break;
195 
196 	case TA_USER:
197 		printf("%s", prurequests[req&0xff]);
198 		if ((req & 0xff) == PRU_SLOWTIMO)
199 			printf("<%s>", tcptimers[req>>8]);
200 		break;
201 	}
202 	if (tp)
203 		printf(" -> %s", tcpstates[tp->t_state]);
204 	/* print out internal state of tp !?! */
205 	printf("\n");
206 	if (tp == 0)
207 		return;
208 	printf("\trcv_(nxt,wnd,up) (%x,%x,%x) snd_(una,nxt,max) (%x,%x,%x)\n",
209 	    tp->rcv_nxt, tp->rcv_wnd, tp->rcv_up, tp->snd_una, tp->snd_nxt,
210 	    tp->snd_max);
211 	printf("\tsnd_(wl1,wl2,wnd) (%x,%x,%x)\n",
212 	    tp->snd_wl1, tp->snd_wl2, tp->snd_wnd);
213 #endif /* TCPDEBUG */
214 }
215