[apple/xnu.git] / bsd / netinet / tcp_debug.c

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1982, 1986, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)tcp_debug.c	8.1 (Berkeley) 6/10/93
 * $FreeBSD: src/sys/netinet/tcp_debug.c,v 1.16.2.1 2000/07/15 07:14:31 kris Exp $
 */


#ifndef INET
#error The option TCPDEBUG requires option INET.
#endif

#if TCPDEBUG
/* load symbolic names */
#define PRUREQUESTS
#define TCPSTATES
#define TCPTIMERS
#define TANAMES
#endif

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/protosw.h>
#include <sys/sysctl.h>
#include <sys/socket.h>

#include <netinet/in.h>
#include <netinet/in_systm.h>
#include <netinet/ip.h>
#include <netinet/ip6.h>
#include <netinet/ip_var.h>
#include <netinet/tcp.h>
#include <netinet/tcp_fsm.h>
#include <netinet/tcp_timer.h>
#include <netinet/tcp_var.h>
#include <netinet/tcpip.h>
#include <netinet/tcp_debug.h>

#if TCPDEBUG
__private_extern__ int  tcpconsdebug = 0;
SYSCTL_INT(_net_inet_tcp, OID_AUTO, tcpconsdebug, CTLFLAG_RW | CTLFLAG_LOCKED,
    &tcpconsdebug, 0, "Turn tcp debugging on or off");
#endif

static struct tcp_debug tcp_debug[TCP_NDEBUG];
static int      tcp_debx;

/*
 * Tcp debug routines
 */
void
tcp_trace(act, ostate, tp, ipgen, th, req)
short act, ostate;
struct tcpcb *tp;
void *ipgen;
struct tcphdr *th;
int req;
{
	int isipv6;
	tcp_seq seq, ack;
	int len, flags;
	struct tcp_debug *td = &tcp_debug[tcp_debx++];

	isipv6 = (ipgen != NULL && ((struct ip *)ipgen)->ip_v == 6) ? 1 : 0;
	td->td_family = (isipv6 != 0) ? AF_INET6 : AF_INET;
	if (tcp_debx == TCP_NDEBUG) {
		tcp_debx = 0;
	}
	td->td_time = iptime();
	td->td_act = act;
	td->td_ostate = ostate;
	td->td_tcb = (caddr_t)tp;
	if (tp) {
		td->td_cb = *tp;
	} else {
		bzero((caddr_t)&td->td_cb, sizeof(*tp));
	}
	if (ipgen) {
		switch (td->td_family) {
		case AF_INET:
			bcopy((caddr_t)ipgen, (caddr_t)&td->td_ti.ti_i,
			    sizeof(td->td_ti.ti_i));
			bzero((caddr_t)td->td_ip6buf, sizeof(td->td_ip6buf));
			break;
		case AF_INET6:
			bcopy((caddr_t)ipgen, (caddr_t)td->td_ip6buf,
			    sizeof(td->td_ip6buf));
			bzero((caddr_t)&td->td_ti.ti_i,
			    sizeof(td->td_ti.ti_i));
			break;
		default:
			bzero((caddr_t)td->td_ip6buf, sizeof(td->td_ip6buf));
			bzero((caddr_t)&td->td_ti.ti_i,
			    sizeof(td->td_ti.ti_i));
			break;
		}
	} else {
		bzero((caddr_t)&td->td_ti.ti_i, sizeof(td->td_ti.ti_i));
		bzero((caddr_t)td->td_ip6buf, sizeof(td->td_ip6buf));
	}
	if (th) {
		switch (td->td_family) {
		case AF_INET:
			td->td_ti.ti_t = *th;
			bzero((caddr_t)&td->td_ti6.th, sizeof(td->td_ti6.th));
			break;
		case AF_INET6:
			td->td_ti6.th = *th;
			bzero((caddr_t)&td->td_ti.ti_t,
			    sizeof(td->td_ti.ti_t));
			break;
		default:
			bzero((caddr_t)&td->td_ti.ti_t,
			    sizeof(td->td_ti.ti_t));
			bzero((caddr_t)&td->td_ti6.th, sizeof(td->td_ti6.th));
			break;
		}
	} else {
		bzero((caddr_t)&td->td_ti.ti_t, sizeof(td->td_ti.ti_t));
		bzero((caddr_t)&td->td_ti6.th, sizeof(td->td_ti6.th));
	}
	td->td_req = req;
#if TCPDEBUG
	if (tcpconsdebug == 0) {
		return;
	}
	if (tp) {
		printf("%x %s:", tp, tcpstates[ostate]);
	} else {
		printf("???????? ");
	}
	printf("%s ", tanames[act]);
	switch (act) {
	case TA_INPUT:
	case TA_OUTPUT:
	case TA_DROP:
		if (ipgen == NULL || th == NULL) {
			break;
		}
		seq = th->th_seq;
		ack = th->th_ack;
		len = isipv6 ? ((struct ip6_hdr *)ipgen)->ip6_plen : ((struct ip *)ipgen)->ip_len;
		if (act == TA_OUTPUT) {
			seq = ntohl(seq);
			ack = ntohl(ack);
			len = ntohs((u_short)len);
		}
		if (act == TA_OUTPUT) {
			len -= sizeof(struct tcphdr);
		}
		if (len) {
			printf("[%x..%x)", seq, seq + len);
		} else {
			printf("%x", seq);
		}
		printf("@%x, urp=%x", ack, th->th_urp);
		flags = th->th_flags;
		if (flags) {
			char *cp = "<";
#define pf(f) {                                 \
	if (th->th_flags & TH_##f) {            \
	        printf("%s%s", cp, #f);         \
	        cp = ",";                       \
	}                                       \
}
			pf(SYN); pf(ACK); pf(FIN); pf(RST); pf(PUSH); pf(URG);
			printf(">");
		}
		break;

	case TA_USER:
		printf("%s", prurequests[req & 0xff]);
		if ((req & 0xff) == PRU_SLOWTIMO) {
			printf("<%s>", tcptimers[req >> 8]);
		}
		break;
	}
	if (tp) {
		printf(" -> %s", tcpstates[tp->t_state]);
	}
	/* print out internal state of tp !?! */
	printf("\n");
	if (tp == 0) {
		return;
	}
	printf(
		"\trcv_(nxt,wnd,up) (%lx,%lx,%lx) snd_(una,nxt,max) (%lx,%lx,%lx)\n",
		(uint32_t)tp->rcv_nxt, tp->rcv_wnd, (uint32_t)tp->rcv_up,
		(uint32_t)tp->snd_una, (uint32_t)tp->snd_nxt, (uint32_t)tp->snd_max);
	printf("\tsnd_(wl1,wl2,wnd) (%lx,%lx,%lx)\n",
	    (uint32_t)tp->snd_wl1, (uint32_t)tp->snd_wl2, tp->snd_wnd);
#endif /* TCPDEBUG */
}
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
0a7de745	5	*
2d21ac55 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
0a7de745	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
2d21ac55 A	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
0a7de745	17	*
2d21ac55 A	18	* The Original Code and all software distributed under the License are
2d21ac55 A	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
0a7de745	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* Copyright (c) 1982, 1986, 1993
	30	* The Regents of the University of California. All rights reserved.
	31	*
	32	* Redistribution and use in source and binary forms, with or without
	33	* modification, are permitted provided that the following conditions
	34	* are met:
	35	* 1. Redistributions of source code must retain the above copyright
	36	* notice, this list of conditions and the following disclaimer.
	37	* 2. Redistributions in binary form must reproduce the above copyright
	38	* notice, this list of conditions and the following disclaimer in the
	39	* documentation and/or other materials provided with the distribution.
	40	* 3. All advertising materials mentioning features or use of this software
	41	* must display the following acknowledgement:
	42	* This product includes software developed by the University of
	43	* California, Berkeley and its contributors.
	44	* 4. Neither the name of the University nor the names of its contributors
	45	* may be used to endorse or promote products derived from this software
	46	* without specific prior written permission.
	47	*
	48	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	49	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	50	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	51	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	52	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	53	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	54	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	55	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	56	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	57	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	58	* SUCH DAMAGE.
	59	*
	60	* @(#)tcp_debug.c 8.1 (Berkeley) 6/10/93
9bccf70c	61	* $FreeBSD: src/sys/netinet/tcp_debug.c,v 1.16.2.1 2000/07/15 07:14:31 kris Exp $
1c79356b A	62	*/
1c79356b A	63
1c79356b A	64
	65	#ifndef INET
	66	#error The option TCPDEBUG requires option INET.
	67	#endif
	68
	69	#if TCPDEBUG
	70	/* load symbolic names */
	71	#define PRUREQUESTS
	72	#define TCPSTATES
0a7de745 A	73	#define TCPTIMERS
0a7de745 A	74	#define TANAMES
1c79356b A	75	#endif
	76
	77	#include <sys/param.h>
	78	#include <sys/systm.h>
	79	#include <sys/protosw.h>
9bccf70c	80	#include <sys/sysctl.h>
55e303ae	81	#include <sys/socket.h>
1c79356b A	82
	83	#include <netinet/in.h>
	84	#include <netinet/in_systm.h>
	85	#include <netinet/ip.h>
	86	#include <netinet/ip6.h>
	87	#include <netinet/ip_var.h>
	88	#include <netinet/tcp.h>
	89	#include <netinet/tcp_fsm.h>
	90	#include <netinet/tcp_timer.h>
	91	#include <netinet/tcp_var.h>
	92	#include <netinet/tcpip.h>
	93	#include <netinet/tcp_debug.h>
	94
	95	#if TCPDEBUG
0a7de745	96	__private_extern__ int tcpconsdebug = 0;
6d2010ae	97	SYSCTL_INT(_net_inet_tcp, OID_AUTO, tcpconsdebug, CTLFLAG_RW \| CTLFLAG_LOCKED,
55e303ae	98	&tcpconsdebug, 0, "Turn tcp debugging on or off");
1c79356b A	99	#endif
	100
	101	static struct tcp_debug tcp_debug[TCP_NDEBUG];
0a7de745	102	static int tcp_debx;
1c79356b A	103
	104	/*
	105	* Tcp debug routines
	106	*/
	107	void
9bccf70c	108	tcp_trace(act, ostate, tp, ipgen, th, req)
0a7de745 A	109	short act, ostate;
	110	struct tcpcb *tp;
	111	void *ipgen;
	112	struct tcphdr *th;
	113	int req;
1c79356b	114	{
9bccf70c	115	int isipv6;
1c79356b A	116	tcp_seq seq, ack;
	117	int len, flags;
	118	struct tcp_debug *td = &tcp_debug[tcp_debx++];
	119
9bccf70c	120	isipv6 = (ipgen != NULL && ((struct ip *)ipgen)->ip_v == 6) ? 1 : 0;
f427ee49	121	td->td_family = (isipv6 != 0) ? AF_INET6 : AF_INET;
0a7de745	122	if (tcp_debx == TCP_NDEBUG) {
1c79356b	123	tcp_debx = 0;
0a7de745	124	}
1c79356b A	125	td->td_time = iptime();
	126	td->td_act = act;
	127	td->td_ostate = ostate;
	128	td->td_tcb = (caddr_t)tp;
0a7de745	129	if (tp) {
1c79356b	130	td->td_cb = *tp;
0a7de745 A	131	} else {
	132	bzero((caddr_t)&td->td_cb, sizeof(*tp));
	133	}
9bccf70c A	134	if (ipgen) {
	135	switch (td->td_family) {
	136	case AF_INET:
	137	bcopy((caddr_t)ipgen, (caddr_t)&td->td_ti.ti_i,
0a7de745	138	sizeof(td->td_ti.ti_i));
9bccf70c A	139	bzero((caddr_t)td->td_ip6buf, sizeof(td->td_ip6buf));
9bccf70c A	140	break;
9bccf70c A	141	case AF_INET6:
9bccf70c A	142	bcopy((caddr_t)ipgen, (caddr_t)td->td_ip6buf,
0a7de745	143	sizeof(td->td_ip6buf));
9bccf70c	144	bzero((caddr_t)&td->td_ti.ti_i,
0a7de745	145	sizeof(td->td_ti.ti_i));
9bccf70c	146	break;
9bccf70c A	147	default:
	148	bzero((caddr_t)td->td_ip6buf, sizeof(td->td_ip6buf));
	149	bzero((caddr_t)&td->td_ti.ti_i,
0a7de745	150	sizeof(td->td_ti.ti_i));
9bccf70c A	151	break;
	152	}
	153	} else {
	154	bzero((caddr_t)&td->td_ti.ti_i, sizeof(td->td_ti.ti_i));
	155	bzero((caddr_t)td->td_ip6buf, sizeof(td->td_ip6buf));
	156	}
	157	if (th) {
	158	switch (td->td_family) {
	159	case AF_INET:
	160	td->td_ti.ti_t = *th;
	161	bzero((caddr_t)&td->td_ti6.th, sizeof(td->td_ti6.th));
	162	break;
9bccf70c A	163	case AF_INET6:
	164	td->td_ti6.th = *th;
	165	bzero((caddr_t)&td->td_ti.ti_t,
0a7de745	166	sizeof(td->td_ti.ti_t));
9bccf70c	167	break;
9bccf70c A	168	default:
9bccf70c A	169	bzero((caddr_t)&td->td_ti.ti_t,
0a7de745	170	sizeof(td->td_ti.ti_t));
9bccf70c A	171	bzero((caddr_t)&td->td_ti6.th, sizeof(td->td_ti6.th));
	172	break;
	173	}
	174	} else {
	175	bzero((caddr_t)&td->td_ti.ti_t, sizeof(td->td_ti.ti_t));
	176	bzero((caddr_t)&td->td_ti6.th, sizeof(td->td_ti6.th));
	177	}
1c79356b A	178	td->td_req = req;
1c79356b A	179	#if TCPDEBUG
0a7de745	180	if (tcpconsdebug == 0) {
1c79356b	181	return;
0a7de745 A	182	}
0a7de745 A	183	if (tp) {
55e303ae	184	printf("%x %s:", tp, tcpstates[ostate]);
0a7de745	185	} else {
1c79356b	186	printf("???????? ");
0a7de745	187	}
1c79356b A	188	printf("%s ", tanames[act]);
1c79356b A	189	switch (act) {
1c79356b A	190	case TA_INPUT:
	191	case TA_OUTPUT:
	192	case TA_DROP:
0a7de745	193	if (ipgen == NULL \|\| th == NULL) {
1c79356b	194	break;
0a7de745	195	}
1c79356b A	196	seq = th->th_seq;
1c79356b A	197	ack = th->th_ack;
f427ee49	198	len = isipv6 ? ((struct ip6_hdr )ipgen)->ip6_plen : ((struct ip )ipgen)->ip_len;
1c79356b A	199	if (act == TA_OUTPUT) {
	200	seq = ntohl(seq);
	201	ack = ntohl(ack);
	202	len = ntohs((u_short)len);
	203	}
0a7de745 A	204	if (act == TA_OUTPUT) {
	205	len -= sizeof(struct tcphdr);
	206	}
	207	if (len) {
	208	printf("[%x..%x)", seq, seq + len);
	209	} else {
1c79356b	210	printf("%x", seq);
0a7de745	211	}
1c79356b A	212	printf("@%x, urp=%x", ack, th->th_urp);
	213	flags = th->th_flags;
	214	if (flags) {
	215	char *cp = "<";
0a7de745 A	216	#define pf(f) { \
	217	if (th->th_flags & TH_##f) { \
	218	printf("%s%s", cp, #f); \
	219	cp = ","; \
	220	} \
1c79356b A	221	}
	222	pf(SYN); pf(ACK); pf(FIN); pf(RST); pf(PUSH); pf(URG);
	223	printf(">");
	224	}
	225	break;
	226
	227	case TA_USER:
0a7de745 A	228	printf("%s", prurequests[req & 0xff]);
	229	if ((req & 0xff) == PRU_SLOWTIMO) {
	230	printf("<%s>", tcptimers[req >> 8]);
	231	}
1c79356b A	232	break;
1c79356b A	233	}
0a7de745	234	if (tp) {
1c79356b	235	printf(" -> %s", tcpstates[tp->t_state]);
0a7de745	236	}
1c79356b A	237	/* print out internal state of tp !?! */
1c79356b A	238	printf("\n");
0a7de745	239	if (tp == 0) {
1c79356b	240	return;
0a7de745	241	}
1c79356b	242	printf(
0a7de745 A	243	"\trcv_(nxt,wnd,up) (%lx,%lx,%lx) snd_(una,nxt,max) (%lx,%lx,%lx)\n",
	244	(uint32_t)tp->rcv_nxt, tp->rcv_wnd, (uint32_t)tp->rcv_up,
	245	(uint32_t)tp->snd_una, (uint32_t)tp->snd_nxt, (uint32_t)tp->snd_max);
1c79356b	246	printf("\tsnd_(wl1,wl2,wnd) (%lx,%lx,%lx)\n",
b0d623f7	247	(uint32_t)tp->snd_wl1, (uint32_t)tp->snd_wl2, tp->snd_wnd);
1c79356b A	248	#endif /* TCPDEBUG */
1c79356b A	249	}