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-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
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 1.9.8
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);
47  IpPseudoHeader *pseudoHeader, TcpHeader *segment, size_t length);
49 error_t tcpAddOption(TcpHeader *segment, uint8_t kind, const void *value,
50  uint8_t length);
52 TcpOption *tcpGetOption(TcpHeader *segment, uint8_t kind);
55 error_t tcpCheckSyn(Socket *socket, TcpHeader *segment, size_t length);
56 error_t tcpCheckAck(Socket *socket, TcpHeader *segment, size_t length);
59  TcpHeader *segment);
64 void tcpFastRecovery(Socket *socket, TcpHeader *segment, uint_t n);
68  const NetBuffer *buffer, size_t offset, size_t length);
77 void tcpUpdateSackBlocks(Socket *socket, uint32_t *leftEdge, uint32_t *rightEdge);
85 void tcpChangeState(Socket *socket, TcpState newState);
88 uint_t tcpWaitForEvents(Socket *socket, uint_t eventMask, systime_t timeout);
90 void tcpWriteTxBuffer(Socket *socket, uint32_t seqNum,
91  const uint8_t *data, size_t length);
94  NetBuffer *buffer, size_t length);
96 void tcpWriteRxBuffer(Socket *socket, uint32_t seqNum,
97  const NetBuffer *data, size_t dataOffset, size_t length);
99 void tcpReadRxBuffer(Socket *socket, uint32_t seqNum, uint8_t *data,
100  size_t length);
102 void tcpDumpHeader(const TcpHeader *segment, size_t length, uint32_t iss,
103  uint32_t irs);
105 //C++ guard
106 #ifdef __cplusplus
107 }
108 #endif
110 #endif
uint8_t length
Definition: coap_common.h:190
uint_t tcpWaitForEvents(Socket *socket, uint_t eventMask, systime_t timeout)
Wait for a particular TCP event.
Definition: tcp_misc.c:1928
int bool_t
Definition: compiler_port.h:49
__start_packed struct @18 TcpHeader
TCP header.
uint8_t data[]
Definition: ethernet.h:209
bool_t tcpIsDuplicateAck(Socket *socket, TcpHeader *segment, size_t length)
Test whether the incoming acknowledgment is a duplicate.
Definition: tcp_misc.c:921
void tcpUpdateEvents(Socket *socket)
Update TCP related events.
Definition: tcp_misc.c:1799
void tcpFlushRetransmitQueue(Socket *socket)
Flush retransmission queue.
Definition: tcp_misc.c:1253
Structure describing a buffer that spans multiple chunks.
Definition: net_mem.h:88
void tcpChangeState(Socket *socket, TcpState newState)
Update TCP FSM current state.
Definition: tcp_misc.c:1768
void tcpFastRetransmit(Socket *socket)
Fast retransmit procedure.
Definition: tcp_misc.c:963
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:1966
void tcpFastLossRecovery(Socket *socket, TcpHeader *segment)
Fast loss recovery procedure.
Definition: tcp_misc.c:1051
error_t tcpRetransmitSegment(Socket *socket)
TCP segment retransmission.
Definition: tcp_misc.c:1519
bool_t tcpIsDuplicateSyn(Socket *socket, IpPseudoHeader *pseudoHeader, TcpHeader *segment)
Test whether the incoming SYN segment is a duplicate.
Definition: tcp_misc.c:845
void tcpReadRxBuffer(Socket *socket, uint32_t seqNum, uint8_t *data, size_t length)
Copy data from the receive buffer.
Definition: tcp_misc.c:2077
void tcpDeleteControlBlock(Socket *socket)
Delete TCB structure.
Definition: tcp_misc.c:1156
error_t tcpCheckSyn(Socket *socket, TcpHeader *segment, size_t length)
Check the SYN bit of an incoming segment.
Definition: tcp_misc.c:620
error_t tcpCheckSequenceNumber(Socket *socket, TcpHeader *segment, size_t length)
Test the sequence number of an incoming segment.
Definition: tcp_misc.c:551
IP pseudo header.
Definition: ip.h:97
TCP FSM states.
Definition: tcp.h:231
void tcpFastRecovery(Socket *socket, TcpHeader *segment, uint_t n)
Fast recovery procedure.
Definition: tcp_misc.c:1002
void tcpProcessSegmentData(Socket *socket, TcpHeader *segment, const NetBuffer *buffer, size_t offset, size_t length)
Process the segment text.
Definition: tcp_misc.c:1089
Error codes.
Definition: error.h:42
uint32_t seqNum
Definition: tcp.h:304
error_t tcpReadTxBuffer(Socket *socket, uint32_t seqNum, NetBuffer *buffer, size_t length)
Copy data from the send buffer.
Definition: tcp_misc.c:2000
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:332
error_t tcpSendResetSegment(NetInterface *interface, IpPseudoHeader *pseudoHeader, TcpHeader *segment, size_t length)
Send a TCP reset in response to an invalid segment.
Definition: tcp_misc.c:305
#define NetInterface
Definition: net.h:36
bool_t tcpComputeRto(Socket *socket)
Compute retransmission timeout.
Definition: tcp_misc.c:1450
NetInterface * interface
Definition: tcp.h:375
void tcpUpdateRetransmitQueue(Socket *socket)
Remove acknowledged segments from retransmission queue.
Definition: tcp_misc.c:1177
uint8_t kind
Definition: tcp.h:330
TcpOption * tcpGetOption(TcpHeader *segment, uint8_t kind)
Find a specified option in a TCP segment.
Definition: tcp_misc.c:495
uint8_t flags
Definition: tcp.h:314
uint32_t ackNum
Definition: tcp.h:305
void tcpFlushSynQueue(Socket *socket)
Flush SYN queue.
Definition: tcp_misc.c:1282
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:65
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:2110
void tcpUpdateSendWindow(Socket *socket, TcpHeader *segment)
Update send window.
Definition: tcp_misc.c:1363
#define Socket
Definition: socket.h:36
uint8_t dataOffset
Definition: tcp.h:313
__start_packed struct @19 TcpOption
TCP option.
error_t tcpAddOption(TcpHeader *segment, uint8_t kind, const void *value, uint8_t length)
Append an option to a TCP segment.
Definition: tcp_misc.c:447
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:2044
unsigned int uint_t
Definition: compiler_port.h:45
error_t tcpCheckAck(Socket *socket, TcpHeader *segment, size_t length)
Test the ACK field of an incoming segment.
Definition: tcp_misc.c:654
uint32_t systime_t
Definition: compiler_port.h:46
error_t tcpNagleAlgo(Socket *socket, uint_t flags)
Nagle algorithm implementation.
Definition: tcp_misc.c:1639
void tcpUpdateReceiveWindow(Socket *socket)
Update receive window so as to avoid Silly Window Syndrome.
Definition: tcp_misc.c:1413
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:1310