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

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * 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. 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_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 <netinet/in.h>
#include <netinet/in_systm.h>
#include <netinet/ip.h>
#if INET6
#include <netinet/ip6.h>
#endif
#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
static int	tcpconsdebug = 0;
#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;
{
#if INET6
	int isipv6;
#endif /* INET6 */
	tcp_seq seq, ack;
	int len, flags;
	struct tcp_debug *td = &tcp_debug[tcp_debx++];

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