[qemu.git] / slirp / tcp.h

/*
 * 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
 * tcp.h,v 1.3 1994/08/21 05:27:34 paul Exp
 */

#ifndef _TCP_H_
#define _TCP_H_

typedef	u_int32_t	tcp_seq;

#define      PR_SLOWHZ       2               /* 2 slow timeouts per second (approx) */
#define      PR_FASTHZ       5               /* 5 fast timeouts per second (not important) */

extern struct socket *tcp_last_so;

#define TCP_SNDSPACE 8192
#define TCP_RCVSPACE 8192

/*
 * TCP header.
 * Per RFC 793, September, 1981.
 */
struct tcphdr {
	u_int16_t	th_sport;		/* source port */
	u_int16_t	th_dport;		/* destination port */
	tcp_seq	th_seq;			/* sequence number */
	tcp_seq	th_ack;			/* acknowledgement number */
#ifdef WORDS_BIGENDIAN
	u_int	th_off:4,		/* data offset */
		th_x2:4;		/* (unused) */
#else
	u_int	th_x2:4,		/* (unused) */
		th_off:4;		/* data offset */
#endif
	u_int8_t	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
	u_int16_t	th_win;			/* window */
	u_int16_t	th_sum;			/* checksum */
	u_int16_t	th_urp;			/* urgent pointer */
};

#include "tcp_var.h"

#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 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)

/*
 * Default maximum segment size for TCP.
 * With an IP MSS of 576, this is 536,
 * but 512 is probably more convenient.
 * This should be defined as MIN(512, IP_MSS - sizeof (struct tcpiphdr)).
 *
 * We make this 1460 because we only care about Ethernet in the qemu context.
 */
#define	TCP_MSS	1460

#define	TCP_MAXWIN	65535	/* largest value for (unscaled) window */

#define TCP_MAX_WINSHIFT	14	/* maximum window shift */

/*
 * User-settable options (used with setsockopt).
 *
 * We don't use the system headers on unix because we have conflicting
 * local structures. We can't avoid the system definitions on Windows,
 * so we undefine them.
 */
#undef TCP_NODELAY
#define	TCP_NODELAY	0x01	/* don't delay send to coalesce packets */
#undef TCP_MAXSEG
/* #define	TCP_MAXSEG	0x02 */	/* set maximum segment size */

/*
 * TCP FSM state definitions.
 * Per RFC793, September, 1981.
 */

#define TCP_NSTATES     11

#define TCPS_CLOSED             0       /* closed */
#define TCPS_LISTEN             1       /* listening for connection */
#define TCPS_SYN_SENT           2       /* active, have sent syn */
#define TCPS_SYN_RECEIVED       3       /* have send and received syn */
/* states < TCPS_ESTABLISHED are those where connections not established */
#define TCPS_ESTABLISHED        4       /* established */
#define TCPS_CLOSE_WAIT         5       /* rcvd fin, waiting for close */
/* states > TCPS_CLOSE_WAIT are those where user has closed */
#define TCPS_FIN_WAIT_1         6       /* have closed, sent fin */
#define TCPS_CLOSING            7       /* closed xchd FIN; await FIN ACK */
#define TCPS_LAST_ACK           8       /* had fin and close; await FIN ACK */
/* states > TCPS_CLOSE_WAIT && < TCPS_FIN_WAIT_2 await ACK of FIN */
#define TCPS_FIN_WAIT_2         9       /* have closed, fin is acked */
#define TCPS_TIME_WAIT          10      /* in 2*msl quiet wait after close */

#define TCPS_HAVERCVDSYN(s)     ((s) >= TCPS_SYN_RECEIVED)
#define TCPS_HAVEESTABLISHED(s) ((s) >= TCPS_ESTABLISHED)
#define TCPS_HAVERCVDFIN(s)     ((s) >= TCPS_TIME_WAIT)

/*
 * TCP sequence numbers are 32 bit integers operated
 * on with modular arithmetic.  These macros can be
 * used to compare such integers.
 */
#define SEQ_LT(a,b)     ((int)((a)-(b)) < 0)
#define SEQ_LEQ(a,b)    ((int)((a)-(b)) <= 0)
#define SEQ_GT(a,b)     ((int)((a)-(b)) > 0)
#define SEQ_GEQ(a,b)    ((int)((a)-(b)) >= 0)

/*
 * Macros to initialize tcp sequence numbers for
 * send and receive from initial send and receive
 * sequence numbers.
 */
#define tcp_rcvseqinit(tp) \
     (tp)->rcv_adv = (tp)->rcv_nxt = (tp)->irs + 1

#define tcp_sendseqinit(tp) \
    (tp)->snd_una = (tp)->snd_nxt = (tp)->snd_max = (tp)->snd_up = (tp)->iss

#define TCP_ISSINCR     (125*1024)      /* increment for tcp_iss each second */

extern tcp_seq tcp_iss;                /* tcp initial send seq # */

extern const char * const tcpstates[];

#endif
Commit	Line	Data
f0cbd3ec FB	1	/*
	2	* Copyright (c) 1982, 1986, 1993
	3	* The Regents of the University of California. All rights reserved.
	4	*
	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions
	7	* are met:
	8	* 1. Redistributions of source code must retain the above copyright
	9	* notice, this list of conditions and the following disclaimer.
	10	* 2. Redistributions in binary form must reproduce the above copyright
	11	* notice, this list of conditions and the following disclaimer in the
	12	* documentation and/or other materials provided with the distribution.
	13	* 3. All advertising materials mentioning features or use of this software
	14	* must display the following acknowledgement:
	15	* This product includes software developed by the University of
	16	* California, Berkeley and its contributors.
	17	* 4. Neither the name of the University nor the names of its contributors
	18	* may be used to endorse or promote products derived from this software
	19	* without specific prior written permission.
	20	*
	21	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	22	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	23	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	24	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	25	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	26	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	27	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	28	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	29	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	30	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	31	* SUCH DAMAGE.
	32	*
	33	* @(#)tcp.h 8.1 (Berkeley) 6/10/93
	34	* tcp.h,v 1.3 1994/08/21 05:27:34 paul Exp
	35	*/
	36
	37	#ifndef _TCP_H_
	38	#define _TCP_H_
	39
	40	typedef u_int32_t tcp_seq;
	41
	42	#define PR_SLOWHZ 2 /* 2 slow timeouts per second (approx) */
	43	#define PR_FASTHZ 5 /* 5 fast timeouts per second (not important) */
	44
f0cbd3ec FB	45	extern struct socket *tcp_last_so;
	46
	47	#define TCP_SNDSPACE 8192
	48	#define TCP_RCVSPACE 8192
	49
	50	/*
	51	* TCP header.
	52	* Per RFC 793, September, 1981.
	53	*/
	54	struct tcphdr {
	55	u_int16_t th_sport; /* source port */
	56	u_int16_t th_dport; /* destination port */
	57	tcp_seq th_seq; /* sequence number */
	58	tcp_seq th_ack; /* acknowledgement number */
	59	#ifdef WORDS_BIGENDIAN
	60	u_int th_off:4, /* data offset */
	61	th_x2:4; /* (unused) */
	62	#else
	63	u_int th_x2:4, /* (unused) */
	64	th_off:4; /* data offset */
	65	#endif
	66	u_int8_t th_flags;
	67	#define TH_FIN 0x01
	68	#define TH_SYN 0x02
	69	#define TH_RST 0x04
	70	#define TH_PUSH 0x08
	71	#define TH_ACK 0x10
	72	#define TH_URG 0x20
	73	u_int16_t th_win; /* window */
	74	u_int16_t th_sum; /* checksum */
	75	u_int16_t th_urp; /* urgent pointer */
	76	};
	77
	78	#include "tcp_var.h"
	79
	80	#define TCPOPT_EOL 0
	81	#define TCPOPT_NOP 1
	82	#define TCPOPT_MAXSEG 2
	83	#define TCPOLEN_MAXSEG 4
	84	#define TCPOPT_WINDOW 3
	85	#define TCPOLEN_WINDOW 3
	86	#define TCPOPT_SACK_PERMITTED 4 /* Experimental */
	87	#define TCPOLEN_SACK_PERMITTED 2
	88	#define TCPOPT_SACK 5 /* Experimental */
	89	#define TCPOPT_TIMESTAMP 8
	90	#define TCPOLEN_TIMESTAMP 10
	91	#define TCPOLEN_TSTAMP_APPA (TCPOLEN_TIMESTAMP+2) /* appendix A */
	92
	93	#define TCPOPT_TSTAMP_HDR \
	94	(TCPOPT_NOP<<24\|TCPOPT_NOP<<16\|TCPOPT_TIMESTAMP<<8\|TCPOLEN_TIMESTAMP)
	95
	96	/*
	97	* Default maximum segment size for TCP.
	98	* With an IP MSS of 576, this is 536,
	99	* but 512 is probably more convenient.
	100	* This should be defined as MIN(512, IP_MSS - sizeof (struct tcpiphdr)).
773f2cdd FB	101	*
773f2cdd FB	102	* We make this 1460 because we only care about Ethernet in the qemu context.
f0cbd3ec	103	*/
773f2cdd	104	#define TCP_MSS 1460
f0cbd3ec FB	105
	106	#define TCP_MAXWIN 65535 /* largest value for (unscaled) window */
	107
	108	#define TCP_MAX_WINSHIFT 14 /* maximum window shift */
	109
	110	/*
	111	* User-settable options (used with setsockopt).
28d657fc TS	112	*
	113	* We don't use the system headers on unix because we have conflicting
	114	* local structures. We can't avoid the system definitions on Windows,
	115	* so we undefine them.
f0cbd3ec	116	*/
28d657fc	117	#undef TCP_NODELAY
eaf7e70b	118	#define TCP_NODELAY 0x01 /* don't delay send to coalesce packets */
28d657fc	119	#undef TCP_MAXSEG
f0cbd3ec FB	120	/* #define TCP_MAXSEG 0x02 / / set maximum segment size */
	121
	122	/*
	123	* TCP FSM state definitions.
	124	* Per RFC793, September, 1981.
	125	*/
	126
	127	#define TCP_NSTATES 11
	128
	129	#define TCPS_CLOSED 0 /* closed */
	130	#define TCPS_LISTEN 1 /* listening for connection */
	131	#define TCPS_SYN_SENT 2 /* active, have sent syn */
	132	#define TCPS_SYN_RECEIVED 3 /* have send and received syn */
	133	/* states < TCPS_ESTABLISHED are those where connections not established */
	134	#define TCPS_ESTABLISHED 4 /* established */
	135	#define TCPS_CLOSE_WAIT 5 /* rcvd fin, waiting for close */
	136	/* states > TCPS_CLOSE_WAIT are those where user has closed */
	137	#define TCPS_FIN_WAIT_1 6 /* have closed, sent fin */
	138	#define TCPS_CLOSING 7 /* closed xchd FIN; await FIN ACK */
	139	#define TCPS_LAST_ACK 8 /* had fin and close; await FIN ACK */
	140	/* states > TCPS_CLOSE_WAIT && < TCPS_FIN_WAIT_2 await ACK of FIN */
	141	#define TCPS_FIN_WAIT_2 9 /* have closed, fin is acked */
	142	#define TCPS_TIME_WAIT 10 /* in 2msl quiet wait after close /
	143
	144	#define TCPS_HAVERCVDSYN(s) ((s) >= TCPS_SYN_RECEIVED)
	145	#define TCPS_HAVEESTABLISHED(s) ((s) >= TCPS_ESTABLISHED)
	146	#define TCPS_HAVERCVDFIN(s) ((s) >= TCPS_TIME_WAIT)
	147
	148	/*
	149	* TCP sequence numbers are 32 bit integers operated
	150	* on with modular arithmetic. These macros can be
	151	* used to compare such integers.
	152	*/
	153	#define SEQ_LT(a,b) ((int)((a)-(b)) < 0)
	154	#define SEQ_LEQ(a,b) ((int)((a)-(b)) <= 0)
	155	#define SEQ_GT(a,b) ((int)((a)-(b)) > 0)
	156	#define SEQ_GEQ(a,b) ((int)((a)-(b)) >= 0)
	157
	158	/*
	159	* Macros to initialize tcp sequence numbers for
	160	* send and receive from initial send and receive
	161	* sequence numbers.
	162	*/
	163	#define tcp_rcvseqinit(tp) \
	164	(tp)->rcv_adv = (tp)->rcv_nxt = (tp)->irs + 1
	165
	166	#define tcp_sendseqinit(tp) \
	167	(tp)->snd_una = (tp)->snd_nxt = (tp)->snd_max = (tp)->snd_up = (tp)->iss
	168
	169	#define TCP_ISSINCR (1251024) / increment for tcp_iss each second */
	170
	171	extern tcp_seq tcp_iss; /* tcp initial send seq # */
	172
9634d903	173	extern const char * const tcpstates[];
f0cbd3ec FB	174
f0cbd3ec FB	175	#endif