Go to the documentation of this file.
1 /**
2  * @file tcp_misc.h
3  * @brief Helper functions for TCP
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2023 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
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 (
28  * @version 2.2.4
29  **/
31 #ifndef _TCP_MISC_H
32 #define _TCP_MISC_H
34 //Dependencies
35 #include "core/tcp.h"
37 //C++ guard
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
42 //TCP related functions
43 error_t tcpSendSegment(Socket *socket, uint8_t flags, uint32_t seqNum,
44  uint32_t ackNum, size_t length, bool_t addToQueue);
49  TcpHeader *segment, size_t length);
51 error_t tcpAddOption(TcpHeader *segment, uint8_t kind, const void *value,
52  uint8_t length);
54 TcpOption *tcpGetOption(TcpHeader *segment, uint8_t kind);
56 uint32_t tcpGenerateInitialSeqNum(const IpAddr *localIpAddr,
57  uint16_t localPort, const IpAddr *remoteIpAddr, uint16_t remotePort);
60 error_t tcpCheckSyn(Socket *socket, TcpHeader *segment, size_t length);
61 error_t tcpCheckAck(Socket *socket, TcpHeader *segment, size_t length);
64  TcpHeader *segment);
69 void tcpFastRecovery(Socket *socket, TcpHeader *segment, uint_t n);
73  const NetBuffer *buffer, size_t offset, size_t length);
82 void tcpUpdateSackBlocks(Socket *socket, uint32_t *leftEdge, uint32_t *rightEdge);
90 void tcpChangeState(Socket *socket, TcpState newState);
93 uint_t tcpWaitForEvents(Socket *socket, uint_t eventMask, systime_t timeout);
95 void tcpWriteTxBuffer(Socket *socket, uint32_t seqNum,
96  const uint8_t *data, size_t length);
99  NetBuffer *buffer, size_t length);
101 void tcpWriteRxBuffer(Socket *socket, uint32_t seqNum,
102  const NetBuffer *data, size_t dataOffset, size_t length);
104 void tcpReadRxBuffer(Socket *socket, uint32_t seqNum, uint8_t *data,
105  size_t length);
107 void tcpDumpHeader(const TcpHeader *segment, size_t length, uint32_t iss,
108  uint32_t irs);
110 //C++ guard
111 #ifdef __cplusplus
112 }
113 #endif
115 #endif
uint8_t length
Definition: coap_common.h:193
uint_t tcpWaitForEvents(Socket *socket, uint_t eventMask, systime_t timeout)
Wait for a particular TCP event.
Definition: tcp_misc.c:2157
int bool_t
Definition: compiler_port.h:53
uint8_t data[]
Definition: ethernet.h:220
IP network address.
Definition: ip.h:79
bool_t tcpIsDuplicateAck(Socket *socket, TcpHeader *segment, size_t length)
Test whether the incoming acknowledgment is a duplicate.
Definition: tcp_misc.c:1122
void tcpUpdateEvents(Socket *socket)
Update TCP related events.
Definition: tcp_misc.c:2009
void tcpFlushRetransmitQueue(Socket *socket)
Flush retransmission queue.
Definition: tcp_misc.c:1461
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:89
void tcpChangeState(Socket *socket, TcpState newState)
Update TCP FSM current state.
Definition: tcp_misc.c:1978
error_t tcpSendResetSegment(Socket *socket, uint32_t seqNum)
Send a TCP reset segment.
Definition: tcp_misc.c:364
void tcpFastRetransmit(Socket *socket)
Fast retransmit procedure.
Definition: tcp_misc.c:1164
void tcpWriteTxBuffer(Socket *socket, uint32_t seqNum, const uint8_t *data, size_t length)
Copy incoming data to the send buffer.
Definition: tcp_misc.c:2195
void tcpFastLossRecovery(Socket *socket, TcpHeader *segment)
Fast loss recovery procedure.
Definition: tcp_misc.c:1252
error_t tcpRetransmitSegment(Socket *socket)
TCP segment retransmission.
Definition: tcp_misc.c:1729
bool_t tcpIsDuplicateSyn(Socket *socket, IpPseudoHeader *pseudoHeader, TcpHeader *segment)
Test whether the incoming SYN segment is a duplicate.
Definition: tcp_misc.c:1046
void tcpReadRxBuffer(Socket *socket, uint32_t seqNum, uint8_t *data, size_t length)
Copy data from the receive buffer.
Definition: tcp_misc.c:2310
void tcpDeleteControlBlock(Socket *socket)
Delete TCB structure.
Definition: tcp_misc.c:1358
error_t tcpCheckSyn(Socket *socket, TcpHeader *segment, size_t length)
Check the SYN bit of an incoming segment.
Definition: tcp_misc.c:802
IP pseudo header.
Definition: ip.h:98
uint32_t tcpGenerateInitialSeqNum(const IpAddr *localIpAddr, uint16_t localPort, const IpAddr *remoteIpAddr, uint16_t remotePort)
Initial sequence number generation.
Definition: tcp_misc.c:675
TCP FSM states.
Definition: tcp.h:267
void tcpFastRecovery(Socket *socket, TcpHeader *segment, uint_t n)
Fast recovery procedure.
Definition: tcp_misc.c:1203
error_t tcpRejectSegment(NetInterface *interface, IpPseudoHeader *pseudoHeader, TcpHeader *segment, size_t length)
Send a TCP reset in response to an invalid segment.
Definition: tcp_misc.c:396
void tcpProcessSegmentData(Socket *socket, TcpHeader *segment, const NetBuffer *buffer, size_t offset, size_t length)
Process the segment text.
Definition: tcp_misc.c:1290
Error codes.
Definition: error.h:43
uint32_t seqNum
Definition: tcp.h:339
error_t tcpReadTxBuffer(Socket *socket, uint32_t seqNum, NetBuffer *buffer, size_t length)
Copy data from the send buffer.
Definition: tcp_misc.c:2231
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:63
uint8_t value[]
Definition: tcp.h:367
__start_packed struct @1 TcpOption
TCP option.
#define NetInterface
Definition: net.h:36
bool_t tcpComputeRto(Socket *socket)
Compute retransmission timeout.
Definition: tcp_misc.c:1660
NetInterface * interface
Definition: tcp.h:398
void tcpUpdateRetransmitQueue(Socket *socket)
Remove acknowledged segments from retransmission queue.
Definition: tcp_misc.c:1379
uint8_t kind
Definition: tcp.h:365
TcpOption * tcpGetOption(TcpHeader *segment, uint8_t kind)
Search the TCP header for a given option.
Definition: tcp_misc.c:609
uint32_t systime_t
System time.
uint8_t flags
Definition: tcp.h:349
uint32_t ackNum
Definition: tcp.h:340
void tcpFlushSynQueue(Socket *socket)
Flush SYN queue.
Definition: tcp_misc.c:1490
error_t tcpSendSegment(Socket *socket, uint8_t flags, uint32_t seqNum, uint32_t ackNum, size_t length, bool_t addToQueue)
Send a TCP segment.
Definition: tcp_misc.c:70
__start_packed struct @0 TcpHeader
TCP header.
uint8_t n
TCP (Transmission Control Protocol)
void tcpDumpHeader(const TcpHeader *segment, size_t length, uint32_t iss, uint32_t irs)
Dump TCP header for debugging purpose.
Definition: tcp_misc.c:2345
void tcpUpdateSendWindow(Socket *socket, TcpHeader *segment)
Update send window.
Definition: tcp_misc.c:1573
#define Socket
Definition: socket.h:36
uint8_t dataOffset
Definition: tcp.h:348
error_t tcpCheckSeqNum(Socket *socket, TcpHeader *segment, size_t length)
Test the sequence number of an incoming segment.
Definition: tcp_misc.c:711
error_t tcpAddOption(TcpHeader *segment, uint8_t kind, const void *value, uint8_t length)
Append an option to the TCP header.
Definition: tcp_misc.c:546
void tcpWriteRxBuffer(Socket *socket, uint32_t seqNum, const NetBuffer *data, size_t dataOffset, size_t length)
Copy incoming data to the receive buffer.
Definition: tcp_misc.c:2275
unsigned int uint_t
Definition: compiler_port.h:50
error_t tcpCheckAck(Socket *socket, TcpHeader *segment, size_t length)
Test the ACK field of an incoming segment.
Definition: tcp_misc.c:836
error_t tcpNagleAlgo(Socket *socket, uint_t flags)
Nagle algorithm implementation.
Definition: tcp_misc.c:1849
void tcpUpdateReceiveWindow(Socket *socket)
Update receive window so as to avoid Silly Window Syndrome.
Definition: tcp_misc.c:1623
void tcpUpdateSackBlocks(Socket *socket, uint32_t *leftEdge, uint32_t *rightEdge)
Update the list of non-contiguous blocks that have been received.
Definition: tcp_misc.c:1518