| /* |
| * Copyright (c) 2001-2004 Swedish Institute of Computer Science. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without modification, |
| * are permitted provided that the following conditions are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright notice, |
| * this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright notice, |
| * this list of conditions and the following disclaimer in the documentation |
| * and/or other materials provided with the distribution. |
| * 3. The name of the author may not be used to endorse or promote products |
| * derived from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT |
| * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT |
| * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING |
| * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY |
| * OF SUCH DAMAGE. |
| * |
| * This file is part of the lwIP TCP/IP stack. |
| * |
| * Author: Adam Dunkels <adam@sics.se> |
| * |
| */ |
| #ifndef __LWIP_TCP_IMPL_H__ |
| #define __LWIP_TCP_IMPL_H__ |
| #include "error.h" |
| #include "net.h" |
| #include "socket.h" |
| #include "net/pbuf.h" |
| #include "net/ip.h" |
| #include "bits/netinet.h" |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| // akaros specific option |
| |
| #define LWIP_EVENT_API 0 |
| |
| struct tcp_hdr; |
| struct tcp_pcb* tcp_alloc(uint8_t prio); |
| /* Functions for interfacing with TCP: */ |
| |
| /* Lower layer interface to TCP: */ |
| #define tcp_init() /* Compatibility define, no init needed. */ |
| void tcp_tmr (void); /* Must be called every |
| TCP_TMR_INTERVAL |
| ms. (Typically 250 ms). */ |
| /* It is also possible to call these two functions at the right |
| intervals (instead of calling tcp_tmr()). */ |
| void tcp_slowtmr (void); |
| void tcp_fasttmr (void); |
| |
| |
| /* Only used by IP to pass a TCP segment to TCP: */ |
| // Change: assumed on network interface |
| void tcp_input (struct pbuf *p); |
| /* Used within the TCP code only: */ |
| void tcp_abandon (struct tcp_pcb *pcb, int reset); |
| error_t tcp_send_empty_ack(struct tcp_pcb *pcb); |
| void tcp_rexmit (struct tcp_pcb *pcb); |
| void tcp_rexmit_rto (struct tcp_pcb *pcb); |
| void tcp_rexmit_fast (struct tcp_pcb *pcb); |
| uint32_t tcp_update_rcv_ann_wnd(struct tcp_pcb *pcb); |
| |
| /** |
| * This is the Nagle algorithm: try to combine user data to send as few TCP |
| * segments as possible. Only send if |
| * - no previously transmitted data on the connection remains unacknowledged or |
| * - the TF_NODELAY flag is set (nagle algorithm turned off for this pcb) or |
| * - the only unsent segment is at least pcb->mss bytes long (or there is more |
| * than one unsent segment - with lwIP, this can happen although unsent->len < mss) |
| * - or if we are in fast-retransmit (TF_INFR) |
| */ |
| #define tcp_do_output_nagle(tpcb) ((((tpcb)->unacked == NULL) || \ |
| ((tpcb)->flags & (TF_NODELAY | TF_INFR)) || \ |
| (((tpcb)->unsent != NULL) && (((tpcb)->unsent->next != NULL) || \ |
| ((tpcb)->unsent->len >= (tpcb)->mss))) \ |
| ) ? 1 : 0) |
| #define tcp_output_nagle(tpcb) (tcp_do_output_nagle(tpcb) ? tcp_output(tpcb) : ESUCCESS) |
| |
| |
| #define TCP_SEQ_LT(a,b) ((int32_t)((a)-(b)) < 0) |
| #define TCP_SEQ_LEQ(a,b) ((int32_t)((a)-(b)) <= 0) |
| #define TCP_SEQ_GT(a,b) ((int32_t)((a)-(b)) > 0) |
| #define TCP_SEQ_GEQ(a,b) ((int32_t)((a)-(b)) >= 0) |
| #define TCP_SEQ_BETWEEN(a,b,c) (TCP_SEQ_GEQ(a,b) && TCP_SEQ_LEQ(a,c)) |
| #define TCP_FIN 0x01U |
| #define TCP_SYN 0x02U |
| #define TCP_RST 0x04U |
| #define TCP_PSH 0x08U |
| #define TCP_ACK 0x10U |
| #define TCP_URG 0x20U |
| #define TCP_ECE 0x40U |
| #define TCP_CWR 0x80U |
| |
| #define TCP_FLAGS 0x3fU |
| |
| /* Length of the TCP header, excluding options. */ |
| #define TCP_HLEN 20 |
| |
| #ifndef TCP_TMR_INTERVAL |
| #define TCP_TMR_INTERVAL 250 /* The TCP timer interval in milliseconds. */ |
| #endif /* TCP_TMR_INTERVAL */ |
| |
| #ifndef TCP_FAST_INTERVAL |
| #define TCP_FAST_INTERVAL TCP_TMR_INTERVAL /* the fine grained timeout in milliseconds */ |
| #endif /* TCP_FAST_INTERVAL */ |
| |
| #ifndef TCP_SLOW_INTERVAL |
| #define TCP_SLOW_INTERVAL (2*TCP_TMR_INTERVAL) /* the coarse grained timeout in milliseconds */ |
| #endif /* TCP_SLOW_INTERVAL */ |
| |
| #define TCP_FIN_WAIT_TIMEOUT 20000 /* milliseconds */ |
| #define TCP_SYN_RCVD_TIMEOUT 20000 /* milliseconds */ |
| |
| #define TCP_OOSEQ_TIMEOUT 6U /* x RTO */ |
| |
| #ifndef TCP_MSL |
| #define TCP_MSL 60000UL /* The maximum segment lifetime in milliseconds */ |
| #endif |
| |
| /* Keepalive values, compliant with RFC 1122. Don't change this unless you know what you're doing */ |
| #ifndef TCP_KEEPIDLE_DEFAULT |
| #define TCP_KEEPIDLE_DEFAULT 7200000UL /* Default KEEPALIVE timer in milliseconds */ |
| #endif |
| |
| #ifndef TCP_KEEPINTVL_DEFAULT |
| #define TCP_KEEPINTVL_DEFAULT 75000UL /* Default Time between KEEPALIVE probes in milliseconds */ |
| #endif |
| |
| #ifndef TCP_KEEPCNT_DEFAULT |
| #define TCP_KEEPCNT_DEFAULT 9U /* Default Counter for KEEPALIVE probes */ |
| #endif |
| |
| #define TCP_MAXIDLE TCP_KEEPCNT_DEFAULT * TCP_KEEPINTVL_DEFAULT /* Maximum KEEPALIVE probe time */ |
| |
| #define TCPH_OFFSET(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) >> 8) |
| #define TCPH_HDRLEN(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) >> 12) |
| #define TCPH_FLAGS(phdr) (ntohs((phdr)->_hdrlen_rsvd_flags) & TCP_FLAGS) |
| |
| #define TCPH_OFFSET_SET(phdr, offset) (phdr)->_hdrlen_rsvd_flags = htons(((offset) << 8) | TCPH_FLAGS(phdr)) |
| #define TCPH_HDRLEN_SET(phdr, len) (phdr)->_hdrlen_rsvd_flags = htons(((len) << 12) | TCPH_FLAGS(phdr)) |
| #define TCPH_FLAGS_SET(phdr, flags) (phdr)->_hdrlen_rsvd_flags = (((phdr)->_hdrlen_rsvd_flags & PP_HTONS((uint16_t)(~(uint16_t)(TCP_FLAGS)))) | htons(flags)) |
| #define TCPH_HDRLEN_FLAGS_SET(phdr, len, flags) (phdr)->_hdrlen_rsvd_flags = htons(((len) << 12) | (flags)) |
| |
| #define TCPH_SET_FLAG(phdr, flags ) (phdr)->_hdrlen_rsvd_flags = ((phdr)->_hdrlen_rsvd_flags | htons(flags)) |
| #define TCPH_UNSET_FLAG(phdr, flags) (phdr)->_hdrlen_rsvd_flags = htons(ntohs((phdr)->_hdrlen_rsvd_flags) | (TCPH_FLAGS(phdr) & ~(flags)) ) |
| |
| #define TCP_TCPLEN(seg) ((seg)->len + ((TCPH_FLAGS((seg)->tcphdr) & (TCP_FIN | TCP_SYN)) != 0)) |
| |
| /** Flags used on input processing, not on pcb->flags |
| */ |
| #define TF_RESET (uint8_t)0x08U /* Connection was reset. */ |
| #define TF_CLOSED (uint8_t)0x10U /* Connection was sucessfully closed. */ |
| #define TF_GOT_FIN (uint8_t)0x20U /* Connection was closed by the remote end. */ |
| |
| #if LWIP_EVENT_API |
| |
| #define TCP_EVENT_ACCEPT(pcb,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\ |
| LWIP_EVENT_ACCEPT, NULL, 0, err) |
| #define TCP_EVENT_SENT(pcb,space,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\ |
| LWIP_EVENT_SENT, NULL, space, ESUCCESS) |
| #define TCP_EVENT_RECV(pcb,p,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\ |
| LWIP_EVENT_RECV, (p), 0, (err)) |
| #define TCP_EVENT_CLOSED(pcb,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\ |
| LWIP_EVENT_RECV, NULL, 0, ESUCCESS) |
| #define TCP_EVENT_CONNECTED(pcb,err,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\ |
| LWIP_EVENT_CONNECTED, NULL, 0, (err)) |
| #define TCP_EVENT_POLL(pcb,ret) ret = lwip_tcp_event((pcb)->callback_arg, (pcb),\ |
| LWIP_EVENT_POLL, NULL, 0, ESUCCESS) |
| #define TCP_EVENT_ERR(errf,arg,err) lwip_tcp_event((arg), NULL, \ |
| LWIP_EVENT_ERR, NULL, 0, (err)) |
| |
| #else /* LWIP_EVENT_API */ |
| |
| #define TCP_EVENT_ACCEPT(pcb,err,ret) \ |
| do { \ |
| if((pcb)->accept != NULL) \ |
| (ret) = (pcb)->accept((pcb)->callback_arg,(pcb),(err)); \ |
| else (ret) = EFAIL; \ |
| } while (0) |
| |
| #define TCP_EVENT_SENT(pcb,space,ret) \ |
| do { \ |
| if((pcb)->sent != NULL) \ |
| (ret) = (pcb)->sent((pcb)->callback_arg,(pcb),(space)); \ |
| else (ret) = ESUCCESS; \ |
| } while (0) |
| |
| #define TCP_EVENT_RECV(pcb,p,err,ret) \ |
| do { \ |
| if((pcb)->recv != NULL) { \ |
| (ret) = (pcb)->recv((pcb)->callback_arg,(pcb),(p),(err));\ |
| } else { \ |
| (ret) = tcp_recv_null(NULL, (pcb), (p), (err)); \ |
| } \ |
| } while (0) |
| |
| #define TCP_EVENT_CLOSED(pcb,ret) \ |
| do { \ |
| if(((pcb)->recv != NULL)) { \ |
| (ret) = (pcb)->recv((pcb)->callback_arg,(pcb),NULL,ESUCCESS);\ |
| } else { \ |
| (ret) = ESUCCESS; \ |
| } \ |
| } while (0) |
| |
| #define TCP_EVENT_CONNECTED(pcb,err,ret) \ |
| do { \ |
| if((pcb)->connected != NULL) \ |
| (ret) = (pcb)->connected((pcb)->callback_arg,(pcb),(err)); \ |
| else (ret) = ESUCCESS; \ |
| } while (0) |
| |
| #define TCP_EVENT_POLL(pcb,ret) \ |
| do { \ |
| if((pcb)->poll != NULL) \ |
| (ret) = (pcb)->poll((pcb)->callback_arg,(pcb)); \ |
| else (ret) = ESUCCESS; \ |
| } while (0) |
| |
| #define TCP_EVENT_ERR(errf,arg,err) \ |
| do { \ |
| if((errf) != NULL) \ |
| (errf)((arg),(err)); \ |
| } while (0) |
| |
| #endif /* LWIP_EVENT_API */ |
| |
| /** Enabled extra-check for TCP_OVERSIZE if LWIP_DEBUG is enabled */ |
| #if TCP_OVERSIZE && defined(LWIP_DEBUG) |
| #define TCP_OVERSIZE_DBGCHECK 1 |
| #else |
| #define TCP_OVERSIZE_DBGCHECK 0 |
| #endif |
| |
| /** Don't generate checksum on copy if CHECKSUM_GEN_TCP is disabled */ |
| #define TCP_CHECKSUM_ON_COPY (CHECKSUM_GEN_TCP) |
| |
| /* This structure represents a TCP segment on the unsent, unacked and ooseq queues */ |
| struct tcp_seg { |
| struct tcp_seg *next; /* used when putting segements on a queue */ |
| struct pbuf *p; /* buffer containing data + TCP header */ |
| void *dataptr; /* pointer to the TCP data in the pbuf */ |
| uint16_t len; /* the TCP length of this segment */ |
| #if TCP_OVERSIZE_DBGCHECK |
| uint16_t oversize_left; /* Extra bytes available at the end of the last |
| pbuf in unsent (used for asserting vs. |
| tcp_pcb.unsent_oversized only) */ |
| #endif /* TCP_OVERSIZE_DBGCHECK */ |
| #if TCP_CHECKSUM_ON_COPY |
| uint16_t chksum; |
| uint8_t chksum_swapped; |
| #endif /* TCP_CHECKSUM_ON_COPY */ |
| uint8_t flags; |
| #define TF_SEG_OPTS_MSS (uint8_t)0x01U /* Include MSS option. */ |
| #define TF_SEG_OPTS_TS (uint8_t)0x02U /* Include timestamp option. */ |
| #define TF_SEG_DATA_CHECKSUMMED (uint8_t)0x04U /* ALL data (not the header) is |
| checksummed into 'chksum' */ |
| struct tcp_hdr *tcphdr; /* the TCP header */ |
| }; |
| |
| #define LWIP_TCP_OPT_LENGTH(flags) \ |
| (flags & TF_SEG_OPTS_MSS ? 4 : 0) + \ |
| (flags & TF_SEG_OPTS_TS ? 12 : 0) |
| |
| /** This returns a TCP header option for MSS in an uint32_t */ |
| #define TCP_BUILD_MSS_OPTION(x) (x) = PP_HTONL(((uint32_t)2 << 24) | \ |
| ((uint32_t)4 << 16) | \ |
| (((uint32_t)TCP_MSS / 256) << 8) | \ |
| (TCP_MSS & 255)) |
| |
| /* Global variables: */ |
| extern struct tcp_pcb *tcp_input_pcb; |
| extern uint32_t tcp_ticks; |
| |
| /* The TCP PCB lists. */ |
| union tcp_listen_pcbs_t { /* List of all TCP PCBs in LISTEN state. */ |
| struct tcp_pcb_listen *listen_pcbs; |
| struct tcp_pcb *pcbs; |
| }; |
| extern struct tcp_pcb *tcp_bound_pcbs; |
| extern union tcp_listen_pcbs_t tcp_listen_pcbs; |
| extern struct tcp_pcb *tcp_active_pcbs; /* List of all TCP PCBs that are in a |
| state in which they accept or send |
| data. */ |
| extern struct tcp_pcb *tcp_tw_pcbs; /* List of all TCP PCBs in TIME-WAIT. */ |
| |
| extern struct tcp_pcb *tcp_tmp_pcb; /* Only used for temporary storage. */ |
| |
| /* Axioms about the above lists: |
| 1) Every TCP PCB that is not CLOSED is in one of the lists. |
| 2) A PCB is only in one of the lists. |
| 3) All PCBs in the tcp_listen_pcbs list is in LISTEN state. |
| 4) All PCBs in the tcp_tw_pcbs list is in TIME-WAIT state. |
| */ |
| /* Define two macros, TCP_REG and TCP_RMV that registers a TCP PCB |
| with a PCB list or removes a PCB from a list, respectively. */ |
| #ifndef TCP_DEBUG_PCB_LISTS |
| #define TCP_DEBUG_PCB_LISTS 0 |
| #endif |
| #if TCP_DEBUG_PCB_LISTS |
| #define TCP_REG(pcbs, npcb) do {\ |
| LWIP_DEBUGF(TCP_DEBUG, ("TCP_REG %p local port %d\n", (npcb), (npcb)->local_port)); \ |
| for(tcp_tmp_pcb = *(pcbs); \ |
| tcp_tmp_pcb != NULL; \ |
| tcp_tmp_pcb = tcp_tmp_pcb->next) { \ |
| LWIP_ASSERT("TCP_REG: already registered\n", tcp_tmp_pcb != (npcb)); \ |
| } \ |
| LWIP_ASSERT("TCP_REG: pcb->state != CLOSED", ((pcbs) == &tcp_bound_pcbs) || ((npcb)->state != CLOSED)); \ |
| (npcb)->next = *(pcbs); \ |
| LWIP_ASSERT("TCP_REG: npcb->next != npcb", (npcb)->next != (npcb)); \ |
| *(pcbs) = (npcb); \ |
| LWIP_ASSERT("TCP_RMV: tcp_pcbs sane", tcp_pcbs_sane()); \ |
| tcp_timer_needed(); \ |
| } while(0) |
| #define TCP_RMV(pcbs, npcb) do { \ |
| LWIP_ASSERT("TCP_RMV: pcbs != NULL", *(pcbs) != NULL); \ |
| LWIP_DEBUGF(TCP_DEBUG, ("TCP_RMV: removing %p from %p\n", (npcb), *(pcbs))); \ |
| if(*(pcbs) == (npcb)) { \ |
| *(pcbs) = (*pcbs)->next; \ |
| } else for(tcp_tmp_pcb = *(pcbs); tcp_tmp_pcb != NULL; tcp_tmp_pcb = tcp_tmp_pcb->next) { \ |
| if(tcp_tmp_pcb->next == (npcb)) { \ |
| tcp_tmp_pcb->next = (npcb)->next; \ |
| break; \ |
| } \ |
| } \ |
| (npcb)->next = NULL; \ |
| LWIP_ASSERT("TCP_RMV: tcp_pcbs sane", tcp_pcbs_sane()); \ |
| LWIP_DEBUGF(TCP_DEBUG, ("TCP_RMV: removed %p from %p\n", (npcb), *(pcbs))); \ |
| } while(0) |
| |
| #else /* LWIP_DEBUG */ |
| |
| #define TCP_REG(pcbs, npcb) \ |
| do { \ |
| (npcb)->next = *pcbs; \ |
| *(pcbs) = (npcb); \ |
| tcp_timer_needed(); \ |
| } while (0) |
| |
| #define TCP_RMV(pcbs, npcb) \ |
| do { \ |
| if(*(pcbs) == (npcb)) { \ |
| (*(pcbs)) = (*pcbs)->next; \ |
| } \ |
| else { \ |
| for(tcp_tmp_pcb = *pcbs; \ |
| tcp_tmp_pcb != NULL; \ |
| tcp_tmp_pcb = tcp_tmp_pcb->next) { \ |
| if(tcp_tmp_pcb->next == (npcb)) { \ |
| tcp_tmp_pcb->next = (npcb)->next; \ |
| break; \ |
| } \ |
| } \ |
| } \ |
| (npcb)->next = NULL; \ |
| } while(0) |
| |
| #endif /* LWIP_DEBUG */ |
| |
| |
| /* Internal functions: */ |
| struct tcp_pcb *tcp_pcb_copy(struct tcp_pcb *pcb); |
| void tcp_pcb_purge(struct tcp_pcb *pcb); |
| void tcp_pcb_remove(struct tcp_pcb **pcblist, struct tcp_pcb *pcb); |
| |
| void tcp_segs_free(struct tcp_seg *seg); |
| void tcp_seg_free(struct tcp_seg *seg); |
| struct tcp_seg *tcp_seg_copy(struct tcp_seg *seg); |
| |
| #define tcp_ack(pcb) \ |
| do { \ |
| if((pcb)->flags & TF_ACK_DELAY) { \ |
| (pcb)->flags &= ~TF_ACK_DELAY; \ |
| (pcb)->flags |= TF_ACK_NOW; \ |
| } \ |
| else { \ |
| (pcb)->flags |= TF_ACK_DELAY; \ |
| } \ |
| } while (0) |
| |
| #define tcp_ack_now(pcb) \ |
| do { \ |
| (pcb)->flags |= TF_ACK_NOW; \ |
| } while (0) |
| |
| error_t tcp_send_fin(struct tcp_pcb *pcb); |
| error_t tcp_enqueue_flags(struct tcp_pcb *pcb, uint8_t flags); |
| |
| void tcp_rexmit_seg(struct tcp_pcb *pcb, struct tcp_seg *seg); |
| |
| void tcp_rst(uint32_t seqno, uint32_t ackno, |
| ip_addr_t *local_ip, ip_addr_t *remote_ip, |
| uint16_t local_port, uint16_t remote_port); |
| |
| uint32_t tcp_next_iss(void); |
| |
| void tcp_keepalive(struct tcp_pcb *pcb); |
| void tcp_zero_window_probe(struct tcp_pcb *pcb); |
| |
| #if TCP_CALCULATE_EFF_SEND_MSS |
| uint16_t tcp_eff_send_mss(uint16_t sendmss, ip_addr_t *addr); |
| #endif /* TCP_CALCULATE_EFF_SEND_MSS */ |
| |
| #if LWIP_CALLBACK_API |
| error_t tcp_recv_null(void *arg, struct tcp_pcb *pcb, struct pbuf *p, error_t err); |
| #endif /* LWIP_CALLBACK_API */ |
| |
| #if TCP_DEBUG || TCP_INPUT_DEBUG || TCP_OUTPUT_DEBUG |
| void tcp_debug_print(struct tcp_hdr *tcphdr); |
| void tcp_debug_print_flags(uint8_t flags); |
| void tcp_debug_print_state(enum tcp_state s); |
| void tcp_debug_print_pcbs(void); |
| s16_t tcp_pcbs_sane(void); |
| #else |
| # define tcp_debug_print(tcphdr) |
| # define tcp_debug_print_flags(flags) |
| # define tcp_debug_print_state(s) |
| # define tcp_debug_print_pcbs() |
| # define tcp_pcbs_sane() 1 |
| #endif /* TCP_DEBUG */ |
| |
| /** External function (implemented in timers.c), called when TCP detects |
| * that a timer is needed (i.e. active- or time-wait-pcb found). */ |
| void tcp_timer_needed(void); |
| |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* __LWIP_TCP_H__ */ |
