[thirdparty/qemu.git] / slirp / src / tcp.h

/* SPDX-License-Identifier: BSD-3-Clause */
/*
 * 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. 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

#include <glib.h>

typedef	uint32_t tcp_seq;

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

#define TCP_SNDSPACE 8192
#define TCP_RCVSPACE 8192

/*
 * TCP header.
 * Per RFC 793, September, 1981.
 */
#define tcphdr slirp_tcphdr
struct tcphdr {
	uint16_t th_sport;              /* source port */
	uint16_t th_dport;              /* destination port */
	tcp_seq	th_seq;			/* sequence number */
	tcp_seq	th_ack;			/* acknowledgement number */
#if G_BYTE_ORDER == G_BIG_ENDIAN
	uint8_t	th_off:4,		/* data offset */
		th_x2:4;		/* (unused) */
#else
	uint8_t	th_x2:4,		/* (unused) */
		th_off:4;		/* data offset */
#endif
	uint8_t th_flags;
	uint16_t th_win;                /* window */
	uint16_t th_sum;                /* checksum */
	uint16_t th_urp;                /* urgent pointer */
};

#include "tcp_var.h"

#ifndef TH_FIN
#define	TH_FIN	0x01
#define	TH_SYN	0x02
#define	TH_RST	0x04
#define	TH_PUSH	0x08
#define	TH_ACK	0x10
#define	TH_URG	0x20
#endif

#ifndef TCPOPT_EOL
#define	TCPOPT_EOL		0
#define	TCPOPT_NOP		1
#define	TCPOPT_MAXSEG		2
#define TCPOPT_WINDOW		3
#define TCPOPT_SACK_PERMITTED	4		/* Experimental */
#define TCPOPT_SACK		5		/* Experimental */
#define TCPOPT_TIMESTAMP	8

#define TCPOPT_TSTAMP_HDR	\
    (TCPOPT_NOP<<24|TCPOPT_NOP<<16|TCPOPT_TIMESTAMP<<8|TCPOLEN_TIMESTAMP)
#endif

#ifndef TCPOLEN_MAXSEG
#define    TCPOLEN_MAXSEG		4
#define    TCPOLEN_WINDOW		3
#define    TCPOLEN_SACK_PERMITTED	2
#define    TCPOLEN_TIMESTAMP		10
#define    TCPOLEN_TSTAMP_APPA		(TCPOLEN_TIMESTAMP+2) /* appendix A */
#endif

/*
 * 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.
 */
#undef TCP_MSS
#define	TCP_MSS	1460
#undef TCP6_MSS
#define TCP6_MSS 1440

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

#undef TCP_MAX_WINSHIFT
#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

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

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