]>
Commit | Line | Data |
---|---|---|
83cbd279 | 1 | /** @file\r |
dab714aa | 2 | Tcp Protocol header file.\r |
3 | \r | |
ac8cca2a | 4 | Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 | 5 | This program and the accompanying materials\r |
83cbd279 | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
dfc1f033 | 8 | http://opensource.org/licenses/bsd-license.php<BR>\r |
83cbd279 | 9 | \r |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
83cbd279 | 13 | **/\r |
14 | \r | |
15 | #ifndef _TCP4_PROTO_H_\r | |
16 | #define _TCP4_PROTO_H_\r | |
17 | \r | |
18 | typedef struct _TCP_CB TCP_CB;\r | |
19 | \r | |
20 | #include "Tcp4Driver.h"\r | |
21 | #include "Socket.h"\r | |
22 | #include "Tcp4Option.h"\r | |
23 | \r | |
dfc1f033 | 24 | \r |
25 | \r | |
26 | ///\r | |
27 | /// Tcp states, Don't change their order, it is used as\r | |
28 | /// index to mTcpOutFlag and other macros\r | |
29 | ///\r | |
f6b7393c | 30 | #define TCP_CLOSED 0\r |
31 | #define TCP_LISTEN 1\r | |
32 | #define TCP_SYN_SENT 2\r | |
33 | #define TCP_SYN_RCVD 3\r | |
34 | #define TCP_ESTABLISHED 4\r | |
35 | #define TCP_FIN_WAIT_1 5\r | |
36 | #define TCP_FIN_WAIT_2 6\r | |
37 | #define TCP_CLOSING 7\r | |
38 | #define TCP_TIME_WAIT 8\r | |
39 | #define TCP_CLOSE_WAIT 9\r | |
40 | #define TCP_LAST_ACK 10\r | |
41 | \r | |
83cbd279 | 42 | \r |
dfc1f033 | 43 | ///\r |
44 | /// Flags in the TCP header\r | |
45 | ///\r | |
f6b7393c | 46 | #define TCP_FLG_FIN 0x01\r |
47 | #define TCP_FLG_SYN 0x02\r | |
48 | #define TCP_FLG_RST 0x04\r | |
49 | #define TCP_FLG_PSH 0x08\r | |
50 | #define TCP_FLG_ACK 0x10\r | |
51 | #define TCP_FLG_URG 0x20\r | |
52 | \r | |
53 | //\r | |
54 | // mask for all the flags\r | |
55 | //\r | |
56 | #define TCP_FLG_FLAG 0x3F \r | |
57 | \r | |
58 | \r | |
59 | #define TCP_CONNECT_REFUSED (-1) ///< TCP error status\r | |
60 | #define TCP_CONNECT_RESET (-2) ///< TCP error status\r | |
61 | #define TCP_CONNECT_CLOSED (-3) ///< TCP error status\r | |
62 | \r | |
63 | //\r | |
64 | // Current congestion status as suggested by RFC3782.\r | |
65 | //\r | |
66 | #define TCP_CONGEST_RECOVER 1 ///< During the NewReno fast recovery\r | |
67 | #define TCP_CONGEST_LOSS 2 ///< Retxmit because of retxmit time out\r | |
68 | #define TCP_CONGEST_OPEN 3 ///< TCP is opening its congestion window\r | |
69 | \r | |
70 | //\r | |
71 | // TCP control flags\r | |
72 | //\r | |
73 | #define TCP_CTRL_NO_NAGLE 0x0001 ///< Disable Nagle algorithm\r | |
74 | #define TCP_CTRL_NO_KEEPALIVE 0x0002 ///< Disable keepalive timer\r | |
75 | #define TCP_CTRL_NO_WS 0x0004 ///< Disable window scale option\r | |
76 | #define TCP_CTRL_RCVD_WS 0x0008 ///< Received a wnd scale option in syn\r | |
77 | #define TCP_CTRL_NO_TS 0x0010 ///< Disable Timestamp option\r | |
78 | #define TCP_CTRL_RCVD_TS 0x0020 ///< Received a Timestamp option in syn\r | |
79 | #define TCP_CTRL_SND_TS 0x0040 ///< Send Timestamp option to remote\r | |
80 | #define TCP_CTRL_SND_URG 0x0080 ///< In urgent send mode\r | |
81 | #define TCP_CTRL_RCVD_URG 0x0100 ///< In urgent receive mode\r | |
82 | #define TCP_CTRL_SND_PSH 0x0200 ///< In PUSH send mode\r | |
83 | #define TCP_CTRL_FIN_SENT 0x0400 ///< FIN is sent\r | |
84 | #define TCP_CTRL_FIN_ACKED 0x0800 ///< FIN is ACKed.\r | |
85 | #define TCP_CTRL_TIMER_ON 0x1000 ///< At least one of the timer is on\r | |
86 | #define TCP_CTRL_RTT_ON 0x2000 ///< The RTT measurement is on\r | |
87 | #define TCP_CTRL_ACK_NOW 0x4000 ///< Send the ACK now, don't delay\r | |
88 | \r | |
89 | //\r | |
90 | // Timer related values\r | |
91 | //\r | |
92 | #define TCP_TIMER_CONNECT 0 ///< Connection establishment timer\r | |
93 | #define TCP_TIMER_REXMIT 1 ///< Retransmit timer\r | |
94 | #define TCP_TIMER_PROBE 2 ///< Window probe timer\r | |
95 | #define TCP_TIMER_KEEPALIVE 3 ///< Keepalive timer\r | |
96 | #define TCP_TIMER_FINWAIT2 4 ///< FIN_WAIT_2 timer\r | |
97 | #define TCP_TIMER_2MSL 5 ///< TIME_WAIT tiemr\r | |
98 | #define TCP_TIMER_NUMBER 6 ///< The total number of TCP timer.\r | |
99 | #define TCP_TICK 200 ///< Every TCP tick is 200ms\r | |
100 | #define TCP_TICK_HZ 5 ///< The frequence of TCP tick\r | |
101 | #define TCP_RTT_SHIFT 3 ///< SRTT & RTTVAR scaled by 8\r | |
102 | #define TCP_RTO_MIN TCP_TICK_HZ ///< The minium value of RTO\r | |
103 | #define TCP_RTO_MAX (TCP_TICK_HZ * 60) ///< The maxium value of RTO\r | |
104 | #define TCP_FOLD_RTT 4 ///< Timeout threshod to fold RTT\r | |
105 | \r | |
106 | //\r | |
107 | // Default values for some timers\r | |
108 | //\r | |
109 | #define TCP_MAX_LOSS 12 ///< Default max times to retxmit\r | |
110 | #define TCP_KEEPALIVE_IDLE_MIN (TCP_TICK_HZ * 60 * 60 * 2) ///< First keep alive\r | |
111 | #define TCP_KEEPALIVE_PERIOD (TCP_TICK_HZ * 60)\r | |
112 | #define TCP_MAX_KEEPALIVE 8\r | |
113 | #define TCP_FIN_WAIT2_TIME (2 * TCP_TICK_HZ)\r | |
114 | #define TCP_TIME_WAIT_TIME (2 * TCP_TICK_HZ)\r | |
115 | #define TCP_PAWS_24DAY (24 * 24 * 60 * 60 * TCP_TICK_HZ)\r | |
116 | #define TCP_CONNECT_TIME (75 * TCP_TICK_HZ)\r | |
117 | \r | |
118 | //\r | |
119 | // The header space to be reserved before TCP data to accomodate :\r | |
120 | // 60byte IP head + 60byte TCP head + link layer head\r | |
121 | //\r | |
122 | #define TCP_MAX_HEAD 192\r | |
123 | \r | |
124 | //\r | |
125 | // Value ranges for some control option\r | |
126 | //\r | |
127 | #define TCP_RCV_BUF_SIZE (2 * 1024 * 1024)\r | |
128 | #define TCP_RCV_BUF_SIZE_MIN (8 * 1024)\r | |
129 | #define TCP_SND_BUF_SIZE (2 * 1024 * 1024)\r | |
130 | #define TCP_SND_BUF_SIZE_MIN (8 * 1024)\r | |
131 | #define TCP_BACKLOG 10\r | |
132 | #define TCP_BACKLOG_MIN 5\r | |
133 | #define TCP_MAX_LOSS_MIN 6\r | |
134 | #define TCP_CONNECT_TIME_MIN (60 * TCP_TICK_HZ)\r | |
135 | #define TCP_MAX_KEEPALIVE_MIN 4\r | |
136 | #define TCP_KEEPALIVE_IDLE_MAX (TCP_TICK_HZ * 60 * 60 * 4)\r | |
137 | #define TCP_KEEPALIVE_PERIOD_MIN (TCP_TICK_HZ * 30)\r | |
138 | #define TCP_FIN_WAIT2_TIME_MAX (4 * TCP_TICK_HZ)\r | |
139 | #define TCP_TIME_WAIT_TIME_MAX (60 * TCP_TICK_HZ)\r | |
83cbd279 | 140 | \r |
dfc1f033 | 141 | ///\r |
142 | /// TCP segmentation data\r | |
143 | ///\r | |
83cbd279 | 144 | typedef struct _TCP_SEG {\r |
dfc1f033 | 145 | TCP_SEQNO Seq; ///< Starting sequence number\r |
146 | TCP_SEQNO End; ///< The sequence of the last byte + 1, include SYN/FIN. End-Seq = SEG.LEN\r | |
147 | TCP_SEQNO Ack; ///< ACK field in the segment\r | |
148 | UINT8 Flag; ///< TCP header flags\r | |
149 | UINT16 Urg; ///< Valid if URG flag is set.\r | |
150 | UINT32 Wnd; ///< TCP window size field\r | |
83cbd279 | 151 | } TCP_SEG;\r |
152 | \r | |
dfc1f033 | 153 | ///\r |
154 | /// Network endpoint, IP+Port structure\r | |
155 | ///\r | |
83cbd279 | 156 | typedef struct _TCP_PEER {\r |
dfc1f033 | 157 | UINT32 Ip; ///< IP address, network byte order\r |
158 | TCP_PORTNO Port; ///< Port number, network byte order\r | |
83cbd279 | 159 | } TCP_PEER;\r |
160 | \r | |
dfc1f033 | 161 | ///\r |
162 | /// TCP control block, it includes various states\r | |
163 | ///\r | |
83cbd279 | 164 | struct _TCP_CB {\r |
dfc1f033 | 165 | LIST_ENTRY List; ///< Back and forward link entry\r |
166 | TCP_CB *Parent; ///< The parent TCP_CB structure\r | |
83cbd279 | 167 | \r |
dfc1f033 | 168 | SOCKET *Sk; ///< The socket it controled.\r |
169 | TCP_PEER LocalEnd; ///< Local endpoint\r | |
170 | TCP_PEER RemoteEnd;///< Remote endpoint\r | |
83cbd279 | 171 | \r |
dfc1f033 | 172 | LIST_ENTRY SndQue; ///< Retxmission queue\r |
173 | LIST_ENTRY RcvQue; ///< Reassemble queue\r | |
174 | UINT32 CtrlFlag; ///< Control flags, such as NO_NAGLE\r | |
175 | INT32 Error; ///< Soft error status, such as TCP_CONNECT_RESET\r | |
83cbd279 | 176 | \r |
177 | //\r | |
178 | // RFC793 and RFC1122 defined variables\r | |
179 | //\r | |
276dcc1b | 180 | UINT8 State; ///< TCP state, such as SYN_SENT, LISTEN\r |
dfc1f033 | 181 | UINT8 DelayedAck; ///< Number of delayed ACKs\r |
182 | UINT16 HeadSum; ///< Checksum of the fixed parts of pesudo\r | |
183 | ///< header: Src IP, Dst IP, 0, Protocol,\r | |
184 | ///< not include the TCP length.\r | |
185 | \r | |
186 | TCP_SEQNO Iss; ///< Initial Sending Sequence\r | |
187 | TCP_SEQNO SndUna; ///< First unacknowledged data\r | |
188 | TCP_SEQNO SndNxt; ///< Next data sequence to send.\r | |
189 | TCP_SEQNO SndPsh; ///< Send PUSH point\r | |
190 | TCP_SEQNO SndUp; ///< Send urgent point\r | |
191 | UINT32 SndWnd; ///< Window advertised by the remote peer\r | |
192 | UINT32 SndWndMax; ///< Max send window advertised by the peer\r | |
193 | TCP_SEQNO SndWl1; ///< Seq number used for last window update\r | |
194 | TCP_SEQNO SndWl2; ///< Ack no of last window update\r | |
195 | UINT16 SndMss; ///< Max send segment size\r | |
196 | TCP_SEQNO RcvNxt; ///< Next sequence no to receive\r | |
197 | UINT32 RcvWnd; ///< Window advertised by the local peer\r | |
198 | TCP_SEQNO RcvWl2; ///< The RcvNxt (or ACK) of last window update.\r | |
199 | ///< It is necessary because of delayed ACK\r | |
200 | \r | |
201 | TCP_SEQNO RcvUp; ///< Urgent point;\r | |
202 | TCP_SEQNO Irs; ///< Initial Receiving Sequence\r | |
203 | UINT16 RcvMss; ///< Max receive segment size\r | |
204 | UINT16 EnabledTimer; ///< Which timer is currently enabled\r | |
205 | UINT32 Timer[TCP_TIMER_NUMBER]; ///< When the timer will expire\r | |
206 | INT32 NextExpire; ///< Count down offset for the nearest timer\r | |
207 | UINT32 Idle; ///< How long the connection is in idle\r | |
208 | UINT32 ProbeTime; ///< The time out value for current window prober\r | |
ac8cca2a | 209 | BOOLEAN ProbeTimerOn;///< If TRUE, the probe time is on.\r |
83cbd279 | 210 | \r |
211 | //\r | |
212 | // RFC1323 defined variables, about window scale,\r | |
213 | // timestamp and PAWS\r | |
214 | //\r | |
dfc1f033 | 215 | UINT8 SndWndScale; ///< Wndscale received from the peer\r |
216 | UINT8 RcvWndScale; ///< Wndscale used to scale local buffer\r | |
217 | UINT32 TsRecent; ///< TsRecent to echo to the remote peer\r | |
218 | UINT32 TsRecentAge; ///< When this TsRecent is updated\r | |
83cbd279 | 219 | \r |
220 | //\r | |
221 | // RFC2988 defined variables. about RTT measurement\r | |
222 | //\r | |
dfc1f033 | 223 | TCP_SEQNO RttSeq; ///< The seq of measured segment now\r |
224 | UINT32 RttMeasure; ///< Currently measured RTT in heart beats\r | |
225 | UINT32 SRtt; ///< Smoothed RTT, scaled by 8\r | |
226 | UINT32 RttVar; ///< RTT variance, scaled by 8\r | |
227 | UINT32 Rto; ///< Current RTO, not scaled\r | |
83cbd279 | 228 | \r |
229 | //\r | |
230 | // RFC2581, and 3782 variables.\r | |
231 | // Congestion control + NewReno fast recovery.\r | |
232 | //\r | |
dfc1f033 | 233 | UINT32 CWnd; ///< Sender's congestion window\r |
234 | UINT32 Ssthresh; ///< Slow start threshold.\r | |
235 | TCP_SEQNO Recover; ///< Recover point for NewReno\r | |
236 | UINT16 DupAck; ///< Number of duplicate ACKs\r | |
237 | UINT8 CongestState; ///< The current congestion state(RFC3782)\r | |
238 | UINT8 LossTimes; ///< Number of retxmit timeouts in a row\r | |
239 | TCP_SEQNO LossRecover; ///< Recover point for retxmit\r | |
83cbd279 | 240 | \r |
241 | //\r | |
242 | // configuration parameters, for EFI_TCP4_PROTOCOL specification\r | |
243 | //\r | |
dfc1f033 | 244 | UINT32 KeepAliveIdle; ///< Idle time before sending first probe\r |
245 | UINT32 KeepAlivePeriod; ///< Interval for subsequent keep alive probe\r | |
246 | UINT8 MaxKeepAlive; ///< Maxium keep alive probe times.\r | |
247 | UINT8 KeepAliveProbes; ///< The number of keep alive probe.\r | |
248 | UINT16 MaxRexmit; ///< The maxium number of retxmit before abort\r | |
249 | UINT32 FinWait2Timeout; ///< The FIN_WAIT_2 time out\r | |
250 | UINT32 TimeWaitTimeout; ///< The TIME_WAIT time out\r | |
251 | UINT32 ConnectTimeout; ///< The connect establishment time out\r | |
83cbd279 | 252 | \r |
253 | //\r | |
254 | // configuration for tcp provided by user\r | |
255 | //\r | |
256 | BOOLEAN UseDefaultAddr;\r | |
a78d176c | 257 | UINT8 Tos;\r |
258 | UINT8 Ttl;\r | |
83cbd279 | 259 | EFI_IPv4_ADDRESS SubnetMask;\r |
260 | \r | |
dfc1f033 | 261 | IP_IO_IP_INFO *IpInfo; ///<pointer reference to Ip used to send pkt\r |
83cbd279 | 262 | };\r |
263 | \r | |
e48e37fc | 264 | extern LIST_ENTRY mTcpRunQue;\r |
265 | extern LIST_ENTRY mTcpListenQue;\r | |
83cbd279 | 266 | extern TCP_SEQNO mTcpGlobalIss;\r |
267 | extern UINT32 mTcpTick;\r | |
268 | \r | |
dfc1f033 | 269 | ///\r |
270 | /// TCP_CONNECTED: both ends have synchronized their ISN.\r | |
271 | ///\r | |
83cbd279 | 272 | #define TCP_CONNECTED(state) ((state) > TCP_SYN_RCVD)\r |
273 | \r | |
274 | #define TCP_FIN_RCVD(State) \\r | |
275 | (((State) == TCP_CLOSE_WAIT) || \\r | |
276 | ((State) == TCP_LAST_ACK) || \\r | |
277 | ((State) == TCP_CLOSING) || \\r | |
278 | ((State) == TCP_TIME_WAIT))\r | |
279 | \r | |
280 | #define TCP_LOCAL_CLOSED(State) \\r | |
281 | (((State) == TCP_FIN_WAIT_1) || \\r | |
282 | ((State) == TCP_FIN_WAIT_2) || \\r | |
283 | ((State) == TCP_CLOSING) || \\r | |
284 | ((State) == TCP_TIME_WAIT) || \\r | |
285 | ((State) == TCP_LAST_ACK))\r | |
286 | \r | |
287 | //\r | |
288 | // Get the TCP_SEG point from a net buffer's ProtoData\r | |
289 | //\r | |
290 | #define TCPSEG_NETBUF(NBuf) ((TCP_SEG *) ((NBuf)->ProtoData))\r | |
291 | \r | |
292 | //\r | |
293 | // macros to compare sequence no\r | |
294 | //\r | |
295 | #define TCP_SEQ_LT(SeqA, SeqB) ((INT32) ((SeqA) - (SeqB)) < 0)\r | |
296 | #define TCP_SEQ_LEQ(SeqA, SeqB) ((INT32) ((SeqA) - (SeqB)) <= 0)\r | |
297 | #define TCP_SEQ_GT(SeqA, SeqB) ((INT32) ((SeqB) - (SeqA)) < 0)\r | |
298 | #define TCP_SEQ_GEQ(SeqA, SeqB) ((INT32) ((SeqB) - (SeqA)) <= 0)\r | |
299 | \r | |
300 | //\r | |
301 | // TCP_SEQ_BETWEEN return whether b <= m <= e\r | |
302 | //\r | |
303 | #define TCP_SEQ_BETWEEN(b, m, e) ((e) - (b) >= (m) - (b))\r | |
304 | \r | |
305 | //\r | |
306 | // TCP_SUB_SEQ returns Seq1 - Seq2. Make sure Seq1 >= Seq2\r | |
307 | //\r | |
308 | #define TCP_SUB_SEQ(Seq1, Seq2) ((UINT32) ((Seq1) - (Seq2)))\r | |
309 | \r | |
dab714aa | 310 | //\r |
311 | // Check whether Flag is on\r | |
312 | //\r | |
83cbd279 | 313 | #define TCP_FLG_ON(Value, Flag) ((BOOLEAN) (((Value) & (Flag)) != 0))\r |
dab714aa | 314 | \r |
315 | //\r | |
316 | // Set and Clear operation on a Flag\r | |
317 | //\r | |
83cbd279 | 318 | #define TCP_SET_FLG(Value, Flag) ((Value) |= (Flag))\r |
319 | #define TCP_CLEAR_FLG(Value, Flag) ((Value) &= ~(Flag))\r | |
320 | \r | |
321 | //\r | |
dab714aa | 322 | // Test whether two peers are equal\r |
83cbd279 | 323 | //\r |
324 | #define TCP_PEER_EQUAL(Pa, Pb) \\r | |
325 | (((Pa)->Ip == (Pb)->Ip) && ((Pa)->Port == (Pb)->Port))\r | |
326 | \r | |
327 | //\r | |
dab714aa | 328 | // Test whether Pa matches Pb, or Pa is more specific\r |
83cbd279 | 329 | // than pb. Zero means wildcard.\r |
330 | //\r | |
331 | #define TCP_PEER_MATCH(Pa, Pb) \\r | |
332 | ((((Pb)->Ip == 0) || ((Pb)->Ip == (Pa)->Ip)) && \\r | |
333 | (((Pb)->Port == 0) || ((Pb)->Port == (Pa)->Port)))\r | |
334 | \r | |
335 | #define TCP_TIMER_ON(Flag, Timer) ((Flag) & (1 << (Timer)))\r | |
336 | #define TCP_SET_TIMER(Flag, Timer) ((Flag) = (UINT16) ((Flag) | (1 << (Timer))))\r | |
337 | #define TCP_CLEAR_TIMER(Flag, Timer) ((Flag) = (UINT16) ((Flag) & (~(1 << (Timer)))))\r | |
338 | \r | |
339 | #define TCP_TIME_LT(Ta, Tb) ((INT32) ((Ta) - (Tb)) < 0)\r | |
340 | #define TCP_TIME_LEQ(Ta, Tb) ((INT32) ((Ta) - (Tb)) <= 0)\r | |
341 | #define TCP_SUB_TIME(Ta, Tb) ((UINT32) ((Ta) - (Tb)))\r | |
342 | \r | |
343 | #define TCP_MAX_WIN 0xFFFFU\r | |
344 | \r | |
345 | typedef\r | |
346 | VOID\r | |
347 | (*TCP_TIMER_HANDLER) (\r | |
dab714aa | 348 | IN OUT TCP_CB *Tcb\r |
83cbd279 | 349 | );\r |
350 | \r | |
83cbd279 | 351 | #endif\r |