mbed unsupported
A version of LWIP, provided for backwards compatibility.
Dependents: AA_DemoBoard DemoBoard HelloServerDemo DemoBoard_RangeIndicator ... more
Embed:
(wiki syntax)
Show/hide line numbers
tcp.h
00001 /* 00002 * Copyright (c) 2001-2004 Swedish Institute of Computer Science. 00003 * All rights reserved. 00004 * 00005 * Redistribution and use in source and binary forms, with or without modification, 00006 * are permitted provided that the following conditions are met: 00007 * 00008 * 1. Redistributions of source code must retain the above copyright notice, 00009 * this list of conditions and the following disclaimer. 00010 * 2. Redistributions in binary form must reproduce the above copyright notice, 00011 * this list of conditions and the following disclaimer in the documentation 00012 * and/or other materials provided with the distribution. 00013 * 3. The name of the author may not be used to endorse or promote products 00014 * derived from this software without specific prior written permission. 00015 * 00016 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 00017 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 00018 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 00019 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 00020 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 00021 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 00022 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 00023 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 00024 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 00025 * OF SUCH DAMAGE. 00026 * 00027 * This file is part of the lwIP TCP/IP stack. 00028 * 00029 * Author: Adam Dunkels <adam@sics.se> 00030 * 00031 */ 00032 #ifndef __LWIP_TCP_H__ 00033 #define __LWIP_TCP_H__ 00034 00035 #include "lwip/opt.h" 00036 00037 #if LWIP_TCP /* don't build if not configured for use in lwipopts.h */ 00038 00039 #include "lwip/sys.h" 00040 #include "lwip/mem.h" 00041 #include "lwip/pbuf.h" 00042 #include "lwip/ip.h" 00043 #include "lwip/icmp.h" 00044 #include "lwip/err.h" 00045 00046 #ifdef __cplusplus 00047 // XXX: WTF 00048 //extern "C" { 00049 #endif 00050 00051 struct tcp_pcb; 00052 00053 /* Functions for interfacing with TCP: */ 00054 00055 /* Lower layer interface to TCP: */ 00056 #define tcp_init() /* Compatibility define, not init needed. */ 00057 void tcp_tmr (void); /* Must be called every 00058 TCP_TMR_INTERVAL 00059 ms. (Typically 250 ms). */ 00060 /* Application program's interface: */ 00061 struct tcp_pcb * tcp_new (void); 00062 struct tcp_pcb * tcp_alloc (u8_t prio); 00063 00064 void tcp_arg (struct tcp_pcb *pcb, void *arg); 00065 void tcp_accept (struct tcp_pcb *pcb, 00066 err_t (* accept)(void *arg, struct tcp_pcb *newpcb, 00067 err_t err)); 00068 void tcp_recv (struct tcp_pcb *pcb, 00069 err_t (* recv)(void *arg, struct tcp_pcb *tpcb, 00070 struct pbuf *p, err_t err)); 00071 void tcp_sent (struct tcp_pcb *pcb, 00072 err_t (* sent)(void *arg, struct tcp_pcb *tpcb, 00073 u16_t len)); 00074 void tcp_poll (struct tcp_pcb *pcb, 00075 err_t (* poll)(void *arg, struct tcp_pcb *tpcb), 00076 u8_t interval); 00077 void tcp_err (struct tcp_pcb *pcb, 00078 void (* err)(void *arg, err_t err)); 00079 00080 #define tcp_mss(pcb) ((pcb)->mss) 00081 #define tcp_sndbuf(pcb) ((pcb)->snd_buf) 00082 00083 #if TCP_LISTEN_BACKLOG 00084 #define tcp_accepted(pcb) (((struct tcp_pcb_listen *)(pcb))->accepts_pending--) 00085 #else /* TCP_LISTEN_BACKLOG */ 00086 #define tcp_accepted(pcb) 00087 #endif /* TCP_LISTEN_BACKLOG */ 00088 00089 void tcp_recved (struct tcp_pcb *pcb, u16_t len); 00090 err_t tcp_bind (struct tcp_pcb *pcb, struct ip_addr *ipaddr, 00091 u16_t port); 00092 err_t tcp_connect (struct tcp_pcb *pcb, struct ip_addr *ipaddr, 00093 u16_t port, err_t (* connected)(void *arg, 00094 struct tcp_pcb *tpcb, 00095 err_t err)); 00096 00097 struct tcp_pcb * tcp_listen_with_backlog(struct tcp_pcb *pcb, u8_t backlog); 00098 #define tcp_listen(pcb) tcp_listen_with_backlog(pcb, TCP_DEFAULT_LISTEN_BACKLOG) 00099 00100 void tcp_abandon (struct tcp_pcb *pcb, int reset); 00101 #define tcp_abort(pcb) tcp_abandon((pcb), 1) 00102 err_t tcp_close (struct tcp_pcb *pcb); 00103 00104 /* Flags for "apiflags" parameter in tcp_write and tcp_enqueue */ 00105 #define TCP_WRITE_FLAG_COPY 0x01 00106 #define TCP_WRITE_FLAG_MORE 0x02 00107 00108 err_t tcp_write (struct tcp_pcb *pcb, const void *dataptr, u16_t len, 00109 u8_t apiflags); 00110 00111 void tcp_setprio (struct tcp_pcb *pcb, u8_t prio); 00112 00113 #define TCP_PRIO_MIN 1 00114 #define TCP_PRIO_NORMAL 64 00115 #define TCP_PRIO_MAX 127 00116 00117 /* It is also possible to call these two functions at the right 00118 intervals (instead of calling tcp_tmr()). */ 00119 void tcp_slowtmr (void); 00120 void tcp_fasttmr (void); 00121 00122 00123 /* Only used by IP to pass a TCP segment to TCP: */ 00124 void tcp_input (struct pbuf *p, struct netif *inp); 00125 /* Used within the TCP code only: */ 00126 err_t tcp_output (struct tcp_pcb *pcb); 00127 void tcp_rexmit (struct tcp_pcb *pcb); 00128 void tcp_rexmit_rto (struct tcp_pcb *pcb); 00129 u32_t tcp_update_rcv_ann_wnd(struct tcp_pcb *pcb); 00130 00131 /** 00132 * This is the Nagle algorithm: inhibit the sending of new TCP 00133 * segments when new outgoing data arrives from the user if any 00134 * previously transmitted data on the connection remains 00135 * unacknowledged. 00136 */ 00137 #define tcp_do_output_nagle(tpcb) ((((tpcb)->unacked == NULL) || \ 00138 ((tpcb)->flags & TF_NODELAY) || \ 00139 (((tpcb)->unsent != NULL) && ((tpcb)->unsent->next != NULL))) ? \ 00140 1 : 0) 00141 #define tcp_output_nagle(tpcb) (tcp_do_output_nagle(tpcb) ? tcp_output(tpcb) : ERR_OK) 00142 00143 00144 #define TCP_SEQ_LT(a,b) ((s32_t)((a)-(b)) < 0) 00145 #define TCP_SEQ_LEQ(a,b) ((s32_t)((a)-(b)) <= 0) 00146 #define TCP_SEQ_GT(a,b) ((s32_t)((a)-(b)) > 0) 00147 #define TCP_SEQ_GEQ(a,b) ((s32_t)((a)-(b)) >= 0) 00148 /* is b<=a<=c? */ 00149 #if 0 /* see bug #10548 */ 00150 #define TCP_SEQ_BETWEEN(a,b,c) ((c)-(b) >= (a)-(b)) 00151 #endif 00152 #define TCP_SEQ_BETWEEN(a,b,c) (TCP_SEQ_GEQ(a,b) && TCP_SEQ_LEQ(a,c)) 00153 #define TCP_FIN 0x01U 00154 #define TCP_SYN 0x02U 00155 #define TCP_RST 0x04U 00156 #define TCP_PSH 0x08U 00157 #define TCP_ACK 0x10U 00158 #define TCP_URG 0x20U 00159 #define TCP_ECE 0x40U 00160 #define TCP_CWR 0x80U 00161 00162 #define TCP_FLAGS 0x3fU 00163 00164 /* Length of the TCP header, excluding options. */ 00165 #define TCP_HLEN 20 00166 00167 #ifndef TCP_TMR_INTERVAL 00168 #define TCP_TMR_INTERVAL 250 /* The TCP timer interval in milliseconds. */ 00169 #endif /* TCP_TMR_INTERVAL */ 00170 00171 #ifndef TCP_FAST_INTERVAL 00172 #define TCP_FAST_INTERVAL TCP_TMR_INTERVAL /* the fine grained timeout in milliseconds */ 00173 #endif /* TCP_FAST_INTERVAL */ 00174 00175 #ifndef TCP_SLOW_INTERVAL 00176 #define TCP_SLOW_INTERVAL (2*TCP_TMR_INTERVAL) /* the coarse grained timeout in milliseconds */ 00177 #endif /* TCP_SLOW_INTERVAL */ 00178 00179 #define TCP_FIN_WAIT_TIMEOUT 20000 /* milliseconds */ 00180 #define TCP_SYN_RCVD_TIMEOUT 20000 /* milliseconds */ 00181 00182 #define TCP_OOSEQ_TIMEOUT 6U /* x RTO */ 00183 00184 #ifndef TCP_MSL 00185 #define TCP_MSL 60000UL /* The maximum segment lifetime in milliseconds */ 00186 #endif 00187 00188 /* Keepalive values, compliant with RFC 1122. Don't change this unless you know what you're doing */ 00189 #ifndef TCP_KEEPIDLE_DEFAULT 00190 #define TCP_KEEPIDLE_DEFAULT 7200000UL /* Default KEEPALIVE timer in milliseconds */ 00191 #endif 00192 00193 #ifndef TCP_KEEPINTVL_DEFAULT 00194 #define TCP_KEEPINTVL_DEFAULT 75000UL /* Default Time between KEEPALIVE probes in milliseconds */ 00195 #endif 00196 00197 #ifndef TCP_KEEPCNT_DEFAULT 00198 #define TCP_KEEPCNT_DEFAULT 9U /* Default Counter for KEEPALIVE probes */ 00199 #endif 00200 00201 #define TCP_MAXIDLE TCP_KEEPCNT_DEFAULT * TCP_KEEPINTVL_DEFAULT /* Maximum KEEPALIVE probe time */ 00202 00203 /* Fields are (of course) in network byte order. 00204 * Some fields are converted to host byte order in tcp_input(). 00205 */ 00206 #ifdef PACK_STRUCT_USE_INCLUDES 00207 # include "arch/bpstruct.h" 00208 #endif 00209 PACK_STRUCT_BEGIN 00210 struct tcp_hdr { 00211 PACK_STRUCT_FIELD(u16_t src); 00212 PACK_STRUCT_FIELD(u16_t dest); 00213 PACK_STRUCT_FIELD(u32_t seqno); 00214 PACK_STRUCT_FIELD(u32_t ackno); 00215 PACK_STRUCT_FIELD(u16_t _hdrlen_rsvd_flags); 00216 PACK_STRUCT_FIELD(u16_t wnd); 00217 PACK_STRUCT_FIELD(u16_t chksum); 00218 PACK_STRUCT_FIELD(u16_t urgp); 00219 } PACK_STRUCT_STRUCT; 00220 PACK_STRUCT_END 00221 #ifdef PACK_STRUCT_USE_INCLUDES 00222 # include "arch/epstruct.h" 00223 #endif 00224 00225 #define TCPH_OFFSET(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) >> 8) 00226 #define TCPH_HDRLEN(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) >> 12) 00227 #define TCPH_FLAGS(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) & TCP_FLAGS) 00228 00229 #define TCPH_OFFSET_SET(phdr, offset) (phdr)->_hdrlen_rsvd_flags = htons(((offset) << 8) | TCPH_FLAGS(phdr)) 00230 #define TCPH_HDRLEN_SET(phdr, len) (phdr)->_hdrlen_rsvd_flags = htons(((len) << 12) | TCPH_FLAGS(phdr)) 00231 #define TCPH_FLAGS_SET(phdr, flags) (phdr)->_hdrlen_rsvd_flags = htons((ntohs((phdr)->_hdrlen_rsvd_flags) & ~TCP_FLAGS) | (flags)) 00232 #define TCPH_SET_FLAG(phdr, flags ) (phdr)->_hdrlen_rsvd_flags = htons(ntohs((phdr)->_hdrlen_rsvd_flags) | (flags)) 00233 #define TCPH_UNSET_FLAG(phdr, flags) (phdr)->_hdrlen_rsvd_flags = htons(ntohs((phdr)->_hdrlen_rsvd_flags) | (TCPH_FLAGS(phdr) & ~(flags)) ) 00234 00235 #define TCP_TCPLEN(seg) ((seg)->len + ((TCPH_FLAGS((seg)->tcphdr) & TCP_FIN || \ 00236 TCPH_FLAGS((seg)->tcphdr) & TCP_SYN)? 1: 0)) 00237 00238 enum tcp_state { 00239 CLOSED = 0, 00240 LISTEN = 1, 00241 SYN_SENT = 2, 00242 SYN_RCVD = 3, 00243 ESTABLISHED = 4, 00244 FIN_WAIT_1 = 5, 00245 FIN_WAIT_2 = 6, 00246 CLOSE_WAIT = 7, 00247 CLOSING = 8, 00248 LAST_ACK = 9, 00249 TIME_WAIT = 10 00250 }; 00251 00252 /** Flags used on input processing, not on pcb->flags 00253 */ 00254 #define TF_RESET (u8_t)0x08U /* Connection was reset. */ 00255 #define TF_CLOSED (u8_t)0x10U /* Connection was sucessfully closed. */ 00256 #define TF_GOT_FIN (u8_t)0x20U /* Connection was closed by the remote end. */ 00257 00258 00259 #if LWIP_CALLBACK_API 00260 /* Function to call when a listener has been connected. 00261 * @param arg user-supplied argument (tcp_pcb.callback_arg) 00262 * @param pcb a new tcp_pcb that now is connected 00263 * @param err an error argument (TODO: that is current always ERR_OK?) 00264 * @return ERR_OK: accept the new connection, 00265 * any other err_t abortsthe new connection 00266 */ 00267 #define DEF_ACCEPT_CALLBACK err_t (* accept)(void *arg, struct tcp_pcb *newpcb, err_t err) 00268 #else /* LWIP_CALLBACK_API */ 00269 #define DEF_ACCEPT_CALLBACK 00270 #endif /* LWIP_CALLBACK_API */ 00271 00272 /** 00273 * members common to struct tcp_pcb and struct tcp_listen_pcb 00274 */ 00275 #define TCP_PCB_COMMON(type) \ 00276 type *next; /* for the linked list */ \ 00277 enum tcp_state state; /* TCP state */ \ 00278 u8_t prio; \ 00279 void *callback_arg; \ 00280 /* ports are in host byte order */ \ 00281 u16_t local_port; \ 00282 /* the accept callback for listen- and normal pcbs, if LWIP_CALLBACK_API */ \ 00283 DEF_ACCEPT_CALLBACK 00284 00285 00286 /* the TCP protocol control block */ 00287 struct tcp_pcb { 00288 /** common PCB members */ 00289 IP_PCB; 00290 /** protocol specific PCB members */ 00291 TCP_PCB_COMMON(struct tcp_pcb); 00292 00293 /* ports are in host byte order */ 00294 u16_t remote_port; 00295 00296 u8_t flags; 00297 #define TF_ACK_DELAY ((u8_t)0x01U) /* Delayed ACK. */ 00298 #define TF_ACK_NOW ((u8_t)0x02U) /* Immediate ACK. */ 00299 #define TF_INFR ((u8_t)0x04U) /* In fast recovery. */ 00300 #define TF_TIMESTAMP ((u8_t)0x08U) /* Timestamp option enabled */ 00301 #define TF_FIN ((u8_t)0x20U) /* Connection was closed locally (FIN segment enqueued). */ 00302 #define TF_NODELAY ((u8_t)0x40U) /* Disable Nagle algorithm */ 00303 #define TF_NAGLEMEMERR ((u8_t)0x80U) /* nagle enabled, memerr, try to output to prevent delayed ACK to happen */ 00304 00305 /* the rest of the fields are in host byte order 00306 as we have to do some math with them */ 00307 /* receiver variables */ 00308 u32_t rcv_nxt; /* next seqno expected */ 00309 u16_t rcv_wnd; /* receiver window available */ 00310 u16_t rcv_ann_wnd; /* receiver window to announce */ 00311 u32_t rcv_ann_right_edge; /* announced right edge of window */ 00312 00313 /* Timers */ 00314 u32_t tmr; 00315 u8_t polltmr, pollinterval; 00316 00317 /* Retransmission timer. */ 00318 s16_t rtime; 00319 00320 u16_t mss; /* maximum segment size */ 00321 00322 /* RTT (round trip time) estimation variables */ 00323 u32_t rttest; /* RTT estimate in 500ms ticks */ 00324 u32_t rtseq; /* sequence number being timed */ 00325 s16_t sa, sv; /* @todo document this */ 00326 00327 s16_t rto; /* retransmission time-out */ 00328 u8_t nrtx; /* number of retransmissions */ 00329 00330 /* fast retransmit/recovery */ 00331 u32_t lastack; /* Highest acknowledged seqno. */ 00332 u8_t dupacks; 00333 00334 /* congestion avoidance/control variables */ 00335 u16_t cwnd; 00336 u16_t ssthresh; 00337 00338 /* sender variables */ 00339 u32_t snd_nxt, /* next seqno to be sent */ 00340 snd_max; /* Highest seqno sent. */ 00341 u16_t snd_wnd; /* sender window */ 00342 u32_t snd_wl1, snd_wl2, /* Sequence and acknowledgement numbers of last 00343 window update. */ 00344 snd_lbb; /* Sequence number of next byte to be buffered. */ 00345 00346 u16_t acked; 00347 00348 u16_t snd_buf; /* Available buffer space for sending (in bytes). */ 00349 #define TCP_SNDQUEUELEN_OVERFLOW (0xffff-3) 00350 u16_t snd_queuelen; /* Available buffer space for sending (in tcp_segs). */ 00351 00352 00353 /* These are ordered by sequence number: */ 00354 struct tcp_seg *unsent; /* Unsent (queued) segments. */ 00355 struct tcp_seg *unacked; /* Sent but unacknowledged segments. */ 00356 #if TCP_QUEUE_OOSEQ 00357 struct tcp_seg *ooseq; /* Received out of sequence segments. */ 00358 #endif /* TCP_QUEUE_OOSEQ */ 00359 00360 struct pbuf *refused_data; /* Data previously received but not yet taken by upper layer */ 00361 00362 #if LWIP_CALLBACK_API 00363 /* Function to be called when more send buffer space is available. 00364 * @param arg user-supplied argument (tcp_pcb.callback_arg) 00365 * @param pcb the tcp_pcb which has send buffer space available 00366 * @param space the amount of bytes available 00367 * @return ERR_OK: try to send some data by calling tcp_output 00368 */ 00369 err_t (* sent)(void *arg, struct tcp_pcb *pcb, u16_t space); 00370 00371 /* Function to be called when (in-sequence) data has arrived. 00372 * @param arg user-supplied argument (tcp_pcb.callback_arg) 00373 * @param pcb the tcp_pcb for which data has arrived 00374 * @param p the packet buffer which arrived 00375 * @param err an error argument (TODO: that is current always ERR_OK?) 00376 * @return ERR_OK: try to send some data by calling tcp_output 00377 */ 00378 err_t (* recv)(void *arg, struct tcp_pcb *pcb, struct pbuf *p, err_t err); 00379 00380 /* Function to be called when a connection has been set up. 00381 * @param arg user-supplied argument (tcp_pcb.callback_arg) 00382 * @param pcb the tcp_pcb that now is connected 00383 * @param err an error argument (TODO: that is current always ERR_OK?) 00384 * @return value is currently ignored 00385 */ 00386 err_t (* connected)(void *arg, struct tcp_pcb *pcb, err_t err); 00387 00388 /* Function which is called periodically. 00389 * The period can be adjusted in multiples of the TCP slow timer interval 00390 * by changing tcp_pcb.polltmr. 00391 * @param arg user-supplied argument (tcp_pcb.callback_arg) 00392 * @param pcb the tcp_pcb to poll for 00393 * @return ERR_OK: try to send some data by calling tcp_output 00394 */ 00395 err_t (* poll)(void *arg, struct tcp_pcb *pcb); 00396 00397 /* Function to be called whenever a fatal error occurs. 00398 * There is no pcb parameter since most of the times, the pcb is 00399 * already deallocated (or there is no pcb) when this function is called. 00400 * @param arg user-supplied argument (tcp_pcb.callback_arg) 00401 * @param err an indication why the error callback is called: 00402 * ERR_ABRT: aborted through tcp_abort or by a TCP timer 00403 * ERR_RST: the connection was reset by the remote host 00404 */ 00405 void (* errf)(void *arg, err_t err); 00406 #endif /* LWIP_CALLBACK_API */ 00407 00408 #if LWIP_TCP_TIMESTAMPS 00409 u32_t ts_lastacksent; 00410 u32_t ts_recent; 00411 #endif /* LWIP_TCP_TIMESTAMPS */ 00412 00413 /* idle time before KEEPALIVE is sent */ 00414 u32_t keep_idle; 00415 #if LWIP_TCP_KEEPALIVE 00416 u32_t keep_intvl; 00417 u32_t keep_cnt; 00418 #endif /* LWIP_TCP_KEEPALIVE */ 00419 00420 /* Persist timer counter */ 00421 u32_t persist_cnt; 00422 /* Persist timer back-off */ 00423 u8_t persist_backoff; 00424 00425 /* KEEPALIVE counter */ 00426 u8_t keep_cnt_sent; 00427 }; 00428 00429 struct tcp_pcb_listen { 00430 /* Common members of all PCB types */ 00431 IP_PCB; 00432 /* Protocol specific PCB members */ 00433 TCP_PCB_COMMON(struct tcp_pcb_listen); 00434 00435 #if TCP_LISTEN_BACKLOG 00436 u8_t backlog; 00437 u8_t accepts_pending; 00438 #endif /* TCP_LISTEN_BACKLOG */ 00439 }; 00440 00441 #if LWIP_EVENT_API 00442 00443 enum lwip_event { 00444 LWIP_EVENT_ACCEPT, 00445 LWIP_EVENT_SENT, 00446 LWIP_EVENT_RECV, 00447 LWIP_EVENT_CONNECTED, 00448 LWIP_EVENT_POLL, 00449 LWIP_EVENT_ERR 00450 }; 00451 00452 err_t lwip_tcp_event(void *arg, struct tcp_pcb *pcb, 00453 enum lwip_event, 00454 struct pbuf *p, 00455 u16_t size, 00456 err_t err); 00457 00458 #define TCP_EVENT_ACCEPT(pcb,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\ 00459 LWIP_EVENT_ACCEPT, NULL, 0, err) 00460 #define TCP_EVENT_SENT(pcb,space,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\ 00461 LWIP_EVENT_SENT, NULL, space, ERR_OK) 00462 #define TCP_EVENT_RECV(pcb,p,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\ 00463 LWIP_EVENT_RECV, (p), 0, (err)) 00464 #define TCP_EVENT_CONNECTED(pcb,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\ 00465 LWIP_EVENT_CONNECTED, NULL, 0, (err)) 00466 #define TCP_EVENT_POLL(pcb,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\ 00467 LWIP_EVENT_POLL, NULL, 0, ERR_OK) 00468 #define TCP_EVENT_ERR(errf,arg,err) lwip_tcp_event((arg), NULL, \ 00469 LWIP_EVENT_ERR, NULL, 0, (err)) 00470 #else /* LWIP_EVENT_API */ 00471 00472 #define TCP_EVENT_ACCEPT(pcb,err,ret) \ 00473 do { \ 00474 if((pcb)->accept != NULL) \ 00475 (ret) = (pcb)->accept((pcb)->callback_arg,(pcb),(err)); \ 00476 } while (0) 00477 00478 #define TCP_EVENT_SENT(pcb,space,ret) \ 00479 do { \ 00480 if((pcb)->sent != NULL) \ 00481 (ret) = (pcb)->sent((pcb)->callback_arg,(pcb),(space)); \ 00482 } while (0) 00483 00484 #define TCP_EVENT_RECV(pcb,p,err,ret) \ 00485 do { \ 00486 if((pcb)->recv != NULL) { \ 00487 (ret) = (pcb)->recv((pcb)->callback_arg,(pcb),(p),(err)); \ 00488 } else { \ 00489 (ret) = ERR_OK; \ 00490 if (p != NULL) \ 00491 pbuf_free(p); \ 00492 } \ 00493 } while (0) 00494 00495 #define TCP_EVENT_CONNECTED(pcb,err,ret) \ 00496 do { \ 00497 if((pcb)->connected != NULL) \ 00498 (ret) = (pcb)->connected((pcb)->callback_arg,(pcb),(err)); \ 00499 } while (0) 00500 00501 #define TCP_EVENT_POLL(pcb,ret) \ 00502 do { \ 00503 if((pcb)->poll != NULL) \ 00504 (ret) = (pcb)->poll((pcb)->callback_arg,(pcb)); \ 00505 } while (0) 00506 00507 #define TCP_EVENT_ERR(errf,arg,err) \ 00508 do { \ 00509 if((errf) != NULL) \ 00510 (errf)((arg),(err)); \ 00511 } while (0) 00512 00513 #endif /* LWIP_EVENT_API */ 00514 00515 /* This structure represents a TCP segment on the unsent and unacked queues */ 00516 struct tcp_seg { 00517 struct tcp_seg *next; /* used when putting segements on a queue */ 00518 struct pbuf *p; /* buffer containing data + TCP header */ 00519 void *dataptr; /* pointer to the TCP data in the pbuf */ 00520 u16_t len; /* the TCP length of this segment */ 00521 u8_t flags; 00522 #define TF_SEG_OPTS_MSS (u8_t)0x01U /* Include MSS option. */ 00523 #define TF_SEG_OPTS_TS (u8_t)0x02U /* Include timestamp option. */ 00524 struct tcp_hdr *tcphdr; /* the TCP header */ 00525 }; 00526 00527 #define LWIP_TCP_OPT_LENGTH(flags) \ 00528 (flags & TF_SEG_OPTS_MSS ? 4 : 0) + \ 00529 (flags & TF_SEG_OPTS_TS ? 12 : 0) 00530 00531 /** This returns a TCP header option for MSS in an u32_t */ 00532 #define TCP_BUILD_MSS_OPTION(x) (x) = htonl(((u32_t)2 << 24) | \ 00533 ((u32_t)4 << 16) | \ 00534 (((u32_t)TCP_MSS / 256) << 8) | \ 00535 (TCP_MSS & 255)) 00536 00537 /* Internal functions and global variables: */ 00538 struct tcp_pcb *tcp_pcb_copy(struct tcp_pcb *pcb); 00539 void tcp_pcb_purge(struct tcp_pcb *pcb); 00540 void tcp_pcb_remove(struct tcp_pcb **pcblist, struct tcp_pcb *pcb); 00541 00542 u8_t tcp_segs_free(struct tcp_seg *seg); 00543 u8_t tcp_seg_free(struct tcp_seg *seg); 00544 struct tcp_seg *tcp_seg_copy(struct tcp_seg *seg); 00545 00546 #define tcp_ack(pcb) \ 00547 do { \ 00548 if((pcb)->flags & TF_ACK_DELAY) { \ 00549 (pcb)->flags &= ~TF_ACK_DELAY; \ 00550 (pcb)->flags |= TF_ACK_NOW; \ 00551 tcp_output(pcb); \ 00552 } \ 00553 else { \ 00554 (pcb)->flags |= TF_ACK_DELAY; \ 00555 } \ 00556 } while (0) 00557 00558 #define tcp_ack_now(pcb) \ 00559 do { \ 00560 (pcb)->flags |= TF_ACK_NOW; \ 00561 tcp_output(pcb); \ 00562 } while (0) 00563 00564 err_t tcp_send_ctrl(struct tcp_pcb *pcb, u8_t flags); 00565 err_t tcp_enqueue(struct tcp_pcb *pcb, void *dataptr, u16_t len, 00566 u8_t flags, u8_t apiflags, u8_t optflags); 00567 00568 void tcp_rexmit_seg(struct tcp_pcb *pcb, struct tcp_seg *seg); 00569 00570 void tcp_rst(u32_t seqno, u32_t ackno, 00571 struct ip_addr *local_ip, struct ip_addr *remote_ip, 00572 u16_t local_port, u16_t remote_port); 00573 00574 u32_t tcp_next_iss(void); 00575 00576 void tcp_keepalive(struct tcp_pcb *pcb); 00577 void tcp_zero_window_probe(struct tcp_pcb *pcb); 00578 00579 #if TCP_CALCULATE_EFF_SEND_MSS 00580 u16_t tcp_eff_send_mss(u16_t sendmss, struct ip_addr *addr); 00581 #endif /* TCP_CALCULATE_EFF_SEND_MSS */ 00582 00583 extern struct tcp_pcb *tcp_input_pcb; 00584 extern u32_t tcp_ticks; 00585 00586 #if TCP_DEBUG || TCP_INPUT_DEBUG || TCP_OUTPUT_DEBUG 00587 void tcp_debug_print(struct tcp_hdr *tcphdr); 00588 void tcp_debug_print_flags(u8_t flags); 00589 void tcp_debug_print_state(enum tcp_state s); 00590 void tcp_debug_print_pcbs(void); 00591 s16_t tcp_pcbs_sane(void); 00592 #else 00593 # define tcp_debug_print(tcphdr) 00594 # define tcp_debug_print_flags(flags) 00595 # define tcp_debug_print_state(s) 00596 # define tcp_debug_print_pcbs() 00597 # define tcp_pcbs_sane() 1 00598 #endif /* TCP_DEBUG */ 00599 00600 #if NO_SYS 00601 #define tcp_timer_needed() 00602 #else 00603 void tcp_timer_needed(void); 00604 #endif 00605 00606 /* The TCP PCB lists. */ 00607 union tcp_listen_pcbs_t { /* List of all TCP PCBs in LISTEN state. */ 00608 struct tcp_pcb_listen *listen_pcbs; 00609 struct tcp_pcb *pcbs; 00610 }; 00611 extern union tcp_listen_pcbs_t tcp_listen_pcbs; 00612 extern struct tcp_pcb *tcp_active_pcbs; /* List of all TCP PCBs that are in a 00613 state in which they accept or send 00614 data. */ 00615 extern struct tcp_pcb *tcp_tw_pcbs; /* List of all TCP PCBs in TIME-WAIT. */ 00616 00617 extern struct tcp_pcb *tcp_tmp_pcb; /* Only used for temporary storage. */ 00618 00619 /* Axioms about the above lists: 00620 1) Every TCP PCB that is not CLOSED is in one of the lists. 00621 2) A PCB is only in one of the lists. 00622 3) All PCBs in the tcp_listen_pcbs list is in LISTEN state. 00623 4) All PCBs in the tcp_tw_pcbs list is in TIME-WAIT state. 00624 */ 00625 00626 /* Define two macros, TCP_REG and TCP_RMV that registers a TCP PCB 00627 with a PCB list or removes a PCB from a list, respectively. */ 00628 #if 0 00629 #define TCP_REG(pcbs, npcb) do {\ 00630 LWIP_DEBUGF(TCP_DEBUG, ("TCP_REG %p local port %d\n", npcb, npcb->local_port)); \ 00631 for(tcp_tmp_pcb = *pcbs; \ 00632 tcp_tmp_pcb != NULL; \ 00633 tcp_tmp_pcb = tcp_tmp_pcb->next) { \ 00634 LWIP_ASSERT("TCP_REG: already registered\n", tcp_tmp_pcb != npcb); \ 00635 } \ 00636 LWIP_ASSERT("TCP_REG: pcb->state != CLOSED", npcb->state != CLOSED); \ 00637 npcb->next = *pcbs; \ 00638 LWIP_ASSERT("TCP_REG: npcb->next != npcb", npcb->next != npcb); \ 00639 *(pcbs) = npcb; \ 00640 LWIP_ASSERT("TCP_RMV: tcp_pcbs sane", tcp_pcbs_sane()); \ 00641 tcp_timer_needed(); \ 00642 } while(0) 00643 #define TCP_RMV(pcbs, npcb) do { \ 00644 LWIP_ASSERT("TCP_RMV: pcbs != NULL", *pcbs != NULL); \ 00645 LWIP_DEBUGF(TCP_DEBUG, ("TCP_RMV: removing %p from %p\n", npcb, *pcbs)); \ 00646 if(*pcbs == npcb) { \ 00647 *pcbs = (*pcbs)->next; \ 00648 } else for(tcp_tmp_pcb = *pcbs; tcp_tmp_pcb != NULL; tcp_tmp_pcb = tcp_tmp_pcb->next) { \ 00649 if(tcp_tmp_pcb->next != NULL && tcp_tmp_pcb->next == npcb) { \ 00650 tcp_tmp_pcb->next = npcb->next; \ 00651 break; \ 00652 } \ 00653 } \ 00654 npcb->next = NULL; \ 00655 LWIP_ASSERT("TCP_RMV: tcp_pcbs sane", tcp_pcbs_sane()); \ 00656 LWIP_DEBUGF(TCP_DEBUG, ("TCP_RMV: removed %p from %p\n", npcb, *pcbs)); \ 00657 } while(0) 00658 00659 #else /* LWIP_DEBUG */ 00660 00661 #define TCP_REG(pcbs, npcb) \ 00662 do { \ 00663 npcb->next = *pcbs; \ 00664 *(pcbs) = npcb; \ 00665 tcp_timer_needed(); \ 00666 } while (0) 00667 00668 #define TCP_RMV(pcbs, npcb) \ 00669 do { \ 00670 if(*(pcbs) == npcb) { \ 00671 (*(pcbs)) = (*pcbs)->next; \ 00672 } \ 00673 else { \ 00674 for(tcp_tmp_pcb = *pcbs; \ 00675 tcp_tmp_pcb != NULL; \ 00676 tcp_tmp_pcb = tcp_tmp_pcb->next) { \ 00677 if(tcp_tmp_pcb->next != NULL && tcp_tmp_pcb->next == npcb) { \ 00678 tcp_tmp_pcb->next = npcb->next; \ 00679 break; \ 00680 } \ 00681 } \ 00682 } \ 00683 npcb->next = NULL; \ 00684 } while(0) 00685 00686 #endif /* LWIP_DEBUG */ 00687 00688 #ifdef __cplusplus 00689 // XXX: WTF 00690 //} 00691 #endif 00692 00693 #endif /* LWIP_TCP */ 00694 00695 #endif /* __LWIP_TCP_H__ */
Generated on Tue Jul 12 2022 16:06:25 by
1.7.2