[apple/xnu.git] / bsd / netinet / tcp.h

/*
 * Copyright (c) 2000-2004 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.h	8.1 (Berkeley) 6/10/93
 * $FreeBSD: src/sys/netinet/tcp.h,v 1.13.2.3 2001/03/01 22:08:42 jlemon Exp $
 */

#ifndef _NETINET_TCP_H_
#define _NETINET_TCP_H_
#include <sys/appleapiopts.h>
#include <sys/_types.h>
#include <machine/endian.h>

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
typedef	__uint32_t tcp_seq;
typedef __uint32_t tcp_cc;		/* connection count per rfc1644 */

#define tcp6_seq	tcp_seq	/* for KAME src sync over BSD*'s */
#define tcp6hdr		tcphdr	/* for KAME src sync over BSD*'s */

/*
 * TCP header.
 * Per RFC 793, September, 1981.
 */
struct tcphdr {
	unsigned short	th_sport;	/* source port */
	unsigned short	th_dport;	/* destination port */
	tcp_seq	th_seq;			/* sequence number */
	tcp_seq	th_ack;			/* acknowledgement number */
#if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN
	unsigned int	th_x2:4,	/* (unused) */
			th_off:4;	/* data offset */
#endif
#if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN
	unsigned int	th_off:4,	/* data offset */
			th_x2:4;	/* (unused) */
#endif
	unsigned char	th_flags;
#define	TH_FIN	0x01
#define	TH_SYN	0x02
#define	TH_RST	0x04
#define	TH_PUSH	0x08
#define	TH_ACK	0x10
#define	TH_URG	0x20
#define	TH_ECE	0x40
#define	TH_CWR	0x80
#define	TH_FLAGS	(TH_FIN|TH_SYN|TH_RST|TH_ACK|TH_URG|TH_ECE|TH_CWR)

	unsigned short	th_win;		/* window */
	unsigned short	th_sum;		/* checksum */
	unsigned short	th_urp;		/* urgent pointer */
};

#define	TCPOPT_EOL		0
#define	TCPOPT_NOP		1
#define	TCPOPT_MAXSEG		2
#define TCPOLEN_MAXSEG		4
#define TCPOPT_WINDOW		3
#define TCPOLEN_WINDOW		3
#define TCPOPT_SACK_PERMITTED	4		/* Experimental */
#define TCPOLEN_SACK_PERMITTED	2
#define TCPOPT_SACK		5		/* Experimental */
#define TCPOLEN_SACK		8		/* len of sack block */
#define TCPOPT_TIMESTAMP	8
#define TCPOLEN_TIMESTAMP	10
#define TCPOLEN_TSTAMP_APPA		(TCPOLEN_TIMESTAMP+2) /* appendix A */
#define TCPOPT_TSTAMP_HDR		\
    (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_TIMESTAMP<<8|TCPOLEN_TIMESTAMP)

#define	MAX_TCPOPTLEN		40	/* Absolute maximum TCP options len */

#define	TCPOPT_CC		11		/* CC options: RFC-1644 */
#define TCPOPT_CCNEW		12
#define TCPOPT_CCECHO		13
#define	   TCPOLEN_CC			6
#define	   TCPOLEN_CC_APPA		(TCPOLEN_CC+2)
#define	   TCPOPT_CC_HDR(ccopt)		\
    (TCPOPT_NOP<<24|TCPOPT_NOP<<16|(ccopt)<<8|TCPOLEN_CC)
#define	TCPOPT_SIGNATURE		19	/* Keyed MD5: RFC 2385 */
#define	   TCPOLEN_SIGNATURE		18

/* Option definitions */
#define TCPOPT_SACK_PERMIT_HDR	\
(TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_SACK_PERMITTED<<8|TCPOLEN_SACK_PERMITTED)
#define	TCPOPT_SACK_HDR		(TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_SACK<<8)
/* Miscellaneous constants */
#define	MAX_SACK_BLKS	6	/* Max # SACK blocks stored at sender side */
#define	TCP_MAX_SACK	3	/* MAX # SACKs sent in any segment */


/*
 * Default maximum segment size for TCP.
 * With an IP MTU of 576, this is 536,
 * but 512 is probably more convenient.
 * This should be defined as MIN(512, IP_MSS - sizeof (struct tcpiphdr)).
 */
#define	TCP_MSS	512

/*
 * TCP_MINMSS is defined to be 216 which is fine for the smallest
 * link MTU (256 bytes, SLIP interface) in the Internet.
 * However it is very unlikely to come across such low MTU interfaces
 * these days (anno dato 2004).
 * Probably it can be set to 512 without ill effects. But we play safe.
 * See tcp_subr.c tcp_minmss SYSCTL declaration for more comments.
 * Setting this to "0" disables the minmss check.
 */
#define	TCP_MINMSS 216

/*
 * TCP_MINMSSOVERLOAD is defined to be 1000 which should cover any type
 * of interactive TCP session.
 * See tcp_subr.c tcp_minmssoverload SYSCTL declaration and tcp_input.c
 * for more comments.
 * Setting this to "0" disables the minmssoverload check.
 */
#define	TCP_MINMSSOVERLOAD 1000

/*
 * Default maximum segment size for TCP6.
 * With an IP6 MSS of 1280, this is 1220,
 * but 1024 is probably more convenient. (xxx kazu in doubt)
 * This should be defined as MIN(1024, IP6_MSS - sizeof (struct tcpip6hdr))
 */
#define	TCP6_MSS	1024

#define	TCP_MAXWIN	65535	/* largest value for (unscaled) window */
#define	TTCP_CLIENT_SND_WND	4096	/* dflt send window for T/TCP client */

#define TCP_MAX_WINSHIFT	14	/* maximum window shift */

#define TCP_MAXBURST		4 	/* maximum segments in a burst */

#define TCP_MAXHLEN	(0xf<<2)	/* max length of header in bytes */
#define TCP_MAXOLEN	(TCP_MAXHLEN - sizeof(struct tcphdr))
					/* max space left for options */
#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */

/*
 * User-settable options (used with setsockopt).
 */
#define	TCP_NODELAY	0x01	/* don't delay send to coalesce packets */
#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
#define	TCP_MAXSEG	0x02	/* set maximum segment size */
#define TCP_NOPUSH	0x04	/* don't push last block of write */
#define TCP_NOOPT	0x08	/* don't use TCP options */
#define TCP_KEEPALIVE	0x10	/* idle time used when SO_KEEPALIVE is enabled */
#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */

#endif
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	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.
8f6c56a5	14	*
2d21ac55 A	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
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.
8f6c56a5	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.h 8.1 (Berkeley) 6/10/93
9bccf70c	61	* $FreeBSD: src/sys/netinet/tcp.h,v 1.13.2.3 2001/03/01 22:08:42 jlemon Exp $
1c79356b A	62	*/
	63
	64	#ifndef _NETINET_TCP_H_
	65	#define _NETINET_TCP_H_
9bccf70c	66	#include <sys/appleapiopts.h>
91447636 A	67	#include <sys/_types.h>
91447636 A	68	#include <machine/endian.h>
1c79356b	69
2d21ac55	70	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
91447636 A	71	typedef __uint32_t tcp_seq;
91447636 A	72	typedef __uint32_t tcp_cc; /* connection count per rfc1644 */
1c79356b A	73
	74	#define tcp6_seq tcp_seq /* for KAME src sync over BSD's /
	75	#define tcp6hdr tcphdr /* for KAME src sync over BSD's /
	76
	77	/*
	78	* TCP header.
	79	* Per RFC 793, September, 1981.
	80	*/
	81	struct tcphdr {
91447636 A	82	unsigned short th_sport; /* source port */
91447636 A	83	unsigned short th_dport; /* destination port */
1c79356b A	84	tcp_seq th_seq; /* sequence number */
1c79356b A	85	tcp_seq th_ack; /* acknowledgement number */
91447636 A	86	#if __DARWIN_BYTE_ORDER == __DARWIN_LITTLE_ENDIAN
	87	unsigned int th_x2:4, /* (unused) */
	88	th_off:4; /* data offset */
1c79356b	89	#endif
91447636 A	90	#if __DARWIN_BYTE_ORDER == __DARWIN_BIG_ENDIAN
	91	unsigned int th_off:4, /* data offset */
	92	th_x2:4; /* (unused) */
1c79356b	93	#endif
91447636	94	unsigned char th_flags;
1c79356b A	95	#define TH_FIN 0x01
	96	#define TH_SYN 0x02
	97	#define TH_RST 0x04
	98	#define TH_PUSH 0x08
	99	#define TH_ACK 0x10
	100	#define TH_URG 0x20
9bccf70c A	101	#define TH_ECE 0x40
	102	#define TH_CWR 0x80
	103	#define TH_FLAGS (TH_FIN\|TH_SYN\|TH_RST\|TH_ACK\|TH_URG\|TH_ECE\|TH_CWR)
1c79356b	104
91447636 A	105	unsigned short th_win; /* window */
	106	unsigned short th_sum; /* checksum */
	107	unsigned short th_urp; /* urgent pointer */
1c79356b A	108	};
	109
	110	#define TCPOPT_EOL 0
	111	#define TCPOPT_NOP 1
	112	#define TCPOPT_MAXSEG 2
8ad349bb	113	#define TCPOLEN_MAXSEG 4
1c79356b	114	#define TCPOPT_WINDOW 3
8ad349bb	115	#define TCPOLEN_WINDOW 3
1c79356b	116	#define TCPOPT_SACK_PERMITTED 4 /* Experimental */
2d21ac55	117	#define TCPOLEN_SACK_PERMITTED 2
1c79356b	118	#define TCPOPT_SACK 5 /* Experimental */
8ad349bb	119	#define TCPOLEN_SACK 8 /* len of sack block */
1c79356b	120	#define TCPOPT_TIMESTAMP 8
8ad349bb A	121	#define TCPOLEN_TIMESTAMP 10
	122	#define TCPOLEN_TSTAMP_APPA (TCPOLEN_TIMESTAMP+2) /* appendix A */
	123	#define TCPOPT_TSTAMP_HDR \
1c79356b A	124	(TCPOPT_NOP<<24\|TCPOPT_NOP<<16\|TCPOPT_TIMESTAMP<<8\|TCPOLEN_TIMESTAMP)
1c79356b A	125
8ad349bb A	126	#define MAX_TCPOPTLEN 40 /* Absolute maximum TCP options len */
8ad349bb A	127
1c79356b A	128	#define TCPOPT_CC 11 /* CC options: RFC-1644 */
	129	#define TCPOPT_CCNEW 12
	130	#define TCPOPT_CCECHO 13
	131	#define TCPOLEN_CC 6
	132	#define TCPOLEN_CC_APPA (TCPOLEN_CC+2)
	133	#define TCPOPT_CC_HDR(ccopt) \
	134	(TCPOPT_NOP<<24\|TCPOPT_NOP<<16\|(ccopt)<<8\|TCPOLEN_CC)
8ad349bb A	135	#define TCPOPT_SIGNATURE 19 /* Keyed MD5: RFC 2385 */
	136	#define TCPOLEN_SIGNATURE 18
	137
	138	/* Option definitions */
	139	#define TCPOPT_SACK_PERMIT_HDR \
	140	(TCPOPT_NOP<<24\|TCPOPT_NOP<<16\|TCPOPT_SACK_PERMITTED<<8\|TCPOLEN_SACK_PERMITTED)
	141	#define TCPOPT_SACK_HDR (TCPOPT_NOP<<24\|TCPOPT_NOP<<16\|TCPOPT_SACK<<8)
	142	/* Miscellaneous constants */
	143	#define MAX_SACK_BLKS 6 /* Max # SACK blocks stored at sender side */
	144	#define TCP_MAX_SACK 3 /* MAX # SACKs sent in any segment */
	145
1c79356b A	146
	147	/*
	148	* Default maximum segment size for TCP.
4a249263	149	* With an IP MTU of 576, this is 536,
1c79356b A	150	* but 512 is probably more convenient.
	151	* This should be defined as MIN(512, IP_MSS - sizeof (struct tcpiphdr)).
	152	*/
	153	#define TCP_MSS 512
	154
e5568f75 A	155	/*
	156	* TCP_MINMSS is defined to be 216 which is fine for the smallest
	157	* link MTU (256 bytes, SLIP interface) in the Internet.
	158	* However it is very unlikely to come across such low MTU interfaces
	159	* these days (anno dato 2004).
	160	* Probably it can be set to 512 without ill effects. But we play safe.
	161	* See tcp_subr.c tcp_minmss SYSCTL declaration for more comments.
	162	* Setting this to "0" disables the minmss check.
	163	*/
	164	#define TCP_MINMSS 216
	165
91447636 A	166	/*
	167	* TCP_MINMSSOVERLOAD is defined to be 1000 which should cover any type
	168	* of interactive TCP session.
	169	* See tcp_subr.c tcp_minmssoverload SYSCTL declaration and tcp_input.c
	170	* for more comments.
	171	* Setting this to "0" disables the minmssoverload check.
	172	*/
	173	#define TCP_MINMSSOVERLOAD 1000
	174
1c79356b A	175	/*
	176	* Default maximum segment size for TCP6.
	177	* With an IP6 MSS of 1280, this is 1220,
	178	* but 1024 is probably more convenient. (xxx kazu in doubt)
	179	* This should be defined as MIN(1024, IP6_MSS - sizeof (struct tcpip6hdr))
	180	*/
	181	#define TCP6_MSS 1024
	182
	183	#define TCP_MAXWIN 65535 /* largest value for (unscaled) window */
	184	#define TTCP_CLIENT_SND_WND 4096 /* dflt send window for T/TCP client */
	185
	186	#define TCP_MAX_WINSHIFT 14 /* maximum window shift */
	187
9bccf70c A	188	#define TCP_MAXBURST 4 /* maximum segments in a burst */
9bccf70c A	189
1c79356b A	190	#define TCP_MAXHLEN (0xf<<2) /* max length of header in bytes */
	191	#define TCP_MAXOLEN (TCP_MAXHLEN - sizeof(struct tcphdr))
	192	/* max space left for options */
2d21ac55	193	#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b A	194
	195	/*
	196	* User-settable options (used with setsockopt).
	197	*/
	198	#define TCP_NODELAY 0x01 /* don't delay send to coalesce packets */
2d21ac55 A	199	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
	200	#define TCP_MAXSEG 0x02 /* set maximum segment size */
	201	#define TCP_NOPUSH 0x04 /* don't push last block of write */
	202	#define TCP_NOOPT 0x08 /* don't use TCP options */
55e303ae	203	#define TCP_KEEPALIVE 0x10 /* idle time used when SO_KEEPALIVE is enabled */
2d21ac55	204	#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b A	205
1c79356b A	206	#endif