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

/*
 * Copyright (c) 2000-2014 Apple 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
#if MPTCP
#define	TCPOPT_MULTIPATH  		30
#endif

/* 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 */

/*
 * A SACK option that specifies n blocks will have a length of (8*n + 2)
 * bytes, so the 40 bytes available for TCP options can specify a
 * maximum of 4 blocks.
 */

#define	TCP_MAX_SACK	4	/* 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

/*
 * 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_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 */
#define TCP_CONNECTIONTIMEOUT   0x20    /* connection timeout */
#define PERSIST_TIMEOUT		0x40	/* time after which a connection in
					 *  persist timeout will terminate.
					 *  see draft-ananth-tcpm-persist-02.txt
					 */
#define TCP_RXT_CONNDROPTIME	0x80	/* time after which tcp retransmissions will be 
					 * stopped and the connection will be dropped
					 */
#define TCP_RXT_FINDROP		0x100	/* when this option is set, drop a connection 
					 * after retransmitting the FIN 3 times. It will
					 * prevent holding too many mbufs in socket 
					 * buffer queues.
					 */
#define	TCP_KEEPINTVL		0x101	/* interval between keepalives */
#define	TCP_KEEPCNT		0x102	/* number of keepalives before close */
#define	TCP_SENDMOREACKS	0x103	/* always ack every other packet */
#define	TCP_ENABLE_ECN		0x104	/* Enable ECN on a connection */

#ifdef PRIVATE
#define	TCP_INFO		0x200	/* retrieve tcp_info structure */
#define TCP_MEASURE_SND_BW	0x202	/* Measure sender's bandwidth for this connection */
#endif /* PRIVATE */


#define	TCP_NOTSENT_LOWAT	0x201	/* Low water mark for TCP unsent data */

#ifdef PRIVATE
#define TCP_MEASURE_BW_BURST	0x203	/* Burst size to use for bandwidth measurement */
#define TCP_PEER_PID		0x204	/* Lookup pid of the process we're connected to */
#define TCP_ADAPTIVE_READ_TIMEOUT	0x205	/* Read timeout used as a multiple of RTT */	
/*
 * Enable message delivery on a socket, this feature is currently unsupported and
 * is subjected to change in future.
 */
#define	TCP_ENABLE_MSGS 0x206
#define	TCP_ADAPTIVE_WRITE_TIMEOUT	0x207	/* Write timeout used as a multiple of RTT */
#define	TCP_NOTIMEWAIT		0x208	/* Avoid going into time-wait */
#define	TCP_DISABLE_BLACKHOLE_DETECTION	0x209	/* disable PMTU blackhole detection */

/*
 * The TCP_INFO socket option is a private API and is subject to change
 */
#pragma pack(4)

#define	TCPI_OPT_TIMESTAMPS	0x01
#define	TCPI_OPT_SACK		0x02
#define	TCPI_OPT_WSCALE		0x04
#define	TCPI_OPT_ECN		0x08

#define TCPI_FLAG_LOSSRECOVERY	0x01	/* Currently in loss recovery */

/*
 * Add new fields to this structure at the end only. This will preserve
 * binary compatibility.
 */
struct tcp_info {
	u_int8_t	tcpi_state;			/* TCP FSM state. */
	u_int8_t	tcpi_options;		/* Options enabled on conn. */
	u_int8_t	tcpi_snd_wscale;	/* RFC1323 send shift value. */
	u_int8_t	tcpi_rcv_wscale;	/* RFC1323 recv shift value. */

	u_int32_t	tcpi_flags;			/* extra flags (TCPI_FLAG_xxx) */

	u_int32_t	tcpi_rto;			/* Retransmission timeout in milliseconds */
	u_int32_t	tcpi_snd_mss;		/* Max segment size for send. */
	u_int32_t	tcpi_rcv_mss;		/* Max segment size for receive. */

	u_int32_t	tcpi_rttcur;		/* Most recent value of RTT */
	u_int32_t	tcpi_srtt;			/* Smoothed RTT */
	u_int32_t	tcpi_rttvar;		/* RTT variance */
	u_int32_t	tcpi_rttbest;		/* Best RTT we've seen */

	u_int32_t	tcpi_snd_ssthresh;	/* Slow start threshold. */
	u_int32_t	tcpi_snd_cwnd;		/* Send congestion window. */

	u_int32_t	tcpi_rcv_space;		/* Advertised recv window. */

	u_int32_t	tcpi_snd_wnd;		/* Advertised send window. */
	u_int32_t	tcpi_snd_nxt;		/* Next egress seqno */
	u_int32_t	tcpi_rcv_nxt;		/* Next ingress seqno */
	
	int32_t		tcpi_last_outif;	/* if_index of interface used to send last */
	u_int32_t	tcpi_snd_sbbytes;	/* bytes in snd buffer including data inflight */
	
	u_int64_t	tcpi_txpackets __attribute__((aligned(8)));	/* total packets sent */
	u_int64_t	tcpi_txbytes __attribute__((aligned(8)));
									/* total bytes sent */	
	u_int64_t	tcpi_txretransmitbytes __attribute__((aligned(8)));
									/* total bytes retransmitted */	
	u_int64_t	tcpi_txunacked __attribute__((aligned(8)));
									/* current number of bytes not acknowledged */	
	u_int64_t	tcpi_rxpackets __attribute__((aligned(8)));	/* total packets received */
	u_int64_t	tcpi_rxbytes __attribute__((aligned(8)));
									/* total bytes received */
	u_int64_t	tcpi_rxduplicatebytes __attribute__((aligned(8)));
									/* total duplicate bytes received */
	u_int64_t	tcpi_rxoutoforderbytes __attribute__((aligned(8)));
									/* total out of order bytes received */
	u_int64_t	tcpi_snd_bw __attribute__((aligned(8)));	/* measured send bandwidth in bits/sec */
	u_int8_t	tcpi_synrexmits;	/* Number of syn retransmits before connect */
	u_int8_t	tcpi_unused1;
	u_int16_t	tcpi_unused2;
	u_int64_t	tcpi_cell_rxpackets __attribute((aligned(8)));	/* packets received over cellular */
	u_int64_t	tcpi_cell_rxbytes __attribute((aligned(8)));	/* bytes received over cellular */
	u_int64_t	tcpi_cell_txpackets __attribute((aligned(8)));	/* packets transmitted over cellular */
	u_int64_t	tcpi_cell_txbytes __attribute((aligned(8)));	/* bytes transmitted over cellular */
	u_int64_t	tcpi_wifi_rxpackets __attribute((aligned(8)));	/* packets received over Wi-Fi */
	u_int64_t	tcpi_wifi_rxbytes __attribute((aligned(8)));	/* bytes received over Wi-Fi */
	u_int64_t	tcpi_wifi_txpackets __attribute((aligned(8)));	/* packets transmitted over Wi-Fi */
	u_int64_t	tcpi_wifi_txbytes __attribute((aligned(8)));	/* bytes transmitted over Wi-Fi */
	u_int64_t	tcpi_wired_rxpackets __attribute((aligned(8)));	/* packets received over Wired */
	u_int64_t	tcpi_wired_rxbytes __attribute((aligned(8)));	/* bytes received over Wired */
	u_int64_t	tcpi_wired_txpackets __attribute((aligned(8)));	/* packets transmitted over Wired */
	u_int64_t	tcpi_wired_txbytes __attribute((aligned(8)));	/* bytes transmitted over Wired */
};

struct tcp_measure_bw_burst {
	u_int32_t	min_burst_size; /* Minimum number of packets to use */
	u_int32_t	max_burst_size; /* Maximum number of packets to use */
};

/*
 * Note that IPv6 link local addresses should have the appropriate scope ID
 */

struct info_tuple {
	u_int8_t	itpl_proto;
	union {
		struct sockaddr		_itpl_sa;
		struct sockaddr_in	_itpl_sin;
		struct sockaddr_in6	_itpl_sin6;
	} itpl_localaddr;
	union {
		struct sockaddr		_itpl_sa;
		struct sockaddr_in	_itpl_sin;
		struct sockaddr_in6	_itpl_sin6;
	} itpl_remoteaddr;
};

#define itpl_local_sa		itpl_localaddr._itpl_sa
#define itpl_local_sin 		itpl_localaddr._itpl_sin
#define itpl_local_sin6		itpl_localaddr._itpl_sin6
#define itpl_remote_sa 		itpl_remoteaddr._itpl_sa
#define itpl_remote_sin		itpl_remoteaddr._itpl_sin
#define itpl_remote_sin6	itpl_remoteaddr._itpl_sin6

/*
 * TCP connection info auxiliary data (CIAUX_TCP)
 *
 * Do not add new fields to this structure, just add them to tcp_info 
 * structure towards the end. This will preserve binary compatibility.
 */
typedef struct conninfo_tcp {
	pid_t			tcpci_peer_pid;	/* loopback peer PID if > 0 */
	struct tcp_info		tcpci_tcp_info;	/* TCP info */
} conninfo_tcp_t;

#pragma pack()

#endif /* PRIVATE */
#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */

#endif
Commit	Line	Data
1c79356b	1	/*
fe8ab488	2	* Copyright (c) 2000-2014 Apple Inc. All rights reserved.
5d5c5d0d	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
39236c6e	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.
39236c6e	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.
39236c6e	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.
39236c6e	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 */
8ad349bb A	136	#define TCPOLEN_SIGNATURE 18
39236c6e A	137	#if MPTCP
	138	#define TCPOPT_MULTIPATH 30
	139	#endif
8ad349bb A	140
	141	/* Option definitions */
	142	#define TCPOPT_SACK_PERMIT_HDR \
	143	(TCPOPT_NOP<<24\|TCPOPT_NOP<<16\|TCPOPT_SACK_PERMITTED<<8\|TCPOLEN_SACK_PERMITTED)
	144	#define TCPOPT_SACK_HDR (TCPOPT_NOP<<24\|TCPOPT_NOP<<16\|TCPOPT_SACK<<8)
	145	/* Miscellaneous constants */
	146	#define MAX_SACK_BLKS 6 /* Max # SACK blocks stored at sender side */
fe8ab488 A	147
	148	/*
	149	* A SACK option that specifies n blocks will have a length of (8*n + 2)
	150	* bytes, so the 40 bytes available for TCP options can specify a
	151	* maximum of 4 blocks.
	152	*/
	153
	154	#define TCP_MAX_SACK 4 /* MAX # SACKs sent in any segment */
8ad349bb	155
1c79356b A	156
	157	/*
	158	* Default maximum segment size for TCP.
4a249263	159	* With an IP MTU of 576, this is 536,
1c79356b A	160	* but 512 is probably more convenient.
	161	* This should be defined as MIN(512, IP_MSS - sizeof (struct tcpiphdr)).
	162	*/
	163	#define TCP_MSS 512
	164
e5568f75 A	165	/*
	166	* TCP_MINMSS is defined to be 216 which is fine for the smallest
	167	* link MTU (256 bytes, SLIP interface) in the Internet.
	168	* However it is very unlikely to come across such low MTU interfaces
	169	* these days (anno dato 2004).
	170	* Probably it can be set to 512 without ill effects. But we play safe.
	171	* See tcp_subr.c tcp_minmss SYSCTL declaration for more comments.
	172	* Setting this to "0" disables the minmss check.
	173	*/
	174	#define TCP_MINMSS 216
	175
1c79356b A	176	/*
	177	* Default maximum segment size for TCP6.
	178	* With an IP6 MSS of 1280, this is 1220,
	179	* but 1024 is probably more convenient. (xxx kazu in doubt)
	180	* This should be defined as MIN(1024, IP6_MSS - sizeof (struct tcpip6hdr))
	181	*/
	182	#define TCP6_MSS 1024
	183
	184	#define TCP_MAXWIN 65535 /* largest value for (unscaled) window */
	185	#define TTCP_CLIENT_SND_WND 4096 /* dflt send window for T/TCP client */
	186
	187	#define TCP_MAX_WINSHIFT 14 /* maximum window shift */
	188
	189	#define TCP_MAXHLEN (0xf<<2) /* max length of header in bytes */
	190	#define TCP_MAXOLEN (TCP_MAXHLEN - sizeof(struct tcphdr))
	191	/* max space left for options */
2d21ac55	192	#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b A	193
	194	/*
	195	* User-settable options (used with setsockopt).
	196	*/
b0d623f7	197	#define TCP_NODELAY 0x01 /* don't delay send to coalesce packets */
2d21ac55	198	#if !defined(_POSIX_C_SOURCE) \|\| defined(_DARWIN_C_SOURCE)
b0d623f7 A	199	#define TCP_MAXSEG 0x02 /* set maximum segment size */
	200	#define TCP_NOPUSH 0x04 /* don't push last block of write */
	201	#define TCP_NOOPT 0x08 /* don't use TCP options */
	202	#define TCP_KEEPALIVE 0x10 /* idle time used when SO_KEEPALIVE is enabled */
	203	#define TCP_CONNECTIONTIMEOUT 0x20 /* connection timeout */
6d2010ae A	204	#define PERSIST_TIMEOUT 0x40 /* time after which a connection in
	205	* persist timeout will terminate.
	206	* see draft-ananth-tcpm-persist-02.txt
	207	*/
	208	#define TCP_RXT_CONNDROPTIME 0x80 /* time after which tcp retransmissions will be
	209	* stopped and the connection will be dropped
	210	*/
39236c6e	211	#define TCP_RXT_FINDROP 0x100 /* when this option is set, drop a connection
6d2010ae A	212	* after retransmitting the FIN 3 times. It will
	213	* prevent holding too many mbufs in socket
	214	* buffer queues.
	215	*/
39236c6e A	216	#define TCP_KEEPINTVL 0x101 /* interval between keepalives */
	217	#define TCP_KEEPCNT 0x102 /* number of keepalives before close */
	218	#define TCP_SENDMOREACKS 0x103 /* always ack every other packet */
fe8ab488 A	219	#define TCP_ENABLE_ECN 0x104 /* Enable ECN on a connection */
fe8ab488 A	220
6d2010ae	221	#ifdef PRIVATE
316670eb	222	#define TCP_INFO 0x200 /* retrieve tcp_info structure */
316670eb	223	#define TCP_MEASURE_SND_BW 0x202 /* Measure sender's bandwidth for this connection */
fe8ab488 A	224	#endif /* PRIVATE */
	225
	226
	227	#define TCP_NOTSENT_LOWAT 0x201 /* Low water mark for TCP unsent data */
	228
	229	#ifdef PRIVATE
316670eb A	230	#define TCP_MEASURE_BW_BURST 0x203 /* Burst size to use for bandwidth measurement */
316670eb A	231	#define TCP_PEER_PID 0x204 /* Lookup pid of the process we're connected to */
39236c6e A	232	#define TCP_ADAPTIVE_READ_TIMEOUT 0x205 /* Read timeout used as a multiple of RTT */
	233	/*
	234	* Enable message delivery on a socket, this feature is currently unsupported and
	235	* is subjected to change in future.
	236	*/
	237	#define TCP_ENABLE_MSGS 0x206
	238	#define TCP_ADAPTIVE_WRITE_TIMEOUT 0x207 /* Write timeout used as a multiple of RTT */
fe8ab488 A	239	#define TCP_NOTIMEWAIT 0x208 /* Avoid going into time-wait */
fe8ab488 A	240	#define TCP_DISABLE_BLACKHOLE_DETECTION 0x209 /* disable PMTU blackhole detection */
39236c6e	241
6d2010ae	242	/*
316670eb	243	* The TCP_INFO socket option is a private API and is subject to change
6d2010ae A	244	*/
	245	#pragma pack(4)
	246
	247	#define TCPI_OPT_TIMESTAMPS 0x01
	248	#define TCPI_OPT_SACK 0x02
	249	#define TCPI_OPT_WSCALE 0x04
	250	#define TCPI_OPT_ECN 0x08
	251
316670eb A	252	#define TCPI_FLAG_LOSSRECOVERY 0x01 /* Currently in loss recovery */
316670eb A	253
39236c6e A	254	/*
	255	* Add new fields to this structure at the end only. This will preserve
	256	* binary compatibility.
	257	*/
6d2010ae A	258	struct tcp_info {
	259	u_int8_t tcpi_state; /* TCP FSM state. */
	260	u_int8_t tcpi_options; /* Options enabled on conn. */
	261	u_int8_t tcpi_snd_wscale; /* RFC1323 send shift value. */
	262	u_int8_t tcpi_rcv_wscale; /* RFC1323 recv shift value. */
	263
316670eb A	264	u_int32_t tcpi_flags; /* extra flags (TCPI_FLAG_xxx) */
	265
	266	u_int32_t tcpi_rto; /* Retransmission timeout in milliseconds */
6d2010ae A	267	u_int32_t tcpi_snd_mss; /* Max segment size for send. */
	268	u_int32_t tcpi_rcv_mss; /* Max segment size for receive. */
	269
316670eb A	270	u_int32_t tcpi_rttcur; /* Most recent value of RTT */
	271	u_int32_t tcpi_srtt; /* Smoothed RTT */
	272	u_int32_t tcpi_rttvar; /* RTT variance */
39236c6e	273	u_int32_t tcpi_rttbest; /* Best RTT we've seen */
316670eb	274
6d2010ae A	275	u_int32_t tcpi_snd_ssthresh; /* Slow start threshold. */
	276	u_int32_t tcpi_snd_cwnd; /* Send congestion window. */
	277
	278	u_int32_t tcpi_rcv_space; /* Advertised recv window. */
	279
	280	u_int32_t tcpi_snd_wnd; /* Advertised send window. */
6d2010ae A	281	u_int32_t tcpi_snd_nxt; /* Next egress seqno */
	282	u_int32_t tcpi_rcv_nxt; /* Next ingress seqno */
	283
	284	int32_t tcpi_last_outif; /* if_index of interface used to send last */
316670eb A	285	u_int32_t tcpi_snd_sbbytes; /* bytes in snd buffer including data inflight */
316670eb A	286
39236c6e	287	u_int64_t tcpi_txpackets __attribute__((aligned(8))); /* total packets sent */
316670eb A	288	u_int64_t tcpi_txbytes __attribute__((aligned(8)));
	289	/* total bytes sent */
	290	u_int64_t tcpi_txretransmitbytes __attribute__((aligned(8)));
	291	/* total bytes retransmitted */
	292	u_int64_t tcpi_txunacked __attribute__((aligned(8)));
	293	/* current number of bytes not acknowledged */
39236c6e	294	u_int64_t tcpi_rxpackets __attribute__((aligned(8))); /* total packets received */
316670eb A	295	u_int64_t tcpi_rxbytes __attribute__((aligned(8)));
	296	/* total bytes received */
	297	u_int64_t tcpi_rxduplicatebytes __attribute__((aligned(8)));
	298	/* total duplicate bytes received */
39236c6e A	299	u_int64_t tcpi_rxoutoforderbytes __attribute__((aligned(8)));
	300	/* total out of order bytes received */
	301	u_int64_t tcpi_snd_bw __attribute__((aligned(8))); /* measured send bandwidth in bits/sec */
	302	u_int8_t tcpi_synrexmits; /* Number of syn retransmits before connect */
	303	u_int8_t tcpi_unused1;
	304	u_int16_t tcpi_unused2;
	305	u_int64_t tcpi_cell_rxpackets __attribute((aligned(8))); /* packets received over cellular */
	306	u_int64_t tcpi_cell_rxbytes __attribute((aligned(8))); /* bytes received over cellular */
	307	u_int64_t tcpi_cell_txpackets __attribute((aligned(8))); /* packets transmitted over cellular */
	308	u_int64_t tcpi_cell_txbytes __attribute((aligned(8))); /* bytes transmitted over cellular */
	309	u_int64_t tcpi_wifi_rxpackets __attribute((aligned(8))); /* packets received over Wi-Fi */
	310	u_int64_t tcpi_wifi_rxbytes __attribute((aligned(8))); /* bytes received over Wi-Fi */
	311	u_int64_t tcpi_wifi_txpackets __attribute((aligned(8))); /* packets transmitted over Wi-Fi */
	312	u_int64_t tcpi_wifi_txbytes __attribute((aligned(8))); /* bytes transmitted over Wi-Fi */
fe8ab488 A	313	u_int64_t tcpi_wired_rxpackets __attribute((aligned(8))); /* packets received over Wired */
	314	u_int64_t tcpi_wired_rxbytes __attribute((aligned(8))); /* bytes received over Wired */
	315	u_int64_t tcpi_wired_txpackets __attribute((aligned(8))); /* packets transmitted over Wired */
	316	u_int64_t tcpi_wired_txbytes __attribute((aligned(8))); /* bytes transmitted over Wired */
316670eb A	317	};
	318
	319	struct tcp_measure_bw_burst {
	320	u_int32_t min_burst_size; /* Minimum number of packets to use */
	321	u_int32_t max_burst_size; /* Maximum number of packets to use */
6d2010ae A	322	};
	323
	324	/*
	325	* Note that IPv6 link local addresses should have the appropriate scope ID
	326	*/
	327
	328	struct info_tuple {
	329	u_int8_t itpl_proto;
	330	union {
	331	struct sockaddr _itpl_sa;
	332	struct sockaddr_in _itpl_sin;
	333	struct sockaddr_in6 _itpl_sin6;
	334	} itpl_localaddr;
	335	union {
	336	struct sockaddr _itpl_sa;
	337	struct sockaddr_in _itpl_sin;
	338	struct sockaddr_in6 _itpl_sin6;
	339	} itpl_remoteaddr;
	340	};
	341
	342	#define itpl_local_sa itpl_localaddr._itpl_sa
	343	#define itpl_local_sin itpl_localaddr._itpl_sin
	344	#define itpl_local_sin6 itpl_localaddr._itpl_sin6
	345	#define itpl_remote_sa itpl_remoteaddr._itpl_sa
	346	#define itpl_remote_sin itpl_remoteaddr._itpl_sin
	347	#define itpl_remote_sin6 itpl_remoteaddr._itpl_sin6
	348
39236c6e A	349	/*
	350	* TCP connection info auxiliary data (CIAUX_TCP)
	351	*
	352	* Do not add new fields to this structure, just add them to tcp_info
	353	* structure towards the end. This will preserve binary compatibility.
	354	*/
	355	typedef struct conninfo_tcp {
	356	pid_t tcpci_peer_pid; /* loopback peer PID if > 0 */
	357	struct tcp_info tcpci_tcp_info; /* TCP info */
	358	} conninfo_tcp_t;
	359
6d2010ae A	360	#pragma pack()
	361
	362	#endif /* PRIVATE */
2d21ac55	363	#endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
1c79356b A	364
1c79356b A	365	#endif