xref: /freebsd/sys/netinet/tcp_fsm.h (revision c98323078dede7579020518ec84cdcb478e5c142)
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  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)tcp_fsm.h	8.1 (Berkeley) 6/10/93
30  * $FreeBSD$
31  */
32 
33 #ifndef _NETINET_TCP_FSM_H_
34 #define _NETINET_TCP_FSM_H_
35 
36 /*
37  * TCP FSM state definitions.
38  * Per RFC793, September, 1981.
39  */
40 
41 #define	TCP_NSTATES	11
42 
43 #define	TCPS_CLOSED		0	/* closed */
44 #define	TCPS_LISTEN		1	/* listening for connection */
45 #define	TCPS_SYN_SENT		2	/* active, have sent syn */
46 #define	TCPS_SYN_RECEIVED	3	/* have send and received syn */
47 /* states < TCPS_ESTABLISHED are those where connections not established */
48 #define	TCPS_ESTABLISHED	4	/* established */
49 #define	TCPS_CLOSE_WAIT		5	/* rcvd fin, waiting for close */
50 /* states > TCPS_CLOSE_WAIT are those where user has closed */
51 #define	TCPS_FIN_WAIT_1		6	/* have closed, sent fin */
52 #define	TCPS_CLOSING		7	/* closed xchd FIN; await FIN ACK */
53 #define	TCPS_LAST_ACK		8	/* had fin and close; await FIN ACK */
54 /* states > TCPS_CLOSE_WAIT && < TCPS_FIN_WAIT_2 await ACK of FIN */
55 #define	TCPS_FIN_WAIT_2		9	/* have closed, fin is acked */
56 #define	TCPS_TIME_WAIT		10	/* in 2*msl quiet wait after close */
57 
58 /* for KAME src sync over BSD*'s */
59 #define	TCP6_NSTATES		TCP_NSTATES
60 #define	TCP6S_CLOSED		TCPS_CLOSED
61 #define	TCP6S_LISTEN		TCPS_LISTEN
62 #define	TCP6S_SYN_SENT		TCPS_SYN_SENT
63 #define	TCP6S_SYN_RECEIVED	TCPS_SYN_RECEIVED
64 #define	TCP6S_ESTABLISHED	TCPS_ESTABLISHED
65 #define	TCP6S_CLOSE_WAIT	TCPS_CLOSE_WAIT
66 #define	TCP6S_FIN_WAIT_1	TCPS_FIN_WAIT_1
67 #define	TCP6S_CLOSING		TCPS_CLOSING
68 #define	TCP6S_LAST_ACK		TCPS_LAST_ACK
69 #define	TCP6S_FIN_WAIT_2	TCPS_FIN_WAIT_2
70 #define	TCP6S_TIME_WAIT		TCPS_TIME_WAIT
71 
72 #define	TCPS_HAVERCVDSYN(s)	((s) >= TCPS_SYN_RECEIVED)
73 #define	TCPS_HAVEESTABLISHED(s)	((s) >= TCPS_ESTABLISHED)
74 #define	TCPS_HAVERCVDFIN(s)	((s) >= TCPS_TIME_WAIT)
75 
76 #ifdef	TCPOUTFLAGS
77 /*
78  * Flags used when sending segments in tcp_output.
79  * Basic flags (TH_RST,TH_ACK,TH_SYN,TH_FIN) are totally
80  * determined by state, with the proviso that TH_FIN is sent only
81  * if all data queued for output is included in the segment.
82  */
83 static u_char	tcp_outflags[TCP_NSTATES] = {
84 	TH_RST|TH_ACK,		/* 0, CLOSED */
85 	0,			/* 1, LISTEN */
86 	TH_SYN,			/* 2, SYN_SENT */
87 	TH_SYN|TH_ACK,		/* 3, SYN_RECEIVED */
88 	TH_ACK,			/* 4, ESTABLISHED */
89 	TH_ACK,			/* 5, CLOSE_WAIT */
90 	TH_FIN|TH_ACK,		/* 6, FIN_WAIT_1 */
91 	TH_FIN|TH_ACK,		/* 7, CLOSING */
92 	TH_FIN|TH_ACK,		/* 8, LAST_ACK */
93 	TH_ACK,			/* 9, FIN_WAIT_2 */
94 	TH_ACK,			/* 10, TIME_WAIT */
95 };
96 #endif
97 
98 #ifdef KPROF
99 int	tcp_acounts[TCP_NSTATES][PRU_NREQ];
100 #endif
101 
102 #ifdef	TCPSTATES
103 const char *tcpstates[] = {
104 	"CLOSED",	"LISTEN",	"SYN_SENT",	"SYN_RCVD",
105 	"ESTABLISHED",	"CLOSE_WAIT",	"FIN_WAIT_1",	"CLOSING",
106 	"LAST_ACK",	"FIN_WAIT_2",	"TIME_WAIT",
107 };
108 #endif
109 
110 #endif
111