tcp.h
Go to the documentation of this file.
1 /**
2  * @file tcp.h
3  * @brief TCP (Transmission Control Protocol)
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2020 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.0.0
29  **/
30 
31 #ifndef _TCP_H
32 #define _TCP_H
33 
34 //Dependencies
35 #include "net_config.h"
36 #include "core/ip.h"
37 
38 //TCP support
39 #ifndef TCP_SUPPORT
40  #define TCP_SUPPORT ENABLED
41 #elif (TCP_SUPPORT != ENABLED && TCP_SUPPORT != DISABLED)
42  #error TCP_SUPPORT parameter is not valid
43 #endif
44 
45 //TCP tick interval
46 #ifndef TCP_TICK_INTERVAL
47  #define TCP_TICK_INTERVAL 100
48 #elif (TCP_TICK_INTERVAL < 10)
49  #error TCP_TICK_INTERVAL parameter is not valid
50 #endif
51 
52 //Maximum segment size
53 #ifndef TCP_MAX_MSS
54  #define TCP_MAX_MSS 1430
55 #elif (TCP_MAX_MSS < 536)
56  #error TCP_MAX_MSS parameter is not valid
57 #endif
58 
59 //Mimimum acceptable segment size
60 #ifndef TCP_MIN_MSS
61  #define TCP_MIN_MSS 64
62 #elif (TCP_MIN_MSS < 1)
63  #error TCP_MIN_MSS parameter is not valid
64 #endif
65 
66 //Default buffer size for transmission
67 #ifndef TCP_DEFAULT_TX_BUFFER_SIZE
68  #define TCP_DEFAULT_TX_BUFFER_SIZE 2860
69 #elif (TCP_DEFAULT_TX_BUFFER_SIZE < 536)
70  #error TCP_DEFAULT_TX_BUFFER_SIZE parameter is not valid
71 #endif
72 
73 //Maximum acceptable size for the send buffer
74 #ifndef TCP_MAX_TX_BUFFER_SIZE
75  #define TCP_MAX_TX_BUFFER_SIZE 22880
76 #elif (TCP_MAX_TX_BUFFER_SIZE < 536)
77  #error TCP_MAX_TX_BUFFER_SIZE parameter is not valid
78 #endif
79 
80 //Default buffer size for reception
81 #ifndef TCP_DEFAULT_RX_BUFFER_SIZE
82  #define TCP_DEFAULT_RX_BUFFER_SIZE 2860
83 #elif (TCP_DEFAULT_RX_BUFFER_SIZE < 536)
84  #error TCP_DEFAULT_RX_BUFFER_SIZE parameter is not valid
85 #endif
86 
87 //Maximum acceptable size for the receive buffer
88 #ifndef TCP_MAX_RX_BUFFER_SIZE
89  #define TCP_MAX_RX_BUFFER_SIZE 22880
90 #elif (TCP_MAX_RX_BUFFER_SIZE < 536)
91  #error TCP_MAX_RX_BUFFER_SIZE parameter is not valid
92 #endif
93 
94 //Default SYN queue size for listening sockets
95 #ifndef TCP_DEFAULT_SYN_QUEUE_SIZE
96  #define TCP_DEFAULT_SYN_QUEUE_SIZE 4
97 #elif (TCP_DEFAULT_SYN_QUEUE_SIZE < 1)
98  #error TCP_DEFAULT_SYN_QUEUE_SIZE parameter is not valid
99 #endif
100 
101 //Maximum SYN queue size for listening sockets
102 #ifndef TCP_MAX_SYN_QUEUE_SIZE
103  #define TCP_MAX_SYN_QUEUE_SIZE 16
104 #elif (TCP_MAX_SYN_QUEUE_SIZE < 1)
105  #error TCP_MAX_SYN_QUEUE_SIZE parameter is not valid
106 #endif
107 
108 //Maximum number of retransmissions
109 #ifndef TCP_MAX_RETRIES
110  #define TCP_MAX_RETRIES 5
111 #elif (TCP_MAX_RETRIES < 1)
112  #error TCP_MAX_RETRIES parameter is not valid
113 #endif
114 
115 //Initial retransmission timeout
116 #ifndef TCP_INITIAL_RTO
117  #define TCP_INITIAL_RTO 1000
118 #elif (TCP_INITIAL_RTO < 100)
119  #error TCP_INITIAL_RTO parameter is not valid
120 #endif
121 
122 //Minimum retransmission timeout
123 #ifndef TCP_MIN_RTO
124  #define TCP_MIN_RTO 1000
125 #elif (TCP_MIN_RTO < 100)
126  #error TCP_MIN_RTO parameter is not valid
127 #endif
128 
129 //Maximum retransmission timeout
130 #ifndef TCP_MAX_RTO
131  #define TCP_MAX_RTO 60000
132 #elif (TCP_MAX_RTO < 1000)
133  #error TCP_MAX_RTO parameter is not valid
134 #endif
135 
136 //Secure initial sequence number generation
137 #ifndef TCP_SECURE_ISN_SUPPORT
138  #define TCP_SECURE_ISN_SUPPORT DISABLED
139 #elif (TCP_SECURE_ISN_SUPPORT != ENABLED && TCP_SECURE_ISN_SUPPORT != DISABLED)
140  #error TCP_SECURE_ISN_SUPPORT parameter is not valid
141 #endif
142 
143 //TCP congestion control
144 #ifndef TCP_CONGEST_CONTROL_SUPPORT
145  #define TCP_CONGEST_CONTROL_SUPPORT ENABLED
146 #elif (TCP_CONGEST_CONTROL_SUPPORT != ENABLED && TCP_CONGEST_CONTROL_SUPPORT != DISABLED)
147  #error TCP_CONGEST_CONTROL_SUPPORT parameter is not valid
148 #endif
149 
150 //Number of duplicate ACKs that triggers fast retransmit algorithm
151 #ifndef TCP_FAST_RETRANSMIT_THRES
152  #define TCP_FAST_RETRANSMIT_THRES 3
153 #elif (TCP_FAST_RETRANSMIT_THRES < 1)
154  #error TCP_FAST_RETRANSMIT_THRES parameter is not valid
155 #endif
156 
157 //Size of the congestion window after the three-way handshake is completed
158 #ifndef TCP_INITIAL_WINDOW
159  #define TCP_INITIAL_WINDOW 3
160 #elif (TCP_INITIAL_WINDOW < 1)
161  #error TCP_INITIAL_WINDOW parameter is not valid
162 #endif
163 
164 //Size of the congestion window after TCP detects loss using its retransmission timer
165 #ifndef TCP_LOSS_WINDOW
166  #define TCP_LOSS_WINDOW 1
167 #elif (TCP_LOSS_WINDOW < 1)
168  #error TCP_LOSS_WINDOW parameter is not valid
169 #endif
170 
171 //Default interval between successive window probes
172 #ifndef TCP_DEFAULT_PROBE_INTERVAL
173  #define TCP_DEFAULT_PROBE_INTERVAL 1000
174 #elif (TCP_DEFAULT_PROBE_INTERVAL < 100)
175  #error TCP_DEFAULT_PROBE_INTERVAL parameter is not valid
176 #endif
177 
178 //Maximum interval between successive window probes
179 #ifndef TCP_MAX_PROBE_INTERVAL
180  #define TCP_MAX_PROBE_INTERVAL 60000
181 #elif (TCP_MAX_PROBE_INTERVAL < 1000)
182  #error TCP_MAX_PROBE_INTERVAL parameter is not valid
183 #endif
184 
185 //Override timeout (should be in the range 0.1 to 1 seconds)
186 #ifndef TCP_OVERRIDE_TIMEOUT
187  #define TCP_OVERRIDE_TIMEOUT 500
188 #elif (TCP_OVERRIDE_TIMEOUT < 100)
189  #error TCP_OVERRIDE_TIMEOUT parameter is not valid
190 #endif
191 
192 //FIN-WAIT-2 timer
193 #ifndef TCP_FIN_WAIT_2_TIMER
194  #define TCP_FIN_WAIT_2_TIMER 4000
195 #elif (TCP_FIN_WAIT_2_TIMER < 1000)
196  #error TCP_FIN_WAIT_2_TIMER parameter is not valid
197 #endif
198 
199 //TIME-WAIT timer
200 #ifndef TCP_2MSL_TIMER
201  #define TCP_2MSL_TIMER 4000
202 #elif (TCP_2MSL_TIMER < 0)
203  #error TCP_2MSL_TIMER parameter is not valid
204 #endif
205 
206 //Selective acknowledgment support
207 #ifndef TCP_SACK_SUPPORT
208  #define TCP_SACK_SUPPORT DISABLED
209 #elif (TCP_SACK_SUPPORT != ENABLED && TCP_SACK_SUPPORT != DISABLED)
210  #error TCP_SACK_SUPPORT parameter is not valid
211 #endif
212 
213 //Number of SACK blocks
214 #ifndef TCP_MAX_SACK_BLOCKS
215  #define TCP_MAX_SACK_BLOCKS 4
216 #elif (TCP_MAX_SACK_BLOCKS < 1)
217  #error TCP_MAX_SACK_BLOCKS parameter is not valid
218 #endif
219 
220 //Maximum TCP header length
221 #define TCP_MAX_HEADER_LENGTH 60
222 //Default maximum segment size
223 #define TCP_DEFAULT_MSS 536
224 
225 //Sequence number comparison macro
226 #define TCP_CMP_SEQ(a, b) ((int32_t) ((a) - (b)))
227 
228 //C++ guard
229 #ifdef __cplusplus
230 extern "C" {
231 #endif
232 
233 
234 /**
235  * @brief TCP FSM states
236  **/
237 
238 typedef enum
239 {
252 
253 
254 /**
255  * @brief TCP congestion states
256  **/
257 
258 typedef enum
259 {
264 
265 
266 /**
267  * @brief TCP control flags
268  **/
269 
270 typedef enum
271 {
272  TCP_FLAG_FIN = 0x01,
273  TCP_FLAG_SYN = 0x02,
274  TCP_FLAG_RST = 0x04,
275  TCP_FLAG_PSH = 0x08,
276  TCP_FLAG_ACK = 0x10,
277  TCP_FLAG_URG = 0x20
279 
280 
281 /**
282  * @brief TCP option types
283  **/
284 
285 typedef enum
286 {
295 
296 
297 //CodeWarrior or Win32 compiler?
298 #if defined(__CWCC__) || defined(_WIN32)
299  #pragma pack(push, 1)
300 #endif
301 
302 
303 /**
304  * @brief TCP header
305  **/
306 
307 typedef __start_packed struct
308 {
309  uint16_t srcPort; //0-1
310  uint16_t destPort; //2-3
311  uint32_t seqNum; //4-7
312  uint32_t ackNum; //8-11
313 #if defined(_CPU_BIG_ENDIAN) && !defined(__IAR_SYSTEMS_ICC__)
314  uint8_t dataOffset : 4; //12
315  uint8_t reserved1 : 4;
316  uint8_t reserved2 : 2; //13
317  uint8_t flags : 6;
318 #else
319  uint8_t reserved1 : 4; //12
320  uint8_t dataOffset : 4;
321  uint8_t flags : 6; //13
322  uint8_t reserved2 : 2;
323 #endif
324  uint16_t window; //14-15
325  uint16_t checksum; //16-17
326  uint16_t urgentPointer; //18-19
327  uint8_t options[]; //20
329 
330 
331 /**
332  * @brief TCP option
333  **/
334 
335 typedef __start_packed struct
336 {
337  uint8_t kind;
338  uint8_t length;
339  uint8_t value[];
341 
342 
343 //CodeWarrior or Win32 compiler?
344 #if defined(__CWCC__) || defined(_WIN32)
345  #pragma pack(pop)
346 #endif
347 
348 
349 /**
350  * @brief TCP timer
351  **/
352 
353 typedef struct
354 {
358 } TcpTimer;
359 
360 
361 /**
362  * @brief Retransmission queue item
363  **/
364 
365 typedef struct _TcpQueueItem
366 {
373 
374 
375 /**
376  * @brief SYN queue item
377  **/
378 
379 typedef struct _TcpSynQueueItem
380 {
384  uint16_t srcPort;
386  uint32_t isn;
387  uint16_t mss;
389 
390 
391 /**
392  * @brief SACK block
393  **/
394 
395 typedef struct
396 {
397  uint32_t leftEdge;
398  uint32_t rightEdge;
399 } TcpSackBlock;
400 
401 
402 /**
403  * @brief Transmit buffer
404  **/
405 
406 typedef struct
407 {
411 } TcpTxBuffer;
412 
413 
414 /**
415  * @brief Receive buffer
416  **/
417 
418 typedef struct
419 {
423 } TcpRxBuffer;
424 
425 
426 //Tick counter to handle periodic operations
428 
429 //TCP related functions
430 error_t tcpInit(void);
431 uint16_t tcpGetDynamicPort(void);
432 
433 error_t tcpConnect(Socket *socket, const IpAddr *remoteIpAddr, uint16_t remotePort);
435 Socket *tcpAccept(Socket *socket, IpAddr *clientIpAddr, uint16_t *clientPort);
436 
437 error_t tcpSend(Socket *socket, const uint8_t *data,
438  size_t length, size_t *written, uint_t flags);
439 
440 error_t tcpReceive(Socket *socket, uint8_t *data,
441  size_t size, size_t *received, uint_t flags);
442 
445 
447 
449 
450 //C++ guard
451 #ifdef __cplusplus
452 }
453 #endif
454 
455 #endif
@ TCP_CONGEST_STATE_IDLE
Definition: tcp.h:260
Retransmission queue item.
Definition: tcp.h:366
@ TCP_STATE_TIME_WAIT
Definition: tcp.h:250
int bool_t
Definition: compiler_port.h:49
uint_t chunkCount
Definition: tcp.h:408
#define TCP_MAX_HEADER_LENGTH
Definition: tcp.h:221
uint_t sacked
Definition: tcp.h:369
uint8_t data[]
Definition: ethernet.h:209
uint8_t header[TCP_MAX_HEADER_LENGTH]
Definition: tcp.h:371
error_t tcpReceive(Socket *socket, uint8_t *data, size_t size, size_t *received, uint_t flags)
Receive data from a connected socket.
Definition: tcp.c:581
@ TCP_OPTION_END
Definition: tcp.h:287
IP network address.
Definition: ip.h:79
TcpCongestState
TCP congestion states.
Definition: tcp.h:259
@ TCP_FLAG_FIN
Definition: tcp.h:272
uint16_t checksum
Definition: tcp.h:325
@ TCP_STATE_FIN_WAIT_1
Definition: tcp.h:247
uint16_t mss
Definition: tcp.h:387
IpAddr srcAddr
Definition: tcp.h:383
TcpFlags
TCP control flags.
Definition: tcp.h:271
uint32_t rightEdge
Definition: tcp.h:398
@ TCP_STATE_CLOSE_WAIT
Definition: tcp.h:245
IpAddr destAddr
Definition: tcp.h:385
uint16_t destPort
Definition: tcp.h:310
uint16_t srcPort
Definition: tcp.h:384
struct _TcpSynQueueItem * next
Definition: tcp.h:381
systime_t interval
Definition: tcp.h:357
@ TCP_FLAG_ACK
Definition: tcp.h:276
uint16_t window
Definition: tcp.h:324
#define N(size)
Definition: net_mem.h:64
uint_t length
Definition: tcp.h:368
@ TCP_OPTION_WINDOW_SCALE_FACTOR
Definition: tcp.h:290
IP pseudo header.
Definition: ip.h:98
TcpOptionKind
TCP option types.
Definition: tcp.h:286
TcpState
TCP FSM states.
Definition: tcp.h:239
uint_t chunkCount
Definition: tcp.h:420
@ TCP_OPTION_SACK_PERMITTED
Definition: tcp.h:291
error_t
Error codes.
Definition: error.h:43
uint32_t seqNum
Definition: tcp.h:311
Structure describing a chunk of data.
Definition: net_mem.h:77
@ TCP_OPTION_TIMESTAMP
Definition: tcp.h:293
error_t tcpListen(Socket *socket, uint_t backlog)
Place a socket in the listening state.
Definition: tcp.c:240
#define TCP_MAX_RX_BUFFER_SIZE
Definition: tcp.h:89
struct _TcpQueueItem * next
Definition: tcp.h:367
TcpState tcpGetState(Socket *socket)
Get the current state of the TCP FSM.
Definition: tcp.c:944
@ TCP_CONGEST_STATE_LOSS_RECOVERY
Definition: tcp.h:262
int_t socket(int_t family, int_t type, int_t protocol)
Create a socket that is bound to a specific transport service provider.
Definition: bsd_socket.c:108
uint8_t value[]
Definition: tcp.h:339
uint8_t reserved1
Definition: tcp.h:319
__start_packed struct @1 TcpOption
TCP option.
#define NetInterface
Definition: net.h:36
NetInterface * interface
Definition: tcp.h:382
systime_t tcpTickCounter
Definition: tcp.c:49
uint8_t options[]
Definition: tcp.h:327
struct _TcpSynQueueItem TcpSynQueueItem
SYN queue item.
__start_packed struct _Ipv4Header __end_packed
error_t tcpAbort(Socket *socket)
Abort an existing TCP connection.
Definition: tcp.c:880
@ TCP_CONGEST_STATE_RECOVERY
Definition: tcp.h:261
uint8_t kind
Definition: tcp.h:337
uint16_t tcpGetDynamicPort(void)
Get an ephemeral port number.
Definition: tcp.c:75
@ TCP_STATE_SYN_SENT
Definition: tcp.h:242
struct _TcpQueueItem TcpQueueItem
Retransmission queue item.
@ TCP_FLAG_RST
Definition: tcp.h:274
uint_t maxChunkCount
Definition: tcp.h:421
@ TCP_FLAG_SYN
Definition: tcp.h:273
uint32_t isn
Definition: tcp.h:386
@ TCP_STATE_LAST_ACK
Definition: tcp.h:246
@ TCP_OPTION_NOP
Definition: tcp.h:288
@ TCP_STATE_CLOSING
Definition: tcp.h:249
#define TCP_MAX_TX_BUFFER_SIZE
Definition: tcp.h:75
@ TCP_STATE_CLOSED
Definition: tcp.h:240
@ TCP_STATE_LISTEN
Definition: tcp.h:241
uint8_t flags
Definition: tcp.h:321
IpPseudoHeader pseudoHeader
Definition: tcp.h:370
systime_t startTime
Definition: tcp.h:356
SACK block.
Definition: tcp.h:396
@ TCP_OPTION_SACK
Definition: tcp.h:292
uint32_t ackNum
Definition: tcp.h:312
IPv4 and IPv6 common routines.
@ TCP_FLAG_URG
Definition: tcp.h:277
__start_packed struct @0 TcpHeader
TCP header.
#define Socket
Definition: socket.h:36
@ TCP_STATE_FIN_WAIT_2
Definition: tcp.h:248
TCP timer.
Definition: tcp.h:354
uint8_t dataOffset
Definition: tcp.h:320
bool_t running
Definition: tcp.h:355
uint32_t leftEdge
Definition: tcp.h:397
uint8_t reserved2
Definition: tcp.h:322
@ TCP_STATE_SYN_RECEIVED
Definition: tcp.h:243
SYN queue item.
Definition: tcp.h:380
error_t tcpInit(void)
TCP related initialization.
Definition: tcp.c:60
uint_t maxChunkCount
Definition: tcp.h:409
error_t tcpConnect(Socket *socket, const IpAddr *remoteIpAddr, uint16_t remotePort)
Establish a TCP connection.
Definition: tcp.c:115
uint16_t srcPort
Definition: tcp.h:309
@ TCP_OPTION_MAX_SEGMENT_SIZE
Definition: tcp.h:289
Receive buffer.
Definition: tcp.h:419
Transmit buffer.
Definition: tcp.h:407
unsigned int uint_t
Definition: compiler_port.h:45
Socket * tcpAccept(Socket *socket, IpAddr *clientIpAddr, uint16_t *clientPort)
Permit an incoming connection attempt on a TCP socket.
Definition: tcp.c:267
uint32_t systime_t
Definition: compiler_port.h:46
@ TCP_STATE_ESTABLISHED
Definition: tcp.h:244
uint8_t length
Definition: tcp.h:338
error_t tcpShutdown(Socket *socket, uint_t how)
Shutdown gracefully reception, transmission, or both.
Definition: tcp.c:729
Socket * tcpKillOldestConnection(void)
Kill the oldest socket in the TIME-WAIT state.
Definition: tcp.c:968
uint16_t urgentPointer
Definition: tcp.h:326
error_t tcpSend(Socket *socket, const uint8_t *data, size_t length, size_t *written, uint_t flags)
Send data to a connected socket.
Definition: tcp.c:456
@ TCP_FLAG_PSH
Definition: tcp.h:275