[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>
#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
__private_extern__ int	tcpconsdebug = 0;
SYSCTL_INT(_net_inet_tcp, OID_AUTO, tcpconsdebug, CTLFLAG_RW, 
    &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;
{
#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("%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 =
#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	1	/*
5d5c5d0d A	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
8f6c56a5	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
8f6c56a5 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.
	14	*
	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
8ad349bb	24	* limitations under the License.
8f6c56a5 A	25	*
8f6c56a5 A	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
	73	#define TCPTIMERS
	74	#define TANAMES
	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>
9bccf70c	86	#if INET6
1c79356b	87	#include <netinet/ip6.h>
9bccf70c	88	#endif
1c79356b A	89	#include <netinet/ip_var.h>
	90	#include <netinet/tcp.h>
	91	#include <netinet/tcp_fsm.h>
	92	#include <netinet/tcp_timer.h>
	93	#include <netinet/tcp_var.h>
	94	#include <netinet/tcpip.h>
	95	#include <netinet/tcp_debug.h>
	96
	97	#if TCPDEBUG
55e303ae A	98	__private_extern__ int tcpconsdebug = 0;
	99	SYSCTL_INT(_net_inet_tcp, OID_AUTO, tcpconsdebug, CTLFLAG_RW,
	100	&tcpconsdebug, 0, "Turn tcp debugging on or off");
1c79356b A	101	#endif
	102
	103	static struct tcp_debug tcp_debug[TCP_NDEBUG];
	104	static int tcp_debx;
	105
	106	/*
	107	* Tcp debug routines
	108	*/
	109	void
9bccf70c	110	tcp_trace(act, ostate, tp, ipgen, th, req)
1c79356b A	111	short act, ostate;
1c79356b A	112	struct tcpcb *tp;
9bccf70c	113	void *ipgen;
1c79356b A	114	struct tcphdr *th;
	115	int req;
	116	{
	117	#if INET6
9bccf70c	118	int isipv6;
1c79356b A	119	#endif /* INET6 */
	120	tcp_seq seq, ack;
	121	int len, flags;
	122	struct tcp_debug *td = &tcp_debug[tcp_debx++];
	123
9bccf70c A	124	#if INET6
	125	isipv6 = (ipgen != NULL && ((struct ip *)ipgen)->ip_v == 6) ? 1 : 0;
	126	#endif /* INET6 */
	127	td->td_family =
	128	#if INET6
	129	(isipv6 != 0) ? AF_INET6 :
	130	#endif
	131	AF_INET;
1c79356b A	132	if (tcp_debx == TCP_NDEBUG)
	133	tcp_debx = 0;
	134	td->td_time = iptime();
	135	td->td_act = act;
	136	td->td_ostate = ostate;
	137	td->td_tcb = (caddr_t)tp;
	138	if (tp)
	139	td->td_cb = *tp;
	140	else
	141	bzero((caddr_t)&td->td_cb, sizeof (*tp));
9bccf70c A	142	if (ipgen) {
	143	switch (td->td_family) {
	144	case AF_INET:
	145	bcopy((caddr_t)ipgen, (caddr_t)&td->td_ti.ti_i,
	146	sizeof(td->td_ti.ti_i));
	147	bzero((caddr_t)td->td_ip6buf, sizeof(td->td_ip6buf));
	148	break;
1c79356b	149	#if INET6
9bccf70c A	150	case AF_INET6:
	151	bcopy((caddr_t)ipgen, (caddr_t)td->td_ip6buf,
	152	sizeof(td->td_ip6buf));
	153	bzero((caddr_t)&td->td_ti.ti_i,
	154	sizeof(td->td_ti.ti_i));
	155	break;
	156	#endif
	157	default:
	158	bzero((caddr_t)td->td_ip6buf, sizeof(td->td_ip6buf));
	159	bzero((caddr_t)&td->td_ti.ti_i,
	160	sizeof(td->td_ti.ti_i));
	161	break;
	162	}
	163	} else {
	164	bzero((caddr_t)&td->td_ti.ti_i, sizeof(td->td_ti.ti_i));
	165	bzero((caddr_t)td->td_ip6buf, sizeof(td->td_ip6buf));
	166	}
	167	if (th) {
	168	switch (td->td_family) {
	169	case AF_INET:
	170	td->td_ti.ti_t = *th;
	171	bzero((caddr_t)&td->td_ti6.th, sizeof(td->td_ti6.th));
	172	break;
1c79356b	173	#if INET6
9bccf70c A	174	case AF_INET6:
	175	td->td_ti6.th = *th;
	176	bzero((caddr_t)&td->td_ti.ti_t,
	177	sizeof(td->td_ti.ti_t));
	178	break;
	179	#endif
	180	default:
	181	bzero((caddr_t)&td->td_ti.ti_t,
	182	sizeof(td->td_ti.ti_t));
	183	bzero((caddr_t)&td->td_ti6.th, sizeof(td->td_ti6.th));
	184	break;
	185	}
	186	} else {
	187	bzero((caddr_t)&td->td_ti.ti_t, sizeof(td->td_ti.ti_t));
	188	bzero((caddr_t)&td->td_ti6.th, sizeof(td->td_ti6.th));
	189	}
1c79356b A	190	td->td_req = req;
	191	#if TCPDEBUG
	192	if (tcpconsdebug == 0)
	193	return;
	194	if (tp)
55e303ae	195	printf("%x %s:", tp, tcpstates[ostate]);
1c79356b A	196	else
	197	printf("???????? ");
	198	printf("%s ", tanames[act]);
	199	switch (act) {
	200
	201	case TA_INPUT:
	202	case TA_OUTPUT:
	203	case TA_DROP:
9bccf70c	204	if (ipgen == NULL \|\| th == NULL)
1c79356b	205	break;
1c79356b A	206	seq = th->th_seq;
1c79356b A	207	ack = th->th_ack;
9bccf70c A	208	len =
	209	#if INET6
	210	isipv6 ? ((struct ip6_hdr *)ipgen)->ip6_plen :
	211	#endif
	212	((struct ip *)ipgen)->ip_len;
1c79356b A	213	if (act == TA_OUTPUT) {
	214	seq = ntohl(seq);
	215	ack = ntohl(ack);
	216	len = ntohs((u_short)len);
	217	}
	218	if (act == TA_OUTPUT)
	219	len -= sizeof (struct tcphdr);
	220	if (len)
	221	printf("[%x..%x)", seq, seq+len);
	222	else
	223	printf("%x", seq);
	224	printf("@%x, urp=%x", ack, th->th_urp);
	225	flags = th->th_flags;
	226	if (flags) {
	227	char *cp = "<";
	228	#define pf(f) { \
	229	if (th->th_flags & TH_##f) { \
	230	printf("%s%s", cp, #f); \
	231	cp = ","; \
	232	} \
	233	}
	234	pf(SYN); pf(ACK); pf(FIN); pf(RST); pf(PUSH); pf(URG);
	235	printf(">");
	236	}
	237	break;
	238
	239	case TA_USER:
	240	printf("%s", prurequests[req&0xff]);
	241	if ((req & 0xff) == PRU_SLOWTIMO)
	242	printf("<%s>", tcptimers[req>>8]);
	243	break;
	244	}
	245	if (tp)
	246	printf(" -> %s", tcpstates[tp->t_state]);
	247	/* print out internal state of tp !?! */
	248	printf("\n");
	249	if (tp == 0)
	250	return;
	251	printf(
	252	"\trcv_(nxt,wnd,up) (%lx,%lx,%lx) snd_(una,nxt,max) (%lx,%lx,%lx)\n",
	253	(u_long)tp->rcv_nxt, tp->rcv_wnd, (u_long)tp->rcv_up,
	254	(u_long)tp->snd_una, (u_long)tp->snd_nxt, (u_long)tp->snd_max);
	255	printf("\tsnd_(wl1,wl2,wnd) (%lx,%lx,%lx)\n",
	256	(u_long)tp->snd_wl1, (u_long)tp->snd_wl2, tp->snd_wnd);
	257	#endif /* TCPDEBUG */
	258	}