TuyaOS
tcp.h
浏览该文件的文档.
1
7/*
8 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without modification,
12 * are permitted provided that the following conditions are met:
13 *
14 * 1. Redistributions of source code must retain the above copyright notice,
15 * this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright notice,
17 * this list of conditions and the following disclaimer in the documentation
18 * and/or other materials provided with the distribution.
19 * 3. The name of the author may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
25 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
27 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
31 * OF SUCH DAMAGE.
32 *
33 * This file is part of the lwIP TCP/IP stack.
34 *
35 * Author: Adam Dunkels <adam@sics.se>
36 *
37 */
38#ifndef LWIP_HDR_TCP_H
39#define LWIP_HDR_TCP_H
40
41#include "lwip/opt.h"
42
43#if LWIP_TCP /* don't build if not configured for use in lwipopts.h */
44
45#include "lwip/tcpbase.h"
46#include "lwip/mem.h"
47#include "lwip/pbuf.h"
48#include "lwip/ip.h"
49#include "lwip/icmp.h"
50#include "lwip/err.h"
51#include "lwip/ip6.h"
52#include "lwip/ip6_addr.h"
53
54#ifdef __cplusplus
55extern "C" {
56#endif
57
58struct tcp_pcb;
59struct tcp_pcb_listen;
60
70typedef err_t (*tcp_accept_fn)(void *arg, struct tcp_pcb *newpcb, err_t err);
71
82typedef err_t (*tcp_recv_fn)(void *arg, struct tcp_pcb *tpcb,
83 struct pbuf *p, err_t err);
84
96typedef err_t (*tcp_sent_fn)(void *arg, struct tcp_pcb *tpcb,
97 u16_t len);
98
108typedef err_t (*tcp_poll_fn)(void *arg, struct tcp_pcb *tpcb);
109
120typedef void (*tcp_err_fn)(void *arg, err_t err);
121
134typedef err_t (*tcp_connected_fn)(void *arg, struct tcp_pcb *tpcb, err_t err);
135
136#if LWIP_WND_SCALE
137#define RCV_WND_SCALE(pcb, wnd) (((wnd) >> (pcb)->rcv_scale))
138#define SND_WND_SCALE(pcb, wnd) (((wnd) << (pcb)->snd_scale))
139#define TCPWND16(x) ((u16_t)LWIP_MIN((x), 0xFFFF))
140#define TCP_WND_MAX(pcb) ((tcpwnd_size_t)(((pcb)->flags & TF_WND_SCALE) ? TCP_WND : TCPWND16(TCP_WND)))
141#else
142#define RCV_WND_SCALE(pcb, wnd) (wnd)
143#define SND_WND_SCALE(pcb, wnd) (wnd)
144#define TCPWND16(x) (x)
145#define TCP_WND_MAX(pcb) TCP_WND
146#endif
147/* Increments a tcpwnd_size_t and holds at max value rather than rollover */
148#define TCP_WND_INC(wnd, inc) do { \
149 if ((tcpwnd_size_t)(wnd + inc) >= wnd) { \
150 wnd = (tcpwnd_size_t)(wnd + inc); \
151 } else { \
152 wnd = (tcpwnd_size_t)-1; \
153 } \
154 } while(0)
155
156#if LWIP_TCP_SACK_OUT
159struct tcp_sack_range {
161 u32_t left;
163 u32_t right;
164};
165#endif /* LWIP_TCP_SACK_OUT */
166
173typedef void (*tcp_extarg_callback_pcb_destroyed_fn)(u8_t id, void *data);
174
182typedef err_t (*tcp_extarg_callback_passive_open_fn)(u8_t id, struct tcp_pcb_listen *lpcb, struct tcp_pcb *cpcb);
183
185struct tcp_ext_arg_callbacks {
187 tcp_extarg_callback_pcb_destroyed_fn destroy;
189 tcp_extarg_callback_passive_open_fn passive_open;
190};
191
192#define LWIP_TCP_PCB_NUM_EXT_ARG_ID_INVALID 0xFF
193
194#if LWIP_TCP_PCB_NUM_EXT_ARGS
195/* This is the structure for ext args in tcp pcbs (used as array) */
196struct tcp_pcb_ext_args {
197 const struct tcp_ext_arg_callbacks *callbacks;
198 void *data;
199};
200/* This is a helper define to prevent zero size arrays if disabled */
201#define TCP_PCB_EXTARGS struct tcp_pcb_ext_args ext_args[LWIP_TCP_PCB_NUM_EXT_ARGS];
202#else
203#define TCP_PCB_EXTARGS
204#endif
205
206typedef u16_t tcpflags_t;
207#define TCP_ALLFLAGS 0xffffU
208
212#define TCP_PCB_COMMON(type) \
213 type *next; /* for the linked list */ \
214 void *callback_arg; \
215 TCP_PCB_EXTARGS \
216 enum tcp_state state; /* TCP state */ \
217 u8_t prio; \
218 /* ports are in host byte order */ \
219 u16_t local_port
220
221
223struct tcp_pcb_listen {
225 IP_PCB;
227 TCP_PCB_COMMON(struct tcp_pcb_listen);
228
229#if LWIP_CALLBACK_API
230 /* Function to call when a listener has been connected. */
231 tcp_accept_fn accept;
232#endif /* LWIP_CALLBACK_API */
233
234#if TCP_LISTEN_BACKLOG
235 u8_t backlog;
236 u8_t accepts_pending;
237#endif /* TCP_LISTEN_BACKLOG */
238};
239
240
242struct tcp_pcb {
244 IP_PCB;
246 TCP_PCB_COMMON(struct tcp_pcb);
247
248 /* ports are in host byte order */
249 u16_t remote_port;
250
251 tcpflags_t flags;
252#define TF_ACK_DELAY 0x01U /* Delayed ACK. */
253#define TF_ACK_NOW 0x02U /* Immediate ACK. */
254#define TF_INFR 0x04U /* In fast recovery. */
255#define TF_CLOSEPEND 0x08U /* If this is set, tcp_close failed to enqueue the FIN (retried in tcp_tmr) */
256#define TF_RXCLOSED 0x10U /* rx closed by tcp_shutdown */
257#define TF_FIN 0x20U /* Connection was closed locally (FIN segment enqueued). */
258#define TF_NODELAY 0x40U /* Disable Nagle algorithm */
259#define TF_NAGLEMEMERR 0x80U /* nagle enabled, memerr, try to output to prevent delayed ACK to happen */
260#if LWIP_WND_SCALE
261#define TF_WND_SCALE 0x0100U /* Window Scale option enabled */
262#endif
263#if TCP_LISTEN_BACKLOG
264#define TF_BACKLOGPEND 0x0200U /* If this is set, a connection pcb has increased the backlog on its listener */
265#endif
266#if LWIP_TCP_TIMESTAMPS
267#define TF_TIMESTAMP 0x0400U /* Timestamp option enabled */
268#endif
269#define TF_RTO 0x0800U /* RTO timer has fired, in-flight data moved to unsent and being retransmitted */
270#if LWIP_TCP_SACK_OUT
271#define TF_SACK 0x1000U /* Selective ACKs enabled */
272#endif
273
274 /* the rest of the fields are in host byte order
275 as we have to do some math with them */
276
277 /* Timers */
278 u8_t polltmr, pollinterval;
279 u8_t last_timer;
280 u32_t tmr;
281
282 /* receiver variables */
283 u32_t rcv_nxt; /* next seqno expected */
284 tcpwnd_size_t rcv_wnd; /* receiver window available */
285 tcpwnd_size_t rcv_ann_wnd; /* receiver window to announce */
286 u32_t rcv_ann_right_edge; /* announced right edge of window */
287
288#if LWIP_TCP_SACK_OUT
289 /* SACK ranges to include in ACK packets (entry is invalid if left==right) */
290 struct tcp_sack_range rcv_sacks[LWIP_TCP_MAX_SACK_NUM];
291#define LWIP_TCP_SACK_VALID(pcb, idx) ((pcb)->rcv_sacks[idx].left != (pcb)->rcv_sacks[idx].right)
292#endif /* LWIP_TCP_SACK_OUT */
293
294 /* Retransmission timer. */
295 s16_t rtime;
296
297 u16_t mss; /* maximum segment size */
298
299 /* RTT (round trip time) estimation variables */
300 u32_t rttest; /* RTT estimate in 500ms ticks */
301 u32_t rtseq; /* sequence number being timed */
302 s16_t sa, sv; /* @see "Congestion Avoidance and Control" by Van Jacobson and Karels */
303
304 s16_t rto; /* retransmission time-out (in ticks of TCP_SLOW_INTERVAL) */
305 u8_t nrtx; /* number of retransmissions */
306
307 /* fast retransmit/recovery */
308 u8_t dupacks;
309 u32_t lastack; /* Highest acknowledged seqno. */
310 u32_t fr_unacked_max_seq; /*Highest send seq when FR happened added by tuya*/
311
312 /* congestion avoidance/control variables */
313 tcpwnd_size_t cwnd;
314 tcpwnd_size_t ssthresh;
315
316 /* first byte following last rto byte */
317 u32_t rto_end;
318
319 /* sender variables */
320 u32_t snd_nxt; /* next new seqno to be sent */
321 u32_t snd_wl1, snd_wl2; /* Sequence and acknowledgement numbers of last
322 window update. */
323 u32_t snd_lbb; /* Sequence number of next byte to be buffered. */
324 tcpwnd_size_t snd_wnd; /* sender window */
325 tcpwnd_size_t snd_wnd_max; /* the maximum sender window announced by the remote host */
326
327 tcpwnd_size_t snd_buf; /* Available buffer space for sending (in bytes). */
328#define TCP_SNDQUEUELEN_OVERFLOW (0xffffU-3)
329 u16_t snd_queuelen; /* Number of pbufs currently in the send buffer. */
330
331#if TCP_OVERSIZE
332 /* Extra bytes available at the end of the last pbuf in unsent. */
333 u16_t unsent_oversize;
334#endif /* TCP_OVERSIZE */
335
336 tcpwnd_size_t bytes_acked;
337
338 /* These are ordered by sequence number: */
339 struct tcp_seg *unsent; /* Unsent (queued) segments. */
340 struct tcp_seg *unacked; /* Sent but unacknowledged segments. */
341#if TCP_QUEUE_OOSEQ
342 struct tcp_seg *ooseq; /* Received out of sequence segments. */
343#endif /* TCP_QUEUE_OOSEQ */
344
345 struct pbuf *refused_data; /* Data previously received but not yet taken by upper layer */
346
347#if LWIP_CALLBACK_API || TCP_LISTEN_BACKLOG
348 struct tcp_pcb_listen* listener;
349#endif /* LWIP_CALLBACK_API || TCP_LISTEN_BACKLOG */
350
351#if LWIP_CALLBACK_API
352 /* Function to be called when more send buffer space is available. */
353 tcp_sent_fn sent;
354 /* Function to be called when (in-sequence) data has arrived. */
355 tcp_recv_fn recv;
356 /* Function to be called when a connection has been set up. */
357 tcp_connected_fn connected;
358 /* Function which is called periodically. */
359 tcp_poll_fn poll;
360 /* Function to be called whenever a fatal error occurs. */
361 tcp_err_fn errf;
362#endif /* LWIP_CALLBACK_API */
363
364#if LWIP_TCP_TIMESTAMPS
365 u32_t ts_lastacksent;
366 u32_t ts_recent;
367#endif /* LWIP_TCP_TIMESTAMPS */
368
369 /* idle time before KEEPALIVE is sent */
370 u32_t keep_idle;
371#if LWIP_TCP_KEEPALIVE
372 u32_t keep_intvl;
373 u32_t keep_cnt;
374#endif /* LWIP_TCP_KEEPALIVE */
375
376 /* Persist timer counter */
377 u8_t persist_cnt;
378 /* Persist timer back-off */
379 u8_t persist_backoff;
380 /* Number of persist probes */
381 u8_t persist_probe;
382
383 /* KEEPALIVE counter */
384 u8_t keep_cnt_sent;
385
386#if LWIP_WND_SCALE
387 u8_t snd_scale;
388 u8_t rcv_scale;
389#endif
390};
391
392#if LWIP_EVENT_API
393
394enum lwip_event {
395 LWIP_EVENT_ACCEPT,
396 LWIP_EVENT_SENT,
397 LWIP_EVENT_RECV,
398 LWIP_EVENT_CONNECTED,
399 LWIP_EVENT_POLL,
400 LWIP_EVENT_ERR
401};
402
403err_t lwip_tcp_event(void *arg, struct tcp_pcb *pcb,
404 enum lwip_event,
405 struct pbuf *p,
406 u16_t size,
407 err_t err);
408
409#endif /* LWIP_EVENT_API */
410
411/* Application program's interface: */
412struct tcp_pcb * tcp_new (void);
413struct tcp_pcb * tcp_new_ip_type (u8_t type);
414
415void tcp_arg (struct tcp_pcb *pcb, void *arg);
416#if LWIP_CALLBACK_API
417void tcp_recv (struct tcp_pcb *pcb, tcp_recv_fn recv);
418void tcp_sent (struct tcp_pcb *pcb, tcp_sent_fn sent);
419void tcp_err (struct tcp_pcb *pcb, tcp_err_fn err);
420void tcp_accept (struct tcp_pcb *pcb, tcp_accept_fn accept);
421#endif /* LWIP_CALLBACK_API */
422void tcp_poll (struct tcp_pcb *pcb, tcp_poll_fn poll, u8_t interval);
423
424#define tcp_set_flags(pcb, set_flags) do { (pcb)->flags = (tcpflags_t)((pcb)->flags | (set_flags)); } while(0)
425#define tcp_clear_flags(pcb, clr_flags) do { (pcb)->flags = (tcpflags_t)((pcb)->flags & (tcpflags_t)(~(clr_flags) & TCP_ALLFLAGS)); } while(0)
426#define tcp_is_flag_set(pcb, flag) (((pcb)->flags & (flag)) != 0)
427
428#if LWIP_TCP_TIMESTAMPS
429#define tcp_mss(pcb) (((pcb)->flags & TF_TIMESTAMP) ? ((pcb)->mss - 12) : (pcb)->mss)
430#else /* LWIP_TCP_TIMESTAMPS */
432#define tcp_mss(pcb) ((pcb)->mss)
433#endif /* LWIP_TCP_TIMESTAMPS */
435#define tcp_sndbuf(pcb) (TCPWND16((pcb)->snd_buf))
437#define tcp_sndqueuelen(pcb) ((pcb)->snd_queuelen)
439#define tcp_nagle_disable(pcb) tcp_set_flags(pcb, TF_NODELAY)
441#define tcp_nagle_enable(pcb) tcp_clear_flags(pcb, TF_NODELAY)
443#define tcp_nagle_disabled(pcb) tcp_is_flag_set(pcb, TF_NODELAY)
444
445#if TCP_LISTEN_BACKLOG
446#define tcp_backlog_set(pcb, new_backlog) do { \
447 LWIP_ASSERT("pcb->state == LISTEN (called for wrong pcb?)", (pcb)->state == LISTEN); \
448 ((struct tcp_pcb_listen *)(pcb))->backlog = ((new_backlog) ? (new_backlog) : 1); } while(0)
449void tcp_backlog_delayed(struct tcp_pcb* pcb);
450void tcp_backlog_accepted(struct tcp_pcb* pcb);
451#else /* TCP_LISTEN_BACKLOG */
452#define tcp_backlog_set(pcb, new_backlog)
453#define tcp_backlog_delayed(pcb)
454#define tcp_backlog_accepted(pcb)
455#endif /* TCP_LISTEN_BACKLOG */
456#define tcp_accepted(pcb) do { LWIP_UNUSED_ARG(pcb); } while(0) /* compatibility define, not needed any more */
457
458void tcp_recved (struct tcp_pcb *pcb, u16_t len);
459err_t tcp_bind (struct tcp_pcb *pcb, const ip_addr_t *ipaddr,
460 u16_t port);
461void tcp_bind_netif(struct tcp_pcb *pcb, const struct netif *netif);
462err_t tcp_connect (struct tcp_pcb *pcb, const ip_addr_t *ipaddr,
463 u16_t port, tcp_connected_fn connected);
464
465struct tcp_pcb * tcp_listen_with_backlog_and_err(struct tcp_pcb *pcb, u8_t backlog, err_t *err);
466struct tcp_pcb * tcp_listen_with_backlog(struct tcp_pcb *pcb, u8_t backlog);
468#define tcp_listen(pcb) tcp_listen_with_backlog(pcb, TCP_DEFAULT_LISTEN_BACKLOG)
469
470void tcp_abort (struct tcp_pcb *pcb);
471err_t tcp_close (struct tcp_pcb *pcb);
472err_t tcp_shutdown(struct tcp_pcb *pcb, int shut_rx, int shut_tx);
473
474err_t tcp_write (struct tcp_pcb *pcb, const void *dataptr, u16_t len,
475 u8_t apiflags);
476
477void tcp_setprio (struct tcp_pcb *pcb, u8_t prio);
478
479err_t tcp_output (struct tcp_pcb *pcb);
480
481err_t tcp_tcp_get_tcp_addrinfo(struct tcp_pcb *pcb, int local, ip_addr_t *addr, u16_t *port);
482
483#define tcp_dbg_get_tcp_state(pcb) ((pcb)->state)
484
485/* for compatibility with older implementation */
486#define tcp_new_ip6() tcp_new_ip_type(IPADDR_TYPE_V6)
487
488#if LWIP_TCP_PCB_NUM_EXT_ARGS
489u8_t tcp_ext_arg_alloc_id(void);
490void tcp_ext_arg_set_callbacks(struct tcp_pcb *pcb, uint8_t id, const struct tcp_ext_arg_callbacks * const callbacks);
491void tcp_ext_arg_set(struct tcp_pcb *pcb, uint8_t id, void *arg);
492void *tcp_ext_arg_get(const struct tcp_pcb *pcb, uint8_t id);
493#endif
494
495#ifdef __cplusplus
496}
497#endif
498
499#endif /* LWIP_TCP */
500
501#endif /* LWIP_HDR_TCP_H */
s8_t err_t
Definition: err.h:96
#define LWIP_TCP_MAX_SACK_NUM
Definition: opt.h:1282
#define IP_PCB
Definition: ip.h:76
Definition: netif.h:260
Definition: pbuf.h:186