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

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