This library is deprecated.

Dependents:   HTTPClientStreamingExample HTTPClientExample HTTPServerExample HTTPServerHelloWorld ... more

Committer:
donatien
Date:
Fri Jun 11 16:25:22 2010 +0000
Revision:
0:422060928e37
Child:
5:bc7df6da7589

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:422060928e37 1 /*
donatien 0:422060928e37 2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
donatien 0:422060928e37 3 * All rights reserved.
donatien 0:422060928e37 4 *
donatien 0:422060928e37 5 * Redistribution and use in source and binary forms, with or without modification,
donatien 0:422060928e37 6 * are permitted provided that the following conditions are met:
donatien 0:422060928e37 7 *
donatien 0:422060928e37 8 * 1. Redistributions of source code must retain the above copyright notice,
donatien 0:422060928e37 9 * this list of conditions and the following disclaimer.
donatien 0:422060928e37 10 * 2. Redistributions in binary form must reproduce the above copyright notice,
donatien 0:422060928e37 11 * this list of conditions and the following disclaimer in the documentation
donatien 0:422060928e37 12 * and/or other materials provided with the distribution.
donatien 0:422060928e37 13 * 3. The name of the author may not be used to endorse or promote products
donatien 0:422060928e37 14 * derived from this software without specific prior written permission.
donatien 0:422060928e37 15 *
donatien 0:422060928e37 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
donatien 0:422060928e37 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
donatien 0:422060928e37 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
donatien 0:422060928e37 19 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
donatien 0:422060928e37 20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
donatien 0:422060928e37 21 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
donatien 0:422060928e37 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
donatien 0:422060928e37 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
donatien 0:422060928e37 24 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
donatien 0:422060928e37 25 * OF SUCH DAMAGE.
donatien 0:422060928e37 26 *
donatien 0:422060928e37 27 * This file is part of the lwIP TCP/IP stack.
donatien 0:422060928e37 28 *
donatien 0:422060928e37 29 * Author: Adam Dunkels <adam@sics.se>
donatien 0:422060928e37 30 *
donatien 0:422060928e37 31 */
donatien 0:422060928e37 32 #ifndef __LWIP_TCP_IMPL_H__
donatien 0:422060928e37 33 #define __LWIP_TCP_IMPL_H__
donatien 0:422060928e37 34
donatien 0:422060928e37 35 #include "lwip/opt.h"
donatien 0:422060928e37 36
donatien 0:422060928e37 37 #if LWIP_TCP /* don't build if not configured for use in lwipopts.h */
donatien 0:422060928e37 38
donatien 0:422060928e37 39 #include "lwip/tcp.h"
donatien 0:422060928e37 40 #include "lwip/sys.h"
donatien 0:422060928e37 41 #include "lwip/mem.h"
donatien 0:422060928e37 42 #include "lwip/pbuf.h"
donatien 0:422060928e37 43 #include "lwip/ip.h"
donatien 0:422060928e37 44 #include "lwip/icmp.h"
donatien 0:422060928e37 45 #include "lwip/err.h"
donatien 0:422060928e37 46
donatien 0:422060928e37 47 #ifdef __cplusplus
donatien 0:422060928e37 48 extern "C" {
donatien 0:422060928e37 49 #endif
donatien 0:422060928e37 50
donatien 0:422060928e37 51 /* Functions for interfacing with TCP: */
donatien 0:422060928e37 52
donatien 0:422060928e37 53 /* Lower layer interface to TCP: */
donatien 0:422060928e37 54 #define tcp_init() /* Compatibility define, no init needed. */
donatien 0:422060928e37 55 void tcp_tmr (void); /* Must be called every
donatien 0:422060928e37 56 TCP_TMR_INTERVAL
donatien 0:422060928e37 57 ms. (Typically 250 ms). */
donatien 0:422060928e37 58 /* It is also possible to call these two functions at the right
donatien 0:422060928e37 59 intervals (instead of calling tcp_tmr()). */
donatien 0:422060928e37 60 void tcp_slowtmr (void);
donatien 0:422060928e37 61 void tcp_fasttmr (void);
donatien 0:422060928e37 62
donatien 0:422060928e37 63
donatien 0:422060928e37 64 /* Only used by IP to pass a TCP segment to TCP: */
donatien 0:422060928e37 65 void tcp_input (struct pbuf *p, struct netif *inp);
donatien 0:422060928e37 66 /* Used within the TCP code only: */
donatien 0:422060928e37 67 struct tcp_pcb * tcp_alloc (u8_t prio);
donatien 0:422060928e37 68 void tcp_abandon (struct tcp_pcb *pcb, int reset);
donatien 0:422060928e37 69 err_t tcp_send_empty_ack(struct tcp_pcb *pcb);
donatien 0:422060928e37 70 void tcp_rexmit (struct tcp_pcb *pcb);
donatien 0:422060928e37 71 void tcp_rexmit_rto (struct tcp_pcb *pcb);
donatien 0:422060928e37 72 void tcp_rexmit_fast (struct tcp_pcb *pcb);
donatien 0:422060928e37 73 u32_t tcp_update_rcv_ann_wnd(struct tcp_pcb *pcb);
donatien 0:422060928e37 74
donatien 0:422060928e37 75 /**
donatien 0:422060928e37 76 * This is the Nagle algorithm: try to combine user data to send as few TCP
donatien 0:422060928e37 77 * segments as possible. Only send if
donatien 0:422060928e37 78 * - no previously transmitted data on the connection remains unacknowledged or
donatien 0:422060928e37 79 * - the TF_NODELAY flag is set (nagle algorithm turned off for this pcb) or
donatien 0:422060928e37 80 * - the only unsent segment is at least pcb->mss bytes long (or there is more
donatien 0:422060928e37 81 * than one unsent segment - with lwIP, this can happen although unsent->len < mss)
donatien 0:422060928e37 82 * - or if we are in fast-retransmit (TF_INFR)
donatien 0:422060928e37 83 */
donatien 0:422060928e37 84 #define tcp_do_output_nagle(tpcb) ((((tpcb)->unacked == NULL) || \
donatien 0:422060928e37 85 ((tpcb)->flags & (TF_NODELAY | TF_INFR)) || \
donatien 0:422060928e37 86 (((tpcb)->unsent != NULL) && (((tpcb)->unsent->next != NULL) || \
donatien 0:422060928e37 87 ((tpcb)->unsent->len >= (tpcb)->mss))) \
donatien 0:422060928e37 88 ) ? 1 : 0)
donatien 0:422060928e37 89 #define tcp_output_nagle(tpcb) (tcp_do_output_nagle(tpcb) ? tcp_output(tpcb) : ERR_OK)
donatien 0:422060928e37 90
donatien 0:422060928e37 91
donatien 0:422060928e37 92 #define TCP_SEQ_LT(a,b) ((s32_t)((a)-(b)) < 0)
donatien 0:422060928e37 93 #define TCP_SEQ_LEQ(a,b) ((s32_t)((a)-(b)) <= 0)
donatien 0:422060928e37 94 #define TCP_SEQ_GT(a,b) ((s32_t)((a)-(b)) > 0)
donatien 0:422060928e37 95 #define TCP_SEQ_GEQ(a,b) ((s32_t)((a)-(b)) >= 0)
donatien 0:422060928e37 96 /* is b<=a<=c? */
donatien 0:422060928e37 97 #if 0 /* see bug #10548 */
donatien 0:422060928e37 98 #define TCP_SEQ_BETWEEN(a,b,c) ((c)-(b) >= (a)-(b))
donatien 0:422060928e37 99 #endif
donatien 0:422060928e37 100 #define TCP_SEQ_BETWEEN(a,b,c) (TCP_SEQ_GEQ(a,b) && TCP_SEQ_LEQ(a,c))
donatien 0:422060928e37 101 #define TCP_FIN 0x01U
donatien 0:422060928e37 102 #define TCP_SYN 0x02U
donatien 0:422060928e37 103 #define TCP_RST 0x04U
donatien 0:422060928e37 104 #define TCP_PSH 0x08U
donatien 0:422060928e37 105 #define TCP_ACK 0x10U
donatien 0:422060928e37 106 #define TCP_URG 0x20U
donatien 0:422060928e37 107 #define TCP_ECE 0x40U
donatien 0:422060928e37 108 #define TCP_CWR 0x80U
donatien 0:422060928e37 109
donatien 0:422060928e37 110 #define TCP_FLAGS 0x3fU
donatien 0:422060928e37 111
donatien 0:422060928e37 112 /* Length of the TCP header, excluding options. */
donatien 0:422060928e37 113 #define TCP_HLEN 20
donatien 0:422060928e37 114
donatien 0:422060928e37 115 #ifndef TCP_TMR_INTERVAL
donatien 0:422060928e37 116 #define TCP_TMR_INTERVAL 250 /* The TCP timer interval in milliseconds. */
donatien 0:422060928e37 117 #endif /* TCP_TMR_INTERVAL */
donatien 0:422060928e37 118
donatien 0:422060928e37 119 #ifndef TCP_FAST_INTERVAL
donatien 0:422060928e37 120 #define TCP_FAST_INTERVAL TCP_TMR_INTERVAL /* the fine grained timeout in milliseconds */
donatien 0:422060928e37 121 #endif /* TCP_FAST_INTERVAL */
donatien 0:422060928e37 122
donatien 0:422060928e37 123 #ifndef TCP_SLOW_INTERVAL
donatien 0:422060928e37 124 #define TCP_SLOW_INTERVAL (2*TCP_TMR_INTERVAL) /* the coarse grained timeout in milliseconds */
donatien 0:422060928e37 125 #endif /* TCP_SLOW_INTERVAL */
donatien 0:422060928e37 126
donatien 0:422060928e37 127 #define TCP_FIN_WAIT_TIMEOUT 20000 /* milliseconds */
donatien 0:422060928e37 128 #define TCP_SYN_RCVD_TIMEOUT 20000 /* milliseconds */
donatien 0:422060928e37 129
donatien 0:422060928e37 130 #define TCP_OOSEQ_TIMEOUT 6U /* x RTO */
donatien 0:422060928e37 131
donatien 0:422060928e37 132 #ifndef TCP_MSL
donatien 0:422060928e37 133 #define TCP_MSL 60000UL /* The maximum segment lifetime in milliseconds */
donatien 0:422060928e37 134 #endif
donatien 0:422060928e37 135
donatien 0:422060928e37 136 /* Keepalive values, compliant with RFC 1122. Don't change this unless you know what you're doing */
donatien 0:422060928e37 137 #ifndef TCP_KEEPIDLE_DEFAULT
donatien 0:422060928e37 138 #define TCP_KEEPIDLE_DEFAULT 7200000UL /* Default KEEPALIVE timer in milliseconds */
donatien 0:422060928e37 139 #endif
donatien 0:422060928e37 140
donatien 0:422060928e37 141 #ifndef TCP_KEEPINTVL_DEFAULT
donatien 0:422060928e37 142 #define TCP_KEEPINTVL_DEFAULT 75000UL /* Default Time between KEEPALIVE probes in milliseconds */
donatien 0:422060928e37 143 #endif
donatien 0:422060928e37 144
donatien 0:422060928e37 145 #ifndef TCP_KEEPCNT_DEFAULT
donatien 0:422060928e37 146 #define TCP_KEEPCNT_DEFAULT 9U /* Default Counter for KEEPALIVE probes */
donatien 0:422060928e37 147 #endif
donatien 0:422060928e37 148
donatien 0:422060928e37 149 #define TCP_MAXIDLE TCP_KEEPCNT_DEFAULT * TCP_KEEPINTVL_DEFAULT /* Maximum KEEPALIVE probe time */
donatien 0:422060928e37 150
donatien 0:422060928e37 151 /* Fields are (of course) in network byte order.
donatien 0:422060928e37 152 * Some fields are converted to host byte order in tcp_input().
donatien 0:422060928e37 153 */
donatien 0:422060928e37 154 #ifdef PACK_STRUCT_USE_INCLUDES
donatien 0:422060928e37 155 # include "arch/bpstruct.h"
donatien 0:422060928e37 156 #endif
donatien 0:422060928e37 157 PACK_STRUCT_BEGIN
donatien 0:422060928e37 158 struct tcp_hdr {
donatien 0:422060928e37 159 PACK_STRUCT_FIELD(u16_t src);
donatien 0:422060928e37 160 PACK_STRUCT_FIELD(u16_t dest);
donatien 0:422060928e37 161 PACK_STRUCT_FIELD(u32_t seqno);
donatien 0:422060928e37 162 PACK_STRUCT_FIELD(u32_t ackno);
donatien 0:422060928e37 163 PACK_STRUCT_FIELD(u16_t _hdrlen_rsvd_flags);
donatien 0:422060928e37 164 PACK_STRUCT_FIELD(u16_t wnd);
donatien 0:422060928e37 165 PACK_STRUCT_FIELD(u16_t chksum);
donatien 0:422060928e37 166 PACK_STRUCT_FIELD(u16_t urgp);
donatien 0:422060928e37 167 } PACK_STRUCT_STRUCT;
donatien 0:422060928e37 168 PACK_STRUCT_END
donatien 0:422060928e37 169 #ifdef PACK_STRUCT_USE_INCLUDES
donatien 0:422060928e37 170 # include "arch/epstruct.h"
donatien 0:422060928e37 171 #endif
donatien 0:422060928e37 172
donatien 0:422060928e37 173 #define TCPH_OFFSET(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) >> 8)
donatien 0:422060928e37 174 #define TCPH_HDRLEN(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) >> 12)
donatien 0:422060928e37 175 #define TCPH_FLAGS(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) & TCP_FLAGS)
donatien 0:422060928e37 176
donatien 0:422060928e37 177 #define TCPH_OFFSET_SET(phdr, offset) (phdr)->_hdrlen_rsvd_flags = htons(((offset) << 8) | TCPH_FLAGS(phdr))
donatien 0:422060928e37 178 #define TCPH_HDRLEN_SET(phdr, len) (phdr)->_hdrlen_rsvd_flags = htons(((len) << 12) | TCPH_FLAGS(phdr))
donatien 0:422060928e37 179 #define TCPH_FLAGS_SET(phdr, flags) (phdr)->_hdrlen_rsvd_flags = (((phdr)->_hdrlen_rsvd_flags & htons((u16_t)(~(u16_t)(TCP_FLAGS)))) | htons(flags))
donatien 0:422060928e37 180 #define TCPH_HDRLEN_FLAGS_SET(phdr, len, flags) (phdr)->_hdrlen_rsvd_flags = htons(((len) << 12) | (flags))
donatien 0:422060928e37 181
donatien 0:422060928e37 182 #define TCPH_SET_FLAG(phdr, flags ) (phdr)->_hdrlen_rsvd_flags = ((phdr)->_hdrlen_rsvd_flags | htons(flags))
donatien 0:422060928e37 183 #define TCPH_UNSET_FLAG(phdr, flags) (phdr)->_hdrlen_rsvd_flags = htons(ntohs((phdr)->_hdrlen_rsvd_flags) | (TCPH_FLAGS(phdr) & ~(flags)) )
donatien 0:422060928e37 184
donatien 0:422060928e37 185 #define TCP_TCPLEN(seg) ((seg)->len + ((TCPH_FLAGS((seg)->tcphdr) & (TCP_FIN | TCP_SYN)) != 0))
donatien 0:422060928e37 186
donatien 0:422060928e37 187 /** Flags used on input processing, not on pcb->flags
donatien 0:422060928e37 188 */
donatien 0:422060928e37 189 #define TF_RESET (u8_t)0x08U /* Connection was reset. */
donatien 0:422060928e37 190 #define TF_CLOSED (u8_t)0x10U /* Connection was sucessfully closed. */
donatien 0:422060928e37 191 #define TF_GOT_FIN (u8_t)0x20U /* Connection was closed by the remote end. */
donatien 0:422060928e37 192
donatien 0:422060928e37 193
donatien 0:422060928e37 194 #if LWIP_EVENT_API
donatien 0:422060928e37 195
donatien 0:422060928e37 196 #define TCP_EVENT_ACCEPT(pcb,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\
donatien 0:422060928e37 197 LWIP_EVENT_ACCEPT, NULL, 0, err)
donatien 0:422060928e37 198 #define TCP_EVENT_SENT(pcb,space,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\
donatien 0:422060928e37 199 LWIP_EVENT_SENT, NULL, space, ERR_OK)
donatien 0:422060928e37 200 #define TCP_EVENT_RECV(pcb,p,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\
donatien 0:422060928e37 201 LWIP_EVENT_RECV, (p), 0, (err))
donatien 0:422060928e37 202 #define TCP_EVENT_CONNECTED(pcb,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\
donatien 0:422060928e37 203 LWIP_EVENT_CONNECTED, NULL, 0, (err))
donatien 0:422060928e37 204 #define TCP_EVENT_POLL(pcb,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\
donatien 0:422060928e37 205 LWIP_EVENT_POLL, NULL, 0, ERR_OK)
donatien 0:422060928e37 206 #define TCP_EVENT_ERR(errf,arg,err) lwip_tcp_event((arg), NULL, \
donatien 0:422060928e37 207 LWIP_EVENT_ERR, NULL, 0, (err))
donatien 0:422060928e37 208
donatien 0:422060928e37 209 #else /* LWIP_EVENT_API */
donatien 0:422060928e37 210
donatien 0:422060928e37 211 #define TCP_EVENT_ACCEPT(pcb,err,ret) \
donatien 0:422060928e37 212 do { \
donatien 0:422060928e37 213 if((pcb)->accept != NULL) \
donatien 0:422060928e37 214 (ret) = (pcb)->accept((pcb)->callback_arg,(pcb),(err)); \
donatien 0:422060928e37 215 else (ret) = ERR_ARG; \
donatien 0:422060928e37 216 } while (0)
donatien 0:422060928e37 217
donatien 0:422060928e37 218 #define TCP_EVENT_SENT(pcb,space,ret) \
donatien 0:422060928e37 219 do { \
donatien 0:422060928e37 220 if((pcb)->sent != NULL) \
donatien 0:422060928e37 221 (ret) = (pcb)->sent((pcb)->callback_arg,(pcb),(space)); \
donatien 0:422060928e37 222 else (ret) = ERR_OK; \
donatien 0:422060928e37 223 } while (0)
donatien 0:422060928e37 224
donatien 0:422060928e37 225 #define TCP_EVENT_RECV(pcb,p,err,ret) \
donatien 0:422060928e37 226 do { \
donatien 0:422060928e37 227 if(((pcb)->recv != NULL) && (!((pcb)->flags & TF_RXCLOSED))) { \
donatien 0:422060928e37 228 (ret) = (pcb)->recv((pcb)->callback_arg,(pcb),(p),(err)); \
donatien 0:422060928e37 229 } else { \
donatien 0:422060928e37 230 (ret) = tcp_recv_null(NULL, (pcb), (p), (err)); \
donatien 0:422060928e37 231 } \
donatien 0:422060928e37 232 } while (0)
donatien 0:422060928e37 233
donatien 0:422060928e37 234 #define TCP_EVENT_CONNECTED(pcb,err,ret) \
donatien 0:422060928e37 235 do { \
donatien 0:422060928e37 236 if((pcb)->connected != NULL) \
donatien 0:422060928e37 237 (ret) = (pcb)->connected((pcb)->callback_arg,(pcb),(err)); \
donatien 0:422060928e37 238 else (ret) = ERR_OK; \
donatien 0:422060928e37 239 } while (0)
donatien 0:422060928e37 240
donatien 0:422060928e37 241 #define TCP_EVENT_POLL(pcb,ret) \
donatien 0:422060928e37 242 do { \
donatien 0:422060928e37 243 if((pcb)->poll != NULL) \
donatien 0:422060928e37 244 (ret) = (pcb)->poll((pcb)->callback_arg,(pcb)); \
donatien 0:422060928e37 245 else (ret) = ERR_OK; \
donatien 0:422060928e37 246 } while (0)
donatien 0:422060928e37 247
donatien 0:422060928e37 248 #define TCP_EVENT_ERR(errf,arg,err) \
donatien 0:422060928e37 249 do { \
donatien 0:422060928e37 250 if((errf) != NULL) \
donatien 0:422060928e37 251 (errf)((arg),(err)); \
donatien 0:422060928e37 252 } while (0)
donatien 0:422060928e37 253
donatien 0:422060928e37 254 #endif /* LWIP_EVENT_API */
donatien 0:422060928e37 255
donatien 0:422060928e37 256 /** Enabled extra-check for TCP_OVERSIZE if LWIP_DEBUG is enabled */
donatien 0:422060928e37 257 #if TCP_OVERSIZE && defined(LWIP_DEBUG)
donatien 0:422060928e37 258 #define TCP_OVERSIZE_DBGCHECK 1
donatien 0:422060928e37 259 #else
donatien 0:422060928e37 260 #define TCP_OVERSIZE_DBGCHECK 0
donatien 0:422060928e37 261 #endif
donatien 0:422060928e37 262
donatien 0:422060928e37 263 /** Don't generate chceksum on copy if CHECKSUM_GEN_TCP is disabled */
donatien 0:422060928e37 264 #define TCP_CHECKSUM_ON_COPY (LWIP_CHECKSUM_ON_COPY && CHECKSUM_GEN_TCP)
donatien 0:422060928e37 265
donatien 0:422060928e37 266 /* This structure represents a TCP segment on the unsent, unacked and ooseq queues */
donatien 0:422060928e37 267 struct tcp_seg {
donatien 0:422060928e37 268 struct tcp_seg *next; /* used when putting segements on a queue */
donatien 0:422060928e37 269 struct pbuf *p; /* buffer containing data + TCP header */
donatien 0:422060928e37 270 void *dataptr; /* pointer to the TCP data in the pbuf */
donatien 0:422060928e37 271 u16_t len; /* the TCP length of this segment */
donatien 0:422060928e37 272 #if TCP_OVERSIZE_DBGCHECK
donatien 0:422060928e37 273 u16_t oversize_left; /* Extra bytes available at the end of the last
donatien 0:422060928e37 274 pbuf in unsent (used for asserting vs.
donatien 0:422060928e37 275 tcp_pcb.unsent_oversized only) */
donatien 0:422060928e37 276 #endif /* TCP_OVERSIZE_DBGCHECK */
donatien 0:422060928e37 277 #if TCP_CHECKSUM_ON_COPY
donatien 0:422060928e37 278 u16_t chksum;
donatien 0:422060928e37 279 u8_t chksum_swapped;
donatien 0:422060928e37 280 #endif /* TCP_CHECKSUM_ON_COPY */
donatien 0:422060928e37 281 u8_t flags;
donatien 0:422060928e37 282 #define TF_SEG_OPTS_MSS (u8_t)0x01U /* Include MSS option. */
donatien 0:422060928e37 283 #define TF_SEG_OPTS_TS (u8_t)0x02U /* Include timestamp option. */
donatien 0:422060928e37 284 #define TF_SEG_DATA_CHECKSUMMED (u8_t)0x04U /* ALL data (not the header) is
donatien 0:422060928e37 285 checksummed into 'chksum' */
donatien 0:422060928e37 286 struct tcp_hdr *tcphdr; /* the TCP header */
donatien 0:422060928e37 287 };
donatien 0:422060928e37 288
donatien 0:422060928e37 289 #define LWIP_TCP_OPT_LENGTH(flags) \
donatien 0:422060928e37 290 (flags & TF_SEG_OPTS_MSS ? 4 : 0) + \
donatien 0:422060928e37 291 (flags & TF_SEG_OPTS_TS ? 12 : 0)
donatien 0:422060928e37 292
donatien 0:422060928e37 293 /** This returns a TCP header option for MSS in an u32_t */
donatien 0:422060928e37 294 #define TCP_BUILD_MSS_OPTION(x) (x) = htonl(((u32_t)2 << 24) | \
donatien 0:422060928e37 295 ((u32_t)4 << 16) | \
donatien 0:422060928e37 296 (((u32_t)TCP_MSS / 256) << 8) | \
donatien 0:422060928e37 297 (TCP_MSS & 255))
donatien 0:422060928e37 298
donatien 0:422060928e37 299 /* Global variables: */
donatien 0:422060928e37 300 extern struct tcp_pcb *tcp_input_pcb;
donatien 0:422060928e37 301 extern u32_t tcp_ticks;
donatien 0:422060928e37 302
donatien 0:422060928e37 303 /* The TCP PCB lists. */
donatien 0:422060928e37 304 union tcp_listen_pcbs_t { /* List of all TCP PCBs in LISTEN state. */
donatien 0:422060928e37 305 struct tcp_pcb_listen *listen_pcbs;
donatien 0:422060928e37 306 struct tcp_pcb *pcbs;
donatien 0:422060928e37 307 };
donatien 0:422060928e37 308 extern union tcp_listen_pcbs_t tcp_listen_pcbs;
donatien 0:422060928e37 309 extern struct tcp_pcb *tcp_active_pcbs; /* List of all TCP PCBs that are in a
donatien 0:422060928e37 310 state in which they accept or send
donatien 0:422060928e37 311 data. */
donatien 0:422060928e37 312 extern struct tcp_pcb *tcp_tw_pcbs; /* List of all TCP PCBs in TIME-WAIT. */
donatien 0:422060928e37 313
donatien 0:422060928e37 314 extern struct tcp_pcb *tcp_tmp_pcb; /* Only used for temporary storage. */
donatien 0:422060928e37 315
donatien 0:422060928e37 316 /* Axioms about the above lists:
donatien 0:422060928e37 317 1) Every TCP PCB that is not CLOSED is in one of the lists.
donatien 0:422060928e37 318 2) A PCB is only in one of the lists.
donatien 0:422060928e37 319 3) All PCBs in the tcp_listen_pcbs list is in LISTEN state.
donatien 0:422060928e37 320 4) All PCBs in the tcp_tw_pcbs list is in TIME-WAIT state.
donatien 0:422060928e37 321 */
donatien 0:422060928e37 322 /* Define two macros, TCP_REG and TCP_RMV that registers a TCP PCB
donatien 0:422060928e37 323 with a PCB list or removes a PCB from a list, respectively. */
donatien 0:422060928e37 324 #if 0
donatien 0:422060928e37 325 #define TCP_REG(pcbs, npcb) do {\
donatien 0:422060928e37 326 LWIP_DEBUGF(TCP_DEBUG, ("TCP_REG %p local port %d\n", npcb, npcb->local_port)); \
donatien 0:422060928e37 327 for(tcp_tmp_pcb = *pcbs; \
donatien 0:422060928e37 328 tcp_tmp_pcb != NULL; \
donatien 0:422060928e37 329 tcp_tmp_pcb = tcp_tmp_pcb->next) { \
donatien 0:422060928e37 330 LWIP_ASSERT("TCP_REG: already registered\n", tcp_tmp_pcb != npcb); \
donatien 0:422060928e37 331 } \
donatien 0:422060928e37 332 LWIP_ASSERT("TCP_REG: pcb->state != CLOSED", npcb->state != CLOSED); \
donatien 0:422060928e37 333 npcb->next = *pcbs; \
donatien 0:422060928e37 334 LWIP_ASSERT("TCP_REG: npcb->next != npcb", npcb->next != npcb); \
donatien 0:422060928e37 335 *(pcbs) = npcb; \
donatien 0:422060928e37 336 LWIP_ASSERT("TCP_RMV: tcp_pcbs sane", tcp_pcbs_sane()); \
donatien 0:422060928e37 337 tcp_timer_needed(); \
donatien 0:422060928e37 338 } while(0)
donatien 0:422060928e37 339 #define TCP_RMV(pcbs, npcb) do { \
donatien 0:422060928e37 340 LWIP_ASSERT("TCP_RMV: pcbs != NULL", *pcbs != NULL); \
donatien 0:422060928e37 341 LWIP_DEBUGF(TCP_DEBUG, ("TCP_RMV: removing %p from %p\n", npcb, *pcbs)); \
donatien 0:422060928e37 342 if(*pcbs == npcb) { \
donatien 0:422060928e37 343 *pcbs = (*pcbs)->next; \
donatien 0:422060928e37 344 } else for(tcp_tmp_pcb = *pcbs; tcp_tmp_pcb != NULL; tcp_tmp_pcb = tcp_tmp_pcb->next) { \
donatien 0:422060928e37 345 if(tcp_tmp_pcb->next == npcb) { \
donatien 0:422060928e37 346 tcp_tmp_pcb->next = npcb->next; \
donatien 0:422060928e37 347 break; \
donatien 0:422060928e37 348 } \
donatien 0:422060928e37 349 } \
donatien 0:422060928e37 350 npcb->next = NULL; \
donatien 0:422060928e37 351 LWIP_ASSERT("TCP_RMV: tcp_pcbs sane", tcp_pcbs_sane()); \
donatien 0:422060928e37 352 LWIP_DEBUGF(TCP_DEBUG, ("TCP_RMV: removed %p from %p\n", npcb, *pcbs)); \
donatien 0:422060928e37 353 } while(0)
donatien 0:422060928e37 354
donatien 0:422060928e37 355 #else /* LWIP_DEBUG */
donatien 0:422060928e37 356
donatien 0:422060928e37 357 #define TCP_REG(pcbs, npcb) \
donatien 0:422060928e37 358 do { \
donatien 0:422060928e37 359 npcb->next = *pcbs; \
donatien 0:422060928e37 360 *(pcbs) = npcb; \
donatien 0:422060928e37 361 tcp_timer_needed(); \
donatien 0:422060928e37 362 } while (0)
donatien 0:422060928e37 363
donatien 0:422060928e37 364 #define TCP_RMV(pcbs, npcb) \
donatien 0:422060928e37 365 do { \
donatien 0:422060928e37 366 if(*(pcbs) == npcb) { \
donatien 0:422060928e37 367 (*(pcbs)) = (*pcbs)->next; \
donatien 0:422060928e37 368 } \
donatien 0:422060928e37 369 else { \
donatien 0:422060928e37 370 for(tcp_tmp_pcb = *pcbs; \
donatien 0:422060928e37 371 tcp_tmp_pcb != NULL; \
donatien 0:422060928e37 372 tcp_tmp_pcb = tcp_tmp_pcb->next) { \
donatien 0:422060928e37 373 if(tcp_tmp_pcb->next == npcb) { \
donatien 0:422060928e37 374 tcp_tmp_pcb->next = npcb->next; \
donatien 0:422060928e37 375 break; \
donatien 0:422060928e37 376 } \
donatien 0:422060928e37 377 } \
donatien 0:422060928e37 378 } \
donatien 0:422060928e37 379 npcb->next = NULL; \
donatien 0:422060928e37 380 } while(0)
donatien 0:422060928e37 381
donatien 0:422060928e37 382 #endif /* LWIP_DEBUG */
donatien 0:422060928e37 383
donatien 0:422060928e37 384
donatien 0:422060928e37 385 /* Internal functions: */
donatien 0:422060928e37 386 struct tcp_pcb *tcp_pcb_copy(struct tcp_pcb *pcb);
donatien 0:422060928e37 387 void tcp_pcb_purge(struct tcp_pcb *pcb);
donatien 0:422060928e37 388 void tcp_pcb_remove(struct tcp_pcb **pcblist, struct tcp_pcb *pcb);
donatien 0:422060928e37 389
donatien 0:422060928e37 390 void tcp_segs_free(struct tcp_seg *seg);
donatien 0:422060928e37 391 void tcp_seg_free(struct tcp_seg *seg);
donatien 0:422060928e37 392 struct tcp_seg *tcp_seg_copy(struct tcp_seg *seg);
donatien 0:422060928e37 393
donatien 0:422060928e37 394 #define tcp_ack(pcb) \
donatien 0:422060928e37 395 do { \
donatien 0:422060928e37 396 if((pcb)->flags & TF_ACK_DELAY) { \
donatien 0:422060928e37 397 (pcb)->flags &= ~TF_ACK_DELAY; \
donatien 0:422060928e37 398 (pcb)->flags |= TF_ACK_NOW; \
donatien 0:422060928e37 399 } \
donatien 0:422060928e37 400 else { \
donatien 0:422060928e37 401 (pcb)->flags |= TF_ACK_DELAY; \
donatien 0:422060928e37 402 } \
donatien 0:422060928e37 403 } while (0)
donatien 0:422060928e37 404
donatien 0:422060928e37 405 #define tcp_ack_now(pcb) \
donatien 0:422060928e37 406 do { \
donatien 0:422060928e37 407 (pcb)->flags |= TF_ACK_NOW; \
donatien 0:422060928e37 408 } while (0)
donatien 0:422060928e37 409
donatien 0:422060928e37 410 err_t tcp_send_fin(struct tcp_pcb *pcb);
donatien 0:422060928e37 411 err_t tcp_enqueue_flags(struct tcp_pcb *pcb, u8_t flags);
donatien 0:422060928e37 412
donatien 0:422060928e37 413 void tcp_rexmit_seg(struct tcp_pcb *pcb, struct tcp_seg *seg);
donatien 0:422060928e37 414
donatien 0:422060928e37 415 void tcp_rst(u32_t seqno, u32_t ackno,
donatien 0:422060928e37 416 ip_addr_t *local_ip, ip_addr_t *remote_ip,
donatien 0:422060928e37 417 u16_t local_port, u16_t remote_port);
donatien 0:422060928e37 418
donatien 0:422060928e37 419 u32_t tcp_next_iss(void);
donatien 0:422060928e37 420
donatien 0:422060928e37 421 void tcp_keepalive(struct tcp_pcb *pcb);
donatien 0:422060928e37 422 void tcp_zero_window_probe(struct tcp_pcb *pcb);
donatien 0:422060928e37 423
donatien 0:422060928e37 424 #if TCP_CALCULATE_EFF_SEND_MSS
donatien 0:422060928e37 425 u16_t tcp_eff_send_mss(u16_t sendmss, ip_addr_t *addr);
donatien 0:422060928e37 426 #endif /* TCP_CALCULATE_EFF_SEND_MSS */
donatien 0:422060928e37 427
donatien 0:422060928e37 428 #if LWIP_CALLBACK_API
donatien 0:422060928e37 429 err_t tcp_recv_null(void *arg, struct tcp_pcb *pcb, struct pbuf *p, err_t err);
donatien 0:422060928e37 430 #endif /* LWIP_CALLBACK_API */
donatien 0:422060928e37 431
donatien 0:422060928e37 432 #if TCP_DEBUG || TCP_INPUT_DEBUG || TCP_OUTPUT_DEBUG
donatien 0:422060928e37 433 void tcp_debug_print(struct tcp_hdr *tcphdr);
donatien 0:422060928e37 434 void tcp_debug_print_flags(u8_t flags);
donatien 0:422060928e37 435 void tcp_debug_print_state(enum tcp_state s);
donatien 0:422060928e37 436 void tcp_debug_print_pcbs(void);
donatien 0:422060928e37 437 s16_t tcp_pcbs_sane(void);
donatien 0:422060928e37 438 #else
donatien 0:422060928e37 439 # define tcp_debug_print(tcphdr)
donatien 0:422060928e37 440 # define tcp_debug_print_flags(flags)
donatien 0:422060928e37 441 # define tcp_debug_print_state(s)
donatien 0:422060928e37 442 # define tcp_debug_print_pcbs()
donatien 0:422060928e37 443 # define tcp_pcbs_sane() 1
donatien 0:422060928e37 444 #endif /* TCP_DEBUG */
donatien 0:422060928e37 445
donatien 0:422060928e37 446 /** External function (implemented in timers.c), called when TCP detects
donatien 0:422060928e37 447 * that a timer is needed (i.e. active- or time-wait-pcb found). */
donatien 0:422060928e37 448 void tcp_timer_needed(void);
donatien 0:422060928e37 449
donatien 0:422060928e37 450
donatien 0:422060928e37 451 /* Define two macros, TCP_REG and TCP_RMV that registers a TCP PCB
donatien 0:422060928e37 452 with a PCB list or removes a PCB from a list, respectively. */
donatien 0:422060928e37 453 #if 0
donatien 0:422060928e37 454 #define TCP_REG(pcbs, npcb) do {\
donatien 0:422060928e37 455 LWIP_DEBUGF(TCP_DEBUG, ("TCP_REG %p local port %d\n", npcb, npcb->local_port)); \
donatien 0:422060928e37 456 for(tcp_tmp_pcb = *pcbs; \
donatien 0:422060928e37 457 tcp_tmp_pcb != NULL; \
donatien 0:422060928e37 458 tcp_tmp_pcb = tcp_tmp_pcb->next) { \
donatien 0:422060928e37 459 LWIP_ASSERT("TCP_REG: already registered\n", tcp_tmp_pcb != npcb); \
donatien 0:422060928e37 460 } \
donatien 0:422060928e37 461 LWIP_ASSERT("TCP_REG: pcb->state != CLOSED", npcb->state != CLOSED); \
donatien 0:422060928e37 462 npcb->next = *pcbs; \
donatien 0:422060928e37 463 LWIP_ASSERT("TCP_REG: npcb->next != npcb", npcb->next != npcb); \
donatien 0:422060928e37 464 *(pcbs) = npcb; \
donatien 0:422060928e37 465 LWIP_ASSERT("TCP_RMV: tcp_pcbs sane", tcp_pcbs_sane()); \
donatien 0:422060928e37 466 tcp_timer_needed(); \
donatien 0:422060928e37 467 } while(0)
donatien 0:422060928e37 468 #define TCP_RMV(pcbs, npcb) do { \
donatien 0:422060928e37 469 LWIP_ASSERT("TCP_RMV: pcbs != NULL", *pcbs != NULL); \
donatien 0:422060928e37 470 LWIP_DEBUGF(TCP_DEBUG, ("TCP_RMV: removing %p from %p\n", npcb, *pcbs)); \
donatien 0:422060928e37 471 if(*pcbs == npcb) { \
donatien 0:422060928e37 472 *pcbs = (*pcbs)->next; \
donatien 0:422060928e37 473 } else for(tcp_tmp_pcb = *pcbs; tcp_tmp_pcb != NULL; tcp_tmp_pcb = tcp_tmp_pcb->next) { \
donatien 0:422060928e37 474 if(tcp_tmp_pcb->next == npcb) { \
donatien 0:422060928e37 475 tcp_tmp_pcb->next = npcb->next; \
donatien 0:422060928e37 476 break; \
donatien 0:422060928e37 477 } \
donatien 0:422060928e37 478 } \
donatien 0:422060928e37 479 npcb->next = NULL; \
donatien 0:422060928e37 480 LWIP_ASSERT("TCP_RMV: tcp_pcbs sane", tcp_pcbs_sane()); \
donatien 0:422060928e37 481 LWIP_DEBUGF(TCP_DEBUG, ("TCP_RMV: removed %p from %p\n", npcb, *pcbs)); \
donatien 0:422060928e37 482 } while(0)
donatien 0:422060928e37 483
donatien 0:422060928e37 484 #else /* LWIP_DEBUG */
donatien 0:422060928e37 485
donatien 0:422060928e37 486 #define TCP_REG(pcbs, npcb) \
donatien 0:422060928e37 487 do { \
donatien 0:422060928e37 488 npcb->next = *pcbs; \
donatien 0:422060928e37 489 *(pcbs) = npcb; \
donatien 0:422060928e37 490 tcp_timer_needed(); \
donatien 0:422060928e37 491 } while (0)
donatien 0:422060928e37 492
donatien 0:422060928e37 493 #define TCP_RMV(pcbs, npcb) \
donatien 0:422060928e37 494 do { \
donatien 0:422060928e37 495 if(*(pcbs) == npcb) { \
donatien 0:422060928e37 496 (*(pcbs)) = (*pcbs)->next; \
donatien 0:422060928e37 497 } \
donatien 0:422060928e37 498 else { \
donatien 0:422060928e37 499 for(tcp_tmp_pcb = *pcbs; \
donatien 0:422060928e37 500 tcp_tmp_pcb != NULL; \
donatien 0:422060928e37 501 tcp_tmp_pcb = tcp_tmp_pcb->next) { \
donatien 0:422060928e37 502 if(tcp_tmp_pcb->next == npcb) { \
donatien 0:422060928e37 503 tcp_tmp_pcb->next = npcb->next; \
donatien 0:422060928e37 504 break; \
donatien 0:422060928e37 505 } \
donatien 0:422060928e37 506 } \
donatien 0:422060928e37 507 } \
donatien 0:422060928e37 508 npcb->next = NULL; \
donatien 0:422060928e37 509 } while(0)
donatien 0:422060928e37 510
donatien 0:422060928e37 511 #endif /* LWIP_DEBUG */
donatien 0:422060928e37 512
donatien 0:422060928e37 513 #ifdef __cplusplus
donatien 0:422060928e37 514 }
donatien 0:422060928e37 515 #endif
donatien 0:422060928e37 516
donatien 0:422060928e37 517 #endif /* LWIP_TCP */
donatien 0:422060928e37 518
donatien 0:422060928e37 519 #endif /* __LWIP_TCP_H__ */