xref: /freebsd/sys/netinet/tcp_fsm.h (revision 2be1a816b9ff69588e55be0a84cbe2a31efc0f2f)
1 /*-
2  * Copyright (c) 1982, 1986, 1993
3  *	The Regents of the University of California.
4  * 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.
14  * 4. Neither the name of the University nor the names of its contributors
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_fsm.h	8.1 (Berkeley) 6/10/93
31  * $FreeBSD$
32  */
33 
34 #ifndef _NETINET_TCP_FSM_H_
35 #define	_NETINET_TCP_FSM_H_
36 
37 /*
38  * TCP FSM state definitions.
39  *
40  * Per RFC793, September, 1981.
41  */
42 
43 #define	TCP_NSTATES	11
44 
45 #define	TCPS_CLOSED		0	/* closed */
46 #define	TCPS_LISTEN		1	/* listening for connection */
47 #define	TCPS_SYN_SENT		2	/* active, have sent syn */
48 #define	TCPS_SYN_RECEIVED	3	/* have sent and received syn */
49 /* states < TCPS_ESTABLISHED are those where connections not established */
50 #define	TCPS_ESTABLISHED	4	/* established */
51 #define	TCPS_CLOSE_WAIT		5	/* rcvd fin, waiting for close */
52 /* states > TCPS_CLOSE_WAIT are those where user has closed */
53 #define	TCPS_FIN_WAIT_1		6	/* have closed, sent fin */
54 #define	TCPS_CLOSING		7	/* closed xchd FIN; await FIN ACK */
55 #define	TCPS_LAST_ACK		8	/* had fin and close; await FIN ACK */
56 /* states > TCPS_CLOSE_WAIT && < TCPS_FIN_WAIT_2 await ACK of FIN */
57 #define	TCPS_FIN_WAIT_2		9	/* have closed, fin is acked */
58 #define	TCPS_TIME_WAIT		10	/* in 2*msl quiet wait after close */
59 
60 /* for KAME src sync over BSD*'s */
61 #define	TCP6_NSTATES		TCP_NSTATES
62 #define	TCP6S_CLOSED		TCPS_CLOSED
63 #define	TCP6S_LISTEN		TCPS_LISTEN
64 #define	TCP6S_SYN_SENT		TCPS_SYN_SENT
65 #define	TCP6S_SYN_RECEIVED	TCPS_SYN_RECEIVED
66 #define	TCP6S_ESTABLISHED	TCPS_ESTABLISHED
67 #define	TCP6S_CLOSE_WAIT	TCPS_CLOSE_WAIT
68 #define	TCP6S_FIN_WAIT_1	TCPS_FIN_WAIT_1
69 #define	TCP6S_CLOSING		TCPS_CLOSING
70 #define	TCP6S_LAST_ACK		TCPS_LAST_ACK
71 #define	TCP6S_FIN_WAIT_2	TCPS_FIN_WAIT_2
72 #define	TCP6S_TIME_WAIT		TCPS_TIME_WAIT
73 
74 #define	TCPS_HAVERCVDSYN(s)	((s) >= TCPS_SYN_RECEIVED)
75 #define	TCPS_HAVEESTABLISHED(s)	((s) >= TCPS_ESTABLISHED)
76 #define	TCPS_HAVERCVDFIN(s)	((s) >= TCPS_TIME_WAIT)
77 
78 #ifdef	TCPOUTFLAGS
79 /*
80  * Flags used when sending segments in tcp_output.  Basic flags (TH_RST,
81  * TH_ACK,TH_SYN,TH_FIN) are totally determined by state, with the proviso
82  * that TH_FIN is sent only if all data queued for output is included in the
83  * segment.
84  */
85 static u_char	tcp_outflags[TCP_NSTATES] = {
86 	TH_RST|TH_ACK,		/* 0, CLOSED */
87 	0,			/* 1, LISTEN */
88 	TH_SYN,			/* 2, SYN_SENT */
89 	TH_SYN|TH_ACK,		/* 3, SYN_RECEIVED */
90 	TH_ACK,			/* 4, ESTABLISHED */
91 	TH_ACK,			/* 5, CLOSE_WAIT */
92 	TH_FIN|TH_ACK,		/* 6, FIN_WAIT_1 */
93 	TH_FIN|TH_ACK,		/* 7, CLOSING */
94 	TH_FIN|TH_ACK,		/* 8, LAST_ACK */
95 	TH_ACK,			/* 9, FIN_WAIT_2 */
96 	TH_ACK,			/* 10, TIME_WAIT */
97 };
98 #endif
99 
100 #ifdef KPROF
101 int	tcp_acounts[TCP_NSTATES][PRU_NREQ];
102 #endif
103 
104 #ifdef	TCPSTATES
105 static char const * const tcpstates[] = {
106 	"CLOSED",	"LISTEN",	"SYN_SENT",	"SYN_RCVD",
107 	"ESTABLISHED",	"CLOSE_WAIT",	"FIN_WAIT_1",	"CLOSING",
108 	"LAST_ACK",	"FIN_WAIT_2",	"TIME_WAIT",
109 };
110 #endif
111 
112 #endif
113