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