xref: /dragonfly/usr.sbin/trpt/trpt.c (revision f8f04fe3)
1 /*
2  * Copyright (c) 1983, 1988, 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  * @(#) Copyright (c) 1983, 1988, 1993 The Regents of the University of California.  All rights reserved.
34  * @(#)trpt.c	8.1 (Berkeley) 6/6/93
35  * $FreeBSD: src/usr.sbin/trpt/trpt.c,v 1.12 2000/01/29 11:49:07 shin Exp $
36  * $DragonFly: src/usr.sbin/trpt/trpt.c,v 1.4 2004/03/21 22:41:24 cpressey Exp $
37  */
38 
39 #include <sys/param.h>
40 #include <sys/queue.h>
41 #include <sys/socket.h>
42 #include <sys/socketvar.h>
43 #define PRUREQUESTS
44 #include <sys/protosw.h>
45 #include <sys/file.h>
46 #include <sys/time.h>
47 
48 #include <net/route.h>
49 #include <net/if.h>
50 
51 #include <netinet/in.h>
52 #include <netinet/in_systm.h>
53 #include <netinet/ip.h>
54 #ifdef INET6
55 #include <netinet/ip6.h>
56 #endif
57 #include <netinet/ip_var.h>
58 #include <netinet/tcp.h>
59 #define TCPSTATES
60 #include <netinet/tcp_fsm.h>
61 #include <netinet/tcp_seq.h>
62 #define	TCPTIMERS
63 #include <netinet/tcp_timer.h>
64 #include <netinet/tcp_var.h>
65 #include <netinet/tcpip.h>
66 #define	TANAMES
67 #include <netinet/tcp_debug.h>
68 
69 #include <arpa/inet.h>
70 
71 #include <err.h>
72 #include <nlist.h>
73 #include <paths.h>
74 #include <stdio.h>
75 #include <stdlib.h>
76 #include <unistd.h>
77 
78 struct nlist nl[] = {
79 #define	N_TCP_DEBUG	0
80 	{ "_tcp_debug" },
81 #define	N_TCP_DEBX	1
82 	{ "_tcp_debx" },
83 	{ "" },
84 };
85 
86 static caddr_t tcp_pcbs[TCP_NDEBUG];
87 static n_time ntime;
88 static int aflag, kflag, memf, follow, sflag, tflag;
89 
90 void dotrace(caddr_t);
91 void klseek(int, off_t, int);
92 int numeric(caddr_t *, caddr_t *);
93 void tcp_trace(short, short, struct tcpcb *, struct tcpcb *,
94 			int, void *, struct tcphdr *, int);
95 static void usage(void);
96 
97 int
98 main(int argc, char **argv)
99 {
100 	int ch, i, jflag, npcbs;
101 	char *system, *core;
102 
103 	jflag = npcbs = 0;
104 	while ((ch = getopt(argc, argv, "afjp:st")) != -1)
105 		switch (ch) {
106 		case 'a':
107 			++aflag;
108 			break;
109 		case 'f':
110 			++follow;
111 			setlinebuf(stdout);
112 			break;
113 		case 'j':
114 			++jflag;
115 			break;
116 		case 'p':
117 			if (npcbs >= TCP_NDEBUG)
118 				errx(1, "too many pcb's specified");
119 			sscanf(optarg, "%x", (int *)&tcp_pcbs[npcbs++]);
120 			break;
121 		case 's':
122 			++sflag;
123 			break;
124 		case 't':
125 			++tflag;
126 			break;
127 		case '?':
128 		default:
129 			usage();
130 		}
131 	argc -= optind;
132 	argv += optind;
133 
134 	core = _PATH_KMEM;
135 	if (argc > 0) {
136 		system = *argv;
137 		argc--, argv++;
138 		if (argc > 0) {
139 			core = *argv;
140 			argc--, argv++;
141 			++kflag;
142 		}
143 		/*
144 		 * Discard setgid privileges if not the running kernel so that
145 		 * bad guys can't print interesting stuff from kernel memory.
146 		 */
147 		setgid(getgid());
148 	}
149 	else
150 		system = (char *)getbootfile();
151 
152 	if (nlist(system, nl) < 0 || !nl[0].n_value)
153 		errx(1, "%s: no namelist", system);
154 	if ((memf = open(core, O_RDONLY)) < 0)
155 		err(2, "%s", core);
156 	if (kflag)
157 		errx(1, "can't do core files yet");
158 	klseek(memf, (off_t)nl[N_TCP_DEBX].n_value, L_SET);
159 	if (read(memf, (char *)&tcp_debx, sizeof(tcp_debx)) !=
160 	    sizeof(tcp_debx))
161 		err(3, "tcp_debx");
162 	klseek(memf, (off_t)nl[N_TCP_DEBUG].n_value, L_SET);
163 	if (read(memf, (char *)tcp_debug, sizeof(tcp_debug)) !=
164 	    sizeof(tcp_debug))
165 		err(3, "tcp_debug");
166 	/*
167 	 * If no control blocks have been specified, figure
168 	 * out how many distinct one we have and summarize
169 	 * them in tcp_pcbs for sorting the trace records
170 	 * below.
171 	 */
172 	if (!npcbs) {
173 		for (i = 0; i < TCP_NDEBUG; i++) {
174 			struct tcp_debug *td = &tcp_debug[i];
175 			int j;
176 
177 			if (td->td_tcb == 0)
178 				continue;
179 			for (j = 0; j < npcbs; j++)
180 				if (tcp_pcbs[j] == td->td_tcb)
181 					break;
182 			if (j >= npcbs)
183 				tcp_pcbs[npcbs++] = td->td_tcb;
184 		}
185 		if (!npcbs)
186 			exit(0);
187 	}
188 	qsort(tcp_pcbs, npcbs, sizeof(caddr_t), numeric);
189 	if (jflag) {
190 		for (i = 0;;) {
191 			printf("%x", (int)tcp_pcbs[i]);
192 			if (++i == npcbs)
193 				break;
194 			fputs(", ", stdout);
195 		}
196 		putchar('\n');
197 	}
198 	else for (i = 0; i < npcbs; i++) {
199 		printf("\n%x:\n", (int)tcp_pcbs[i]);
200 		dotrace(tcp_pcbs[i]);
201 	}
202 	exit(0);
203 }
204 
205 static void
206 usage(void)
207 {
208 	fprintf(stderr,
209 	    "usage: trpt [-afjst] [-p hex-address] [system [core]]\n");
210 	exit(1);
211 }
212 
213 void
214 dotrace(caddr_t tcpcb)
215 {
216 	struct tcp_debug *td;
217 	int i;
218 	int prev_debx, family;
219 
220 	prev_debx = tcp_debx;
221 again:	if (--tcp_debx < 0)
222 		tcp_debx = TCP_NDEBUG - 1;
223 	for (i = prev_debx % TCP_NDEBUG; i < TCP_NDEBUG; i++) {
224 		td = &tcp_debug[i];
225 		if (tcpcb && td->td_tcb != tcpcb)
226 			continue;
227 		ntime = ntohl(td->td_time);
228 #ifdef INET6
229 		family = td->td_family;
230 #else
231 		family = AF_INET;
232 #endif
233 		switch(family) {
234 		case AF_INET:
235 			tcp_trace(td->td_act, td->td_ostate,
236 				  (struct tcpcb *)td->td_tcb,
237 				  &td->td_cb, td->td_family, &td->td_ti.ti_i,
238 				  &td->td_ti.ti_t, td->td_req);
239 			break;
240 #ifdef INET6
241 		case AF_INET6:
242 			tcp_trace(td->td_act, td->td_ostate,
243 				  (struct tcpcb *)td->td_tcb,
244 				  &td->td_cb, td->td_family, &td->td_ti6.ip6,
245 				  &td->td_ti6.th, td->td_req);
246 			break;
247 #endif
248 		}
249 		if (i == tcp_debx)
250 			goto done;
251 	}
252 	for (i = 0; i <= tcp_debx % TCP_NDEBUG; i++) {
253 		td = &tcp_debug[i];
254 		if (tcpcb && td->td_tcb != tcpcb)
255 			continue;
256 		ntime = ntohl(td->td_time);
257 #ifdef INET6
258 		family = td->td_family;
259 #else
260 		family = AF_INET;
261 #endif
262 		switch(family) {
263 		case AF_INET:
264 			tcp_trace(td->td_act, td->td_ostate,
265 				  (struct tcpcb *)td->td_tcb,
266 				  &td->td_cb, td->td_family, &td->td_ti.ti_i,
267 				  &td->td_ti.ti_t, td->td_req);
268 			break;
269 #ifdef INET6
270 		case AF_INET6:
271 			tcp_trace(td->td_act, td->td_ostate,
272 				  (struct tcpcb *)td->td_tcb,
273 				  &td->td_cb, td->td_family, &td->td_ti6.ip6,
274 				  &td->td_ti6.th, td->td_req);
275 			break;
276 #endif
277 		}
278 	}
279 done:	if (follow) {
280 		prev_debx = tcp_debx + 1;
281 		if (prev_debx >= TCP_NDEBUG)
282 			prev_debx = 0;
283 		do {
284 			sleep(1);
285 			klseek(memf, (off_t)nl[N_TCP_DEBX].n_value, L_SET);
286 			if (read(memf, (char *)&tcp_debx, sizeof(tcp_debx)) !=
287 			    sizeof(tcp_debx))
288 				err(3, "tcp_debx");
289 		} while (tcp_debx == prev_debx);
290 		klseek(memf, (off_t)nl[N_TCP_DEBUG].n_value, L_SET);
291 		if (read(memf, (char *)tcp_debug, sizeof(tcp_debug)) !=
292 		    sizeof(tcp_debug))
293 			err(3, "tcp_debug");
294 		goto again;
295 	}
296 }
297 
298 /*
299  * Tcp debug routines
300  */
301 /*ARGSUSED*/
302 void
303 tcp_trace(short act, short ostate, struct tcpcb *atp, struct tcpcb *tp,
304 	  int family, void *ip, struct tcphdr *th, int req)
305 {
306 	tcp_seq seq, ack;
307 	int flags, len, win, timer;
308 	struct ip *ip4;
309 #ifdef INET6
310 	int isipv6, nopkt = 1;
311 	struct ip6_hdr *ip6;
312 	char ntop_buf[INET6_ADDRSTRLEN];
313 #endif
314 
315 #ifdef INET6
316 	switch (family) {
317 	case AF_INET:
318 		nopkt = 0;
319 		isipv6 = 0;
320 		ip4 = (struct ip *)ip;
321 		break;
322 	case AF_INET6:
323 		nopkt = 0;
324 		isipv6 = 1;
325 		ip6 = (struct ip6_hdr *)ip;
326 	case 0:
327 	default:
328 		break;
329 	}
330 #else
331 	ip4 = (struct ip *)ip;
332 #endif
333 	printf("%03ld %s:%s ",(ntime/10) % 1000, tcpstates[ostate],
334 	    tanames[act]);
335 	switch (act) {
336 	case TA_INPUT:
337 	case TA_OUTPUT:
338 	case TA_DROP:
339 #ifdef INET6
340 		if (nopkt != 0)
341 			break;
342 #endif
343 		if (aflag) {
344 			printf("(src=%s,%u, ",
345 
346 #ifdef INET6
347 			       isipv6
348 			       ? inet_ntop(AF_INET6, &ip6->ip6_src, ntop_buf,
349 					   sizeof(ntop_buf)) :
350 #endif
351 			       inet_ntoa(ip4->ip_src),
352 			       ntohs(th->th_sport));
353 			printf("dst=%s,%u)",
354 #ifdef INET6
355 			       isipv6
356 			       ? inet_ntop(AF_INET6, &ip6->ip6_dst, ntop_buf,
357 					   sizeof(ntop_buf)) :
358 #endif
359 			       inet_ntoa(ip4->ip_dst),
360 			       ntohs(th->th_dport));
361 		}
362 		seq = th->th_seq;
363 		ack = th->th_ack;
364 
365 		len =
366 #ifdef INET6
367 			isipv6 ? ip6->ip6_plen :
368 #endif
369 			ip4->ip_len;
370 		win = th->th_win;
371 		if (act == TA_OUTPUT) {
372 			seq = ntohl(seq);
373 			ack = ntohl(ack);
374 			len = ntohs(len);
375 			win = ntohs(win);
376 		}
377 		if (act == TA_OUTPUT)
378 			len -= sizeof(struct tcphdr);
379 		if (len)
380 			printf("[%lx..%lx)", seq, seq + len);
381 		else
382 			printf("%lx", seq);
383 		printf("@%lx", ack);
384 		if (win)
385 			printf("(win=%x)", win);
386 		flags = th->th_flags;
387 		if (flags) {
388 			char *cp = "<";
389 
390 #define	pf(flag, string) {						\
391 	if (th->th_flags & flag) {					\
392 		printf("%s%s", cp, string);				\
393 		cp = ",";						\
394 	}								\
395 }
396 			pf(TH_SYN, "SYN");
397 			pf(TH_ACK, "ACK");
398 			pf(TH_FIN, "FIN");
399 			pf(TH_RST, "RST");
400 			pf(TH_PUSH, "PUSH");
401 			pf(TH_URG, "URG");
402 			printf(">");
403 		}
404 		break;
405 	case TA_USER:
406 		timer = req >> 8;
407 		req &= 0xff;
408 		printf("%s", prurequests[req]);
409 		if (req == PRU_SLOWTIMO || req == PRU_FASTTIMO)
410 			printf("<%s>", tcptimers[timer]);
411 		break;
412 	}
413 	printf(" -> %s", tcpstates[tp->t_state]);
414 	/* print out internal state of tp !?! */
415 	printf("\n");
416 	if (sflag) {
417 		printf("\trcv_nxt %lx rcv_wnd %x snd_una %lx snd_nxt %lx snd_max %lx\n",
418 		    tp->rcv_nxt, tp->rcv_wnd, tp->snd_una, tp->snd_nxt,
419 		    tp->snd_max);
420 		printf("\tsnd_wl1 %lx snd_wl2 %lx snd_wnd %x\n", tp->snd_wl1,
421 		    tp->snd_wl2, tp->snd_wnd);
422 	}
423 	/* print out timers? */
424 #if 0
425 	/*
426 	 * XXX
427 	 * kernel now uses callouts, not integer time values.
428 	 */
429 	if (tflag) {
430 		char *cp = "\t";
431 		int i;
432 
433 		for (i = 0; i < TCPT_NTIMERS; i++) {
434 			if (tp->t_timer[i] == 0)
435 				continue;
436 			printf("%s%s=%d", cp, tcptimers[i], tp->t_timer[i]);
437 			if (i == TCPT_REXMT)
438 				printf(" (t_rxtshft=%d)", tp->t_rxtshift);
439 			cp = ", ";
440 		}
441 		if (*cp != '\t')
442 			putchar('\n');
443 	}
444 #endif
445 }
446 
447 int
448 numeric(caddr_t *c1, caddr_t *c2)
449 {
450 	return(*c1 - *c2);
451 }
452 
453 void
454 klseek(int fd, off_t base, int off)
455 {
456 	lseek(fd, base, off);
457 }
458