455a19bf0e6f3dbb0d5ee5eff6faa74825f26176
[akaros.git] / kern / src / net / tcp.c
1 /**
2  * @file
3  * Transmission Control Protocol for IP
4  *
5  * This file contains common functions for the TCP implementation, such as functinos
6  * for manipulating the data structures and the TCP timer functions. TCP functions
7  * related to input and output is found in tcp_in.c and tcp_out.c respectively.
8  *
9  */
10
11 /*
12  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
13  * All rights reserved. 
14  * 
15  * Redistribution and use in source and binary forms, with or without modification, 
16  * are permitted provided that the following conditions are met:
17  *
18  * 1. Redistributions of source code must retain the above copyright notice,
19  *    this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright notice,
21  *    this list of conditions and the following disclaimer in the documentation
22  *    and/or other materials provided with the distribution.
23  * 3. The name of the author may not be used to endorse or promote products
24  *    derived from this software without specific prior written permission. 
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 
27  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
28  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
29  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
30  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
31  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
32  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
33  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
34  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 
35  * OF SUCH DAMAGE.
36  *
37  * This file is part of the lwIP TCP/IP stack.
38  * 
39  * Author: Adam Dunkels <adam@sics.se>
40  * Modified by David Zhu <yuzhu@cs.berkeley.edu> to be used for Akaros
41  *
42  */
43
44 #include <ros/common.h>
45 #include <string.h>
46 #include <kmalloc.h>
47 #include <net.h>
48 #include <sys/queue.h>
49 #include <atomic.h>
50
51 #include <bits/netinet.h>
52 #include <net/ip.h>
53 #include <net/tcp.h>
54 #include <net/tcp_impl.h>
55 #include <slab.h>
56 #include <socket.h>
57 #include <string.h>
58 #include <debug.h>
59
60 /* String array used to display different TCP states */
61 const char * const tcp_state_str[] = {
62   "CLOSED",      
63   "LISTEN",      
64   "SYN_SENT",    
65   "SYN_RCVD",    
66   "ESTABLISHED", 
67   "FIN_WAIT_1",  
68   "FIN_WAIT_2",  
69   "CLOSE_WAIT",  
70   "CLOSING",     
71   "LAST_ACK",    
72   "TIME_WAIT"   
73 };
74
75 const uint8_t tcp_backoff[13] =
76     { 1, 2, 3, 4, 5, 6, 7, 7, 7, 7, 7, 7, 7};
77  /* Times per slowtmr hits */
78 const uint8_t tcp_persist_backoff[7] = { 3, 6, 12, 24, 48, 96, 120 };
79
80 struct tcp_pcb *tcp_pcbs;
81
82 /** List of all TCP PCBs bound but not yet (connected || listening) */
83 struct tcp_pcb *tcp_bound_pcbs;
84 /** List of all TCP PCBs in LISTEN state */
85 union tcp_listen_pcbs_t tcp_listen_pcbs;
86 /** List of all TCP PCBs that are in a state in which
87  * they accept or send data. */
88 struct tcp_pcb *tcp_active_pcbs;
89 /** List of all TCP PCBs in TIME-WAIT state */
90 struct tcp_pcb *tcp_tw_pcbs;
91
92 #define NUM_TCP_PCB_LISTS               4
93 #define NUM_TCP_PCB_LISTS_NO_TIME_WAIT  3
94 /** An array with all (non-temporary) PCB lists, mainly used for smaller code size */
95 struct tcp_pcb **tcp_pcb_lists[] = {&tcp_listen_pcbs.pcbs, &tcp_bound_pcbs,
96   &tcp_active_pcbs, &tcp_tw_pcbs};
97
98 /** Timer counter to handle calling slow-timer from tcp_tmr() */ 
99 static uint8_t tcp_timer;
100 static uint16_t tcp_new_port(void);
101
102 /** Only used for temporary storage. */
103 struct tcp_pcb *tcp_tmp_pcb;
104
105 /* Incremented every coarse grained timer shot (typically every 500 ms). */
106 uint32_t tcp_ticks;
107 uint16_t tcp_port_num = SOCKET_PORT_START;
108
109 static uint16_t tcp_new_port(void);
110 /**
111  * Abandons a connection and optionally sends a RST to the remote
112  * host.  Deletes the local protocol control block. This is done when
113  * a connection is killed because of shortage of memory.
114  *
115  * @param pcb the tcp_pcb to abort
116  * @param reset boolean to indicate whether a reset should be sent
117  */
118 void
119 tcp_abandon(struct tcp_pcb *pcb, int reset)
120 {
121   uint32_t seqno, ackno;
122   uint16_t remote_port, local_port;
123   ip_addr_t remote_ip, local_ip;
124 #if LWIP_CALLBACK_API  
125   tcp_err_fn errf;
126 #endif /* LWIP_CALLBACK_API */
127   void *errf_arg;
128
129   /* pcb->state LISTEN not allowed here */
130   LWIP_ASSERT("don't call tcp_abort/tcp_abandon for listen-pcbs",
131     pcb->state != LISTEN);
132   /* Figure out on which TCP PCB list we are, and remove us. If we
133      are in an active state, call the receive function associated with
134      the PCB with a NULL argument, and send an RST to the remote end. */
135   if (pcb->state == TIME_WAIT) {
136     tcp_pcb_remove(&tcp_tw_pcbs, pcb);
137                 kmem_cache_free(tcp_pcb_kcache, (void*)pcb);
138   } else {
139     seqno = pcb->snd_nxt;
140     ackno = pcb->rcv_nxt;
141     ip_addr_copy(local_ip, pcb->local_ip);
142     ip_addr_copy(remote_ip, pcb->remote_ip);
143     local_port = pcb->local_port;
144     remote_port = pcb->remote_port;
145 #if LWIP_CALLBACK_API
146     errf = pcb->errf;
147 #endif /* LWIP_CALLBACK_API */
148     errf_arg = pcb->callback_arg;
149     tcp_pcb_remove(&tcp_active_pcbs, pcb);
150     if (pcb->unacked != NULL) {
151       tcp_segs_free(pcb->unacked);
152     }
153     if (pcb->unsent != NULL) {
154       tcp_segs_free(pcb->unsent);
155     }
156 #if TCP_QUEUE_OOSEQ    
157     if (pcb->ooseq != NULL) {
158       tcp_segs_free(pcb->ooseq);
159     }
160 #endif /* TCP_QUEUE_OOSEQ */
161                 kmem_cache_free(tcp_pcb_kcache, (void*)pcb);
162     TCP_EVENT_ERR(errf, errf_arg, ECONNABORTED);
163     if (reset) {
164       LWIP_DEBUGF(TCP_RST_DEBUG, ("tcp_abandon: sending RST\n"));
165       tcp_rst(seqno, ackno, &local_ip, &remote_ip, local_port, remote_port);
166     }
167   }
168 }
169
170 /**
171  * Aborts the connection by sending a RST (reset) segment to the remote
172  * host. The pcb is deallocated. This function never fails.
173  *
174  * ATTENTION: When calling this from one of the TCP callbacks, make
175  * sure you always return ECONNABORTED (and never return ECONNABORTED otherwise
176  * or you will risk accessing deallocated memory or memory leaks!
177  *
178  * @param pcb the tcp pcb to abort
179  */
180 void
181 tcp_abort(struct tcp_pcb *pcb)
182 {
183   tcp_abandon(pcb, 1);
184 }
185
186
187 /** 
188  * Update the state that tracks the available window space to advertise.
189  *
190  * Returns how much extra window would be advertised if we sent an
191  * update now.
192  */
193 uint32_t tcp_update_rcv_ann_wnd(struct tcp_pcb *pcb)
194 {
195   uint32_t new_right_edge = pcb->rcv_nxt + pcb->rcv_wnd;
196
197   if (TCP_SEQ_GEQ(new_right_edge, pcb->rcv_ann_right_edge + MIN((TCP_WND / 2), pcb->mss))) {
198     /* we can advertise more window */
199     pcb->rcv_ann_wnd = pcb->rcv_wnd;
200     return new_right_edge - pcb->rcv_ann_right_edge;
201   } else {
202     if (TCP_SEQ_GT(pcb->rcv_nxt, pcb->rcv_ann_right_edge)) {
203       /* Can happen due to other end sending out of advertised window,
204        * but within actual available (but not yet advertised) window */
205       pcb->rcv_ann_wnd = 0;
206     } else {
207       /* keep the right edge of window constant */
208       uint32_t new_rcv_ann_wnd = pcb->rcv_ann_right_edge - pcb->rcv_nxt;
209       pcb->rcv_ann_wnd = (uint16_t)new_rcv_ann_wnd;
210     }
211     return 0;
212   }
213 }
214
215 /**
216  * Kills the oldest connection that is in TIME_WAIT state.
217  * Called from tcp_alloc() if no more connections are available.
218  */
219 static void
220 tcp_kill_timewait(void)
221 {
222   struct tcp_pcb *pcb, *inactive;
223   uint32_t inactivity;
224
225   inactivity = 0;
226   inactive = NULL;
227   /* Go through the list of TIME_WAIT pcbs and get the oldest pcb. */
228   for(pcb = tcp_tw_pcbs; pcb != NULL; pcb = pcb->next) {
229     if ((uint32_t)(tcp_ticks - pcb->tmr) >= inactivity) {
230       inactivity = tcp_ticks - pcb->tmr;
231       inactive = pcb;
232     }
233   }
234   if (inactive != NULL) {
235     LWIP_DEBUGF(TCP_DEBUG, ("tcp_kill_timewait: killing oldest TIME-WAIT PCB %p (%"S32_F")\n",
236            (void *)inactive, inactivity));
237     tcp_abort(inactive);
238   }
239 }
240
241 /**
242  * Kills the oldest active connection that has lower priority than prio.
243  *
244  * @param prio minimum priority
245  */
246 static void
247 tcp_kill_prio(uint8_t prio)
248 {
249   struct tcp_pcb *pcb, *inactive;
250   uint32_t inactivity;
251   uint8_t mprio;
252
253
254   mprio = TCP_PRIO_MAX;
255   
256   /* We kill the oldest active connection that has lower priority than prio. */
257   inactivity = 0;
258   inactive = NULL;
259   for(pcb = tcp_active_pcbs; pcb != NULL; pcb = pcb->next) {
260     if (pcb->prio <= prio &&
261        pcb->prio <= mprio &&
262        (uint32_t)(tcp_ticks - pcb->tmr) >= inactivity) {
263       inactivity = tcp_ticks - pcb->tmr;
264       inactive = pcb;
265       mprio = pcb->prio;
266     }
267   }
268   if (inactive != NULL) {
269     LWIP_DEBUGF(TCP_DEBUG, ("tcp_kill_prio: killing oldest PCB %p (%"S32_F")\n",
270            (void *)inactive, inactivity));
271     tcp_abort(inactive);
272   }
273 }
274 /**
275  * This function should be called by the application when it has
276  * processed the data. The purpose is to advertise a larger window
277  * when the data has been processed.
278  *
279  * @param pcb the tcp_pcb for which data is read
280  * @param len the amount of bytes that have been read by the application
281  */
282 void
283 tcp_recved(struct tcp_pcb *pcb, uint16_t len)
284 {
285   int wnd_inflation;
286
287   check(len <= 0xffff - pcb->rcv_wnd);
288
289   pcb->rcv_wnd += len;
290   if (pcb->rcv_wnd > TCP_WND) {
291     pcb->rcv_wnd = TCP_WND;
292   }
293
294   wnd_inflation = tcp_update_rcv_ann_wnd(pcb);
295
296   /* If the change in the right edge of window is significant (default
297    * watermark is TCP_WND/4), then send an explicit update now.
298    * Otherwise wait for a packet to be sent in the normal course of
299    * events (or more window to be available later) */
300   if (wnd_inflation >= TCP_WND_UPDATE_THRESHOLD) {
301     tcp_ack_now(pcb);
302     //XXX: tcp_output(pcb);
303   }
304
305   printk("tcp_recved: received %d  bytes, wnd %d (%d).\n",
306          len, pcb->rcv_wnd, TCP_WND - pcb->rcv_wnd);
307 }
308
309 static void wrap_restart_kthread(struct trapframe *tf, uint32_t srcid,
310                                         long a0, long a1, long a2){
311         restart_kthread((struct kthread*) a0);
312 }
313
314 /**
315  * Default receive callback that is called if the user didn't register
316  * a recv callback for the pcb.
317  */
318 error_t tcp_recv_null(void *arg, struct tcp_pcb *pcb, struct pbuf *p, error_t err) {
319         if (pcb == NULL || pcb->pcbsock == NULL) {
320                 pbuf_free(p);
321                 return -1;
322         }
323   if (p != NULL && pcb != NULL) {
324                 // notify that we have recved and increase the recv window
325                 // attach it to socket
326                 struct socket *sock = pcb->pcbsock;
327                 // TODO: attach_pbuf needs to return stuff that can not fit in the buffer right now
328                 attach_pbuf(p, &sock->recv_buff);
329                 struct kthread *kthread;
330                 /* First notify any blocking recv calls,
331                  * then notify anyone who might be waiting in a select
332                  */ 
333                 // multiple people might be waiting on the socket here..
334                 kthread = __up_sem(&(sock->sem), FALSE);
335                 if (kthread) {
336                          send_kernel_message(core_id(), (amr_t)wrap_restart_kthread, (long)kthread, 0, 0,
337                                                                                                   KMSG_ROUTINE);
338                 } else {
339                         // wake up all waiters
340                         struct semaphore_entry *sentry, *sentry_tmp;
341                         spin_lock(&sock->waiter_lock);
342                   LIST_FOREACH_SAFE(sentry, &(sock->waiters), link, sentry_tmp){
343                                 //should only wake up one waiter
344                                 kthread = __up_sem(&sentry->sem, true);
345                                 if (kthread){
346                                 send_kernel_message(core_id(), (amr_t)wrap_restart_kthread, (long)kthread, 0, 0,
347                                                                                                   KMSG_ROUTINE);
348                                 }
349                                 LIST_REMOVE(sentry, link);
350                                 /* do not need to free since all the sentry are stack-based vars */
351                         }
352                         spin_unlock(&sock->waiter_lock);
353                 }
354         }
355         printk ("received total length tcp %d\n", p->tot_len);
356         tcp_recved(pcb, p->tot_len);
357         // decref
358         pbuf_free(p);
359   return ESUCCESS;
360 }
361
362
363 /**
364  * Creates a new TCP protocol control block but doesn't place it on
365  * any of the TCP PCB lists.
366  * The pcb is not put on any list until binding using tcp_bind().
367  *
368  * @internal: Maybe there should be a idle TCP PCB list where these
369  * PCBs are put on. Port reservation using tcp_bind() is implemented but
370  * allocated pcbs that are not bound can't be killed automatically if wanting
371  * to allocate a pcb with higher prio (@see tcp_kill_prio())
372  *
373  * @return a new tcp_pcb that initially is in state CLOSED
374  */
375 struct tcp_pcb* tcp_new(void) {
376   return tcp_alloc(TCP_PRIO_NORMAL);
377 }
378
379 /**
380  * Calculates a new initial sequence number for new connections.
381  * TODO: Consider use a secure pseduo ISN
382  *
383  * @return uint32_t pseudo random sequence number
384  */
385 uint32_t tcp_next_iss(void)
386 {
387   static uint32_t iss = 6510;
388   
389   iss += tcp_ticks;       /* XXX */
390   return iss;
391 }
392
393 /**
394  * Allocate a new tcp_pcb structure.
395  *
396  * @param prio priority for the new pcb
397  * @return a new tcp_pcb that initially is in state CLOSED
398  */
399 struct tcp_pcb* tcp_alloc(uint8_t prio) {
400   struct tcp_pcb *pcb;
401   uint32_t iss;
402   pcb = kmem_cache_alloc(tcp_pcb_kcache, 0);
403   if (pcb == NULL) {
404                 /* Try killing oldest connection in TIME-WAIT. */
405                 printd("tcp_alloc: killing off oldest TIME-WAIT connection\n");
406                 tcp_kill_timewait();
407                 /* Try to allocate a tcp_pcb again. */
408                 pcb = (struct tcp_pcb *)kmem_cache_alloc(tcp_pcb_kcache, 0);
409                 if (pcb == NULL) {
410                         /* Try killing active connections with lower priority than the new one. */
411                         printd("tcp_alloc: killing connection with prio lower than %d\n", prio);
412                         tcp_kill_prio(prio);
413                         /* Try to allocate a tcp_pcb again. */
414                         pcb = (struct tcp_pcb *)kmem_cache_alloc(tcp_pcb_kcache, 0);
415                 }
416         }
417   if (pcb != NULL) {
418     memset(pcb, 0, sizeof(struct tcp_pcb));
419     pcb->prio = prio;
420     pcb->snd_buf = TCP_SND_BUF;
421     pcb->snd_queuelen = 0;
422     pcb->rcv_wnd = TCP_WND;
423     pcb->rcv_ann_wnd = TCP_WND;
424     pcb->tos = 0;
425     pcb->ttl = TCP_TTL;
426     /* As initial send MSS, we use TCP_MSS but limit it to 536.
427        The send MSS is updated when an MSS option is received. */
428     pcb->mss = (TCP_MSS > 536) ? 536 : TCP_MSS;
429     pcb->rto = 3000 / TCP_SLOW_INTERVAL;
430     pcb->sa = 0;
431     pcb->sv = 3000 / TCP_SLOW_INTERVAL;
432     pcb->rtime = -1;
433     pcb->cwnd = 1;
434     iss = tcp_next_iss();
435     pcb->snd_wl2 = iss;
436     pcb->snd_nxt = iss;
437     pcb->lastack = iss;
438     pcb->snd_lbb = iss;   
439     pcb->tmr = tcp_ticks;
440
441     pcb->polltmr = 0;
442
443 /* Basically we need to use the callback api because then we can switch
444  * handlers based on the state that the pcb is in. 
445  */
446
447     pcb->recv = tcp_recv_null;
448     
449     /* Init KEEPALIVE timer */
450     pcb->keep_idle  = TCP_KEEPIDLE_DEFAULT;
451     
452 #if LWIP_TCP_KEEPALIVE
453     pcb->keep_intvl = TCP_KEEPINTVL_DEFAULT;
454     pcb->keep_cnt   = TCP_KEEPCNT_DEFAULT;
455 #endif /* LWIP_TCP_KEEPALIVE */
456
457     pcb->keep_cnt_sent = 0;
458   }
459   return pcb;
460 }
461
462 /**
463  * A nastly hack featuring 'goto' statements that allocates a
464  * new TCP local port.
465  *
466  * @return a new (free) local TCP port number
467  */
468 static uint16_t tcp_new_port(void) {
469   int i;
470   struct tcp_pcb *pcb;
471   static uint16_t port = TCP_LOCAL_PORT_RANGE_START;
472   
473  again:
474   if (++port > TCP_LOCAL_PORT_RANGE_END) {
475     port = TCP_LOCAL_PORT_RANGE_START;
476   }
477   /* Check all PCB lists. */
478   for (i = 0; i < NUM_TCP_PCB_LISTS; i++) {  
479     for(pcb = *tcp_pcb_lists[i]; pcb != NULL; pcb = pcb->next) {
480       if (pcb->local_port == port) {
481         goto again;
482       }
483     }
484   }
485   return port;
486 }
487
488
489 /**
490  * Binds the connection to a local portnumber and IP address. If the
491  * IP address is not given (i.e., ipaddr == NULL), the IP address of
492  * the outgoing network interface is used instead.
493  *
494  * @param pcb the tcp_pcb to bind (no check is done whether this pcb is
495  *        already bound!)
496  * @param ipaddr the local ip address to bind to (use IP_ADDR_ANY to bind
497  *        to any local address
498  * @param port the local port to bind to
499  * @return ERR_USE if the port is already in use
500  *         ESUCCESS if bound
501  */
502 error_t tcp_bind(struct tcp_pcb *pcb, const struct in_addr *ipaddr, uint16_t port) {
503   int i;
504   int max_pcb_list = NUM_TCP_PCB_LISTS;
505   struct tcp_pcb *cpcb;
506
507   LWIP_ERROR("tcp_bind: can only bind in state CLOSED", pcb->state == CLOSED, return -EISCONN);
508
509 #if SO_REUSE
510   /* Unless the REUSEADDR flag is set,
511      we have to check the pcbs in TIME-WAIT state, also.
512      We do not dump TIME_WAIT pcb's; they can still be matched by incoming
513      packets using both local and remote IP addresses and ports to distinguish.
514    */
515   if ((pcb->so_options & SO_REUSEADDR) != 0) {
516     max_pcb_list = NUM_TCP_PCB_LISTS_NO_TIME_WAIT;
517   }
518 #endif /* SO_REUSE */
519
520   if (port == 0) {
521     port = tcp_new_port();
522   }
523
524   /* Check if the address already is in use (on all lists) */
525   for (i = 0; i < max_pcb_list; i++) {
526     for(cpcb = *tcp_pcb_lists[i]; cpcb != NULL; cpcb = cpcb->next) {
527       if (cpcb->local_port == port) {
528 #if SO_REUSE
529         /* Omit checking for the same port if both pcbs have REUSEADDR set.
530            For SO_REUSEADDR, the duplicate-check for a 5-tuple is done in
531            tcp_connect. */
532         if (((pcb->so_options & SO_REUSEADDR) == 0) ||
533           ((cpcb->so_options & SO_REUSEADDR) == 0))
534 #endif /* SO_REUSE */
535         {
536           if (ip_addr_isany(&(cpcb->local_ip)) ||
537               ip_addr_isany(ipaddr) ||
538               ip_addr_cmp(&(cpcb->local_ip), ipaddr)) {
539             return EADDRINUSE;
540           }
541         }
542       }
543     }
544   }
545
546   if (!ip_addr_isany(ipaddr)) {
547     pcb->local_ip = *ipaddr;
548   }
549   pcb->local_port = port;
550   TCP_REG(&tcp_bound_pcbs, pcb);
551   LWIP_DEBUGF(TCP_DEBUG, ("tcp_bind: bind to port %"U16_F"\n", port));
552   return 0;
553 }
554
555 /**
556  * Is called every TCP_FAST_INTERVAL (250 ms) and process data previously
557  * "refused" by upper layer (application) and sends delayed ACKs.
558  *
559  * Automatically called from tcp_tmr().
560  */
561 void tcp_fasttmr(void) {
562   struct tcp_pcb *pcb = tcp_active_pcbs;
563
564   while(pcb != NULL) {
565     struct tcp_pcb *next = pcb->next;
566     /* If there is data which was previously "refused" by upper layer */
567     if (pcb->refused_data != NULL) {
568       /* Notify again application with data previously received. */
569       error_t err;
570       LWIP_DEBUGF(TCP_INPUT_DEBUG, ("tcp_fasttmr: notify kept packet\n"));
571       TCP_EVENT_RECV(pcb, pcb->refused_data, ESUCCESS, err);
572       if (err == ESUCCESS) {
573         pcb->refused_data = NULL;
574       } else if (err == ECONNABORTED) {
575         /* if err == ECONNABORTED, 'pcb' is already deallocated */
576         pcb = NULL;
577       }
578     }
579
580     /* send delayed ACKs */
581     if (pcb && (pcb->flags & TF_ACK_DELAY)) {
582       printd("tcp_fasttmr: delayed ACK\n");
583       tcp_ack_now(pcb);
584       // XXX: tcp_output(pcb);
585       pcb->flags &= ~(TF_ACK_DELAY | TF_ACK_NOW);
586     }
587
588     pcb = next;
589   }
590 }
591
592 /**
593  * Called periodically to dispatch TCP timers.
594  *
595  */
596 void tcp_tmr(void) {
597         /* Call tcp_fasttmr() every 250 ms */
598   tcp_fasttmr();
599
600   if (++tcp_timer & 1) {
601     /* Call tcp_tmr() every 500 ms, i.e., every other timer
602        tcp_tmr() is called. */
603     tcp_slowtmr();
604   }
605 }
606
607 /**
608  * Closes the TX side of a connection held by the PCB.
609  * For tcp_close(), a RST is sent if the application didn't receive all data
610  * (tcp_recved() not called for all data passed to recv callback).
611  *
612  * Listening pcbs are freed and may not be referenced any more.
613  * Connection pcbs are freed if not yet connected and may not be referenced
614  * any more. If a connection is established (at least SYN received or in
615  * a closing state), the connection is closed, and put in a closing state.
616  * The pcb is then automatically freed in tcp_slowtmr(). It is therefore
617  * unsafe to reference it.
618  *
619  * @param pcb the tcp_pcb to close
620  * @return ESUCCESS if connection has been closed
621  *         another error_t if closing failed and pcb is not freed
622  */
623 static error_t
624 tcp_close_shutdown(struct tcp_pcb *pcb, uint8_t rst_on_unacked_data)
625 {
626   error_t err;
627
628   if (rst_on_unacked_data && (pcb->state != LISTEN)) {
629     if ((pcb->refused_data != NULL) || (pcb->rcv_wnd != TCP_WND)) {
630       /* Not all data received by application, send RST to tell the remote
631          side about this. */
632       LWIP_ASSERT("pcb->flags & TF_RXCLOSED", pcb->flags & TF_RXCLOSED);
633
634       /* don't call tcp_abort here: we must not deallocate the pcb since
635          that might not be expected when calling tcp_close */
636       tcp_rst(pcb->snd_nxt, pcb->rcv_nxt, &pcb->local_ip, &pcb->remote_ip,
637         pcb->local_port, pcb->remote_port);
638
639       tcp_pcb_purge(pcb);
640
641       /* TODO: to which state do we move now? */
642
643       /* move to TIME_WAIT since we close actively */
644       TCP_RMV(&tcp_active_pcbs, pcb);
645       pcb->state = TIME_WAIT;
646       TCP_REG(&tcp_tw_pcbs, pcb);
647
648       return ESUCCESS;
649     }
650   }
651
652   switch (pcb->state) {
653   case CLOSED:
654     /* Closing a pcb in the CLOSED state might seem erroneous,
655      * however, it is in this state once allocated and as yet unused
656      * and the user needs some way to free it should the need arise.
657      * Calling tcp_close() with a pcb that has already been closed, (i.e. twice)
658      * or for a pcb that has been used and then entered the CLOSED state 
659      * is erroneous, but this should never happen as the pcb has in those cases
660      * been freed, and so any remaining handles are bogus. */
661     err = ESUCCESS;
662     TCP_RMV(&tcp_bound_pcbs, pcb);
663                 kmem_cache_free(tcp_pcb_kcache, (void*)pcb);
664     pcb = NULL;
665     break;
666   case LISTEN:
667     err = ESUCCESS;
668     tcp_pcb_remove(&tcp_listen_pcbs.pcbs, pcb);
669                 kmem_cache_free(tcp_pcb_kcache, (void*)pcb);
670     pcb = NULL;
671     break;
672   case SYN_SENT:
673     err = ESUCCESS;
674     tcp_pcb_remove(&tcp_active_pcbs, pcb);
675                 kmem_cache_free(tcp_pcb_kcache, (void*)pcb);
676     pcb = NULL;
677     break;
678   case SYN_RCVD:
679     err = tcp_send_fin(pcb);
680     if (err == ESUCCESS) {
681       pcb->state = FIN_WAIT_1;
682     }
683     break;
684   case ESTABLISHED:
685     err = tcp_send_fin(pcb);
686     if (err == ESUCCESS) {
687       pcb->state = FIN_WAIT_1;
688     }
689     break;
690   case CLOSE_WAIT:
691     err = tcp_send_fin(pcb);
692     if (err == ESUCCESS) {
693       pcb->state = LAST_ACK;
694     }
695     break;
696   default:
697     /* Has already been closed, do nothing. */
698     err = ESUCCESS;
699     pcb = NULL;
700     break;
701   }
702
703   if (pcb != NULL && err == ESUCCESS) {
704     /* To ensure all data has been sent when tcp_close returns, we have
705        to make sure tcp_output doesn't fail.
706        Since we don't really have to ensure all data has been sent when tcp_close
707        returns (unsent data is sent from tcp timer functions, also), we don't care
708        for the return value of tcp_output for now. */
709     /* @todo: When implementing SO_LINGER, this must be changed somehow:
710        If SOF_LINGER is set, the data should be sent and acked before close returns.
711        This can only be valid for sequential APIs, not for the raw API. */
712     tcp_output(pcb);
713   }
714   return err;
715 }
716
717 /**
718  * Closes the connection held by the PCB.
719  *
720  * Listening pcbs are freed and may not be referenced any more.
721  * Connection pcbs are freed if not yet connected and may not be referenced
722  * any more. If a connection is established (at least SYN received or in
723  * a closing state), the connection is closed, and put in a closing state.
724  * The pcb is then automatically freed in tcp_slowtmr(). It is therefore
725  * unsafe to reference it (unless an error is returned).
726  *
727  * @param pcb the tcp_pcb to close
728  * @return ESUCCESS if connection has been closed
729  *         another error_t if closing failed and pcb is not freed
730  */
731 error_t
732 tcp_close(struct tcp_pcb *pcb)
733 {
734 #if TCP_DEBUG
735   LWIP_DEBUGF(TCP_DEBUG, ("tcp_close: closing in "));
736   tcp_debug_print_state(pcb->state);
737 #endif /* TCP_DEBUG */
738
739   if (pcb->state != LISTEN) {
740     /* Set a flag not to receive any more data... */
741     pcb->flags |= TF_RXCLOSED;
742   }
743   /* ... and close */
744   return tcp_close_shutdown(pcb, 1);
745 }
746
747 /**
748  * Causes all or part of a full-duplex connection of this PCB to be shut down.
749  * This doesn't deallocate the PCB!
750  *
751  * @param pcb PCB to shutdown
752  * @param shut_rx shut down receive side if this is != 0
753  * @param shut_tx shut down send side if this is != 0
754  * @return ESUCCESS if shutdown succeeded (or the PCB has already been shut down)
755  *         another error_t on error.
756  */
757 error_t
758 tcp_shutdown(struct tcp_pcb *pcb, int shut_rx, int shut_tx)
759 {
760   if (pcb->state == LISTEN) {
761     return ENOTCONN;
762   }
763   if (shut_rx) {
764     /* shut down the receive side: free buffered data... */
765     if (pcb->refused_data != NULL) {
766       pbuf_free(pcb->refused_data);
767       pcb->refused_data = NULL;
768     }
769     /* ... and set a flag not to receive any more data */
770     pcb->flags |= TF_RXCLOSED;
771   }
772   if (shut_tx) {
773     /* This can't happen twice since if it succeeds, the pcb's state is changed.
774        Only close in these states as the others directly deallocate the PCB */
775     switch (pcb->state) {
776   case SYN_RCVD:
777   case ESTABLISHED:
778   case CLOSE_WAIT:
779     return tcp_close_shutdown(pcb, 0);
780   default:
781     /* don't shut down other states */
782     break;
783     }
784   }
785   /* @todo: return another error_t if not in correct state or already shut? */
786   return ESUCCESS;
787 }
788
789 /**
790  * Default accept callback if no accept callback is specified by the user.
791  */
792 static error_t
793 tcp_accept_null(void *arg, struct tcp_pcb *pcb, error_t err)
794 {
795         //XXX: IMPLEMENT ACCEPT
796
797   return ECONNABORTED;
798 }
799
800 /**
801  * Set the state of the connection to be LISTEN, which means that it
802  * is able to accept incoming connections. The protocol control block
803  * is reallocated in order to consume less memory. Setting the
804  * connection to LISTEN is an irreversible process.
805  *
806  * @param pcb the original tcp_pcb
807  * @param backlog the incoming connections queue limit
808  * @return tcp_pcb used for listening, consumes less memory.
809  *
810  * @note The original tcp_pcb is freed. This function therefore has to be
811  *       called like this:
812  *             tpcb = tcp_listen(tpcb);
813  */
814 struct tcp_pcb *
815 tcp_listen_with_backlog(struct tcp_pcb *pcb, uint8_t backlog)
816 {
817   struct tcp_pcb_listen *lpcb;
818
819   LWIP_ERROR("tcp_listen: pcb already connected", pcb->state == CLOSED, return NULL);
820
821   /* already listening? */
822   if (pcb->state == LISTEN) {
823     return pcb;
824   }
825 #if SO_REUSE
826   if ((pcb->so_options & SO_REUSEADDR) != 0) {
827     /* Since SO_REUSEADDR allows reusing a local address before the pcb's usage
828        is declared (listen-/connection-pcb), we have to make sure now that
829        this port is only used once for every local IP. */
830     for(lpcb = tcp_listen_pcbs.listen_pcbs; lpcb != NULL; lpcb = lpcb->next) {
831       if (lpcb->local_port == pcb->local_port) {
832         if (ip_addr_cmp(&lpcb->local_ip, &pcb->local_ip)) {
833           /* this address/port is already used */
834           return NULL;
835         }
836       }
837     }
838   }
839 #endif /* SO_REUSE */
840         lpcb = kmem_cache_alloc(tcp_pcb_listen_kcache, 0);
841   if (lpcb == NULL) {
842     return NULL;
843   }
844   lpcb->callback_arg = pcb->callback_arg;
845   lpcb->local_port = pcb->local_port;
846   lpcb->state = LISTEN;
847   lpcb->prio = pcb->prio;
848   lpcb->so_options = pcb->so_options;
849   lpcb->so_options |= SO_ACCEPTCONN;
850   lpcb->ttl = pcb->ttl;
851   lpcb->tos = pcb->tos;
852   ip_addr_copy(lpcb->local_ip, pcb->local_ip);
853   TCP_RMV(&tcp_bound_pcbs, pcb);
854         kmem_cache_free(tcp_pcb_kcache, (void*)pcb);
855 #if LWIP_CALLBACK_API
856   lpcb->accept = tcp_accept_null;
857 #endif /* LWIP_CALLBACK_API */
858 #if TCP_LISTEN_BACKLOG
859   lpcb->accepts_pending = 0;
860   lpcb->backlog = (backlog ? backlog : 1);
861 #endif /* TCP_LISTEN_BACKLOG */
862   TCP_REG(&tcp_listen_pcbs.pcbs, (struct tcp_pcb *)lpcb);
863   return (struct tcp_pcb *)lpcb;
864 }
865
866
867 /**
868  * Connects to another host. The function given as the "connected"
869  * argument will be called when the connection has been established.
870  *
871  * @param pcb the tcp_pcb used to establish the connection
872  * @param ipaddr the remote ip address to connect to
873  * @param port the remote tcp port to connect to
874  * @param connected callback function to call when connected (or on error)
875  * @return ERR_VAL if invalid arguments are given
876  *         ESUCCESS if connect request has been sent
877  *         other error_t values if connect request couldn't be sent
878  */
879 error_t
880 tcp_connect(struct tcp_pcb *pcb, ip_addr_t *ipaddr, uint16_t port,
881       tcp_connected_fn connected)
882 {
883   error_t ret;
884   uint32_t iss;
885
886   LWIP_ERROR("tcp_connect: can only connected from state CLOSED", pcb->state == CLOSED, return EISCONN);
887
888   LWIP_DEBUGF(TCP_DEBUG, ("tcp_connect to port %"U16_F"\n", port));
889   if (ipaddr != NULL) {
890     pcb->remote_ip = *ipaddr;
891   } else {
892     return ENETUNREACH;
893   }
894   pcb->remote_port = port;
895
896   /* check if we have a route to the remote host */
897   if (ip_addr_isany(&(pcb->local_ip))) {
898                 // assume we have a route anywhere..
899
900     /* no local IP address set, yet. */
901     // struct netif *netif = ip_route(&(pcb->remote_ip));
902     /* Use the netif's IP address as local address. */
903                 pcb->local_ip = LOCAL_IP_ADDR;
904   }
905
906   if (pcb->local_port == 0) {
907     pcb->local_port = tcp_new_port();
908   }
909 #if SO_REUSE
910   if ((pcb->so_options & SO_REUSEADDR) != 0) {
911     /* Since SO_REUSEADDR allows reusing a local address, we have to make sure
912        now that the 5-tuple is unique. */
913     struct tcp_pcb *cpcb;
914     int i;
915     /* Don't check listen- and bound-PCBs, check active- and TIME-WAIT PCBs. */
916     for (i = 2; i < NUM_TCP_PCB_LISTS; i++) {
917       for(cpcb = *tcp_pcb_lists[i]; cpcb != NULL; cpcb = cpcb->next) {
918         if ((cpcb->local_port == pcb->local_port) &&
919             (cpcb->remote_port == port) &&
920             ip_addr_cmp(&cpcb->local_ip, &pcb->local_ip) &&
921             ip_addr_cmp(&cpcb->remote_ip, ipaddr)) {
922           /* linux returns EISCONN here, but ERR_USE should be OK for us */
923           return ERR_USE;
924         }
925       }
926     }
927   }
928 #endif /* SO_REUSE */
929   iss = tcp_next_iss();
930   pcb->rcv_nxt = 0;
931   pcb->snd_nxt = iss;
932   pcb->lastack = iss - 1;
933   pcb->snd_lbb = iss - 1;
934   pcb->rcv_wnd = TCP_WND;
935   pcb->rcv_ann_wnd = TCP_WND;
936   pcb->rcv_ann_right_edge = pcb->rcv_nxt;
937   pcb->snd_wnd = TCP_WND;
938   /* As initial send MSS, we use TCP_MSS but limit it to 536.
939      The send MSS is updated when an MSS option is received. */
940   pcb->mss = (TCP_MSS > 536) ? 536 : TCP_MSS;
941 #if TCP_CALCULATE_EFF_SEND_MSS
942   pcb->mss = tcp_eff_send_mss(pcb->mss, ipaddr);
943 #endif /* TCP_CALCULATE_EFF_SEND_MSS */
944   pcb->cwnd = 1;
945   pcb->ssthresh = pcb->mss * 10;
946 #if LWIP_CALLBACK_API
947   pcb->connected = connected;
948 #else /* LWIP_CALLBACK_API */  
949   LWIP_UNUSED_ARG(connected);
950 #endif /* LWIP_CALLBACK_API */
951
952   /* Send a SYN together with the MSS option. */
953   ret = tcp_enqueue_flags(pcb, TCP_SYN);
954   if (ret == ESUCCESS) {
955     /* SYN segment was enqueued, changed the pcbs state now */
956     pcb->state = SYN_SENT;
957     TCP_RMV(&tcp_bound_pcbs, pcb);
958     TCP_REG(&tcp_active_pcbs, pcb);
959     //snmp_inc_tcpactiveopens();
960
961     tcp_output(pcb);
962   }
963   return ret;
964 }
965
966 /**
967  * Called every 500 ms and implements the retransmission timer and the timer that
968  * removes PCBs that have been in TIME-WAIT for enough time. It also increments
969  * various timers such as the inactivity timer in each PCB.
970  *
971  * Automatically called from tcp_tmr().
972  */
973 void
974 tcp_slowtmr(void)
975 {
976   struct tcp_pcb *pcb, *prev;
977   uint16_t eff_wnd;
978   uint8_t pcb_remove;      /* flag if a PCB should be removed */
979   uint8_t pcb_reset;       /* flag if a RST should be sent when removing */
980   error_t err;
981
982   err = ESUCCESS;
983
984   ++tcp_ticks;
985
986   /* Steps through all of the active PCBs. */
987   prev = NULL;
988   pcb = tcp_active_pcbs;
989   if (pcb == NULL) {
990     LWIP_DEBUGF(TCP_DEBUG, ("tcp_slowtmr: no active pcbs\n"));
991   }
992   while (pcb != NULL) {
993     LWIP_DEBUGF(TCP_DEBUG, ("tcp_slowtmr: processing active pcb\n"));
994     LWIP_ASSERT("tcp_slowtmr: active pcb->state != CLOSED\n", pcb->state != CLOSED);
995     LWIP_ASSERT("tcp_slowtmr: active pcb->state != LISTEN\n", pcb->state != LISTEN);
996     LWIP_ASSERT("tcp_slowtmr: active pcb->state != TIME-WAIT\n", pcb->state != TIME_WAIT);
997
998     pcb_remove = 0;
999     pcb_reset = 0;
1000
1001     if (pcb->state == SYN_SENT && pcb->nrtx == TCP_SYNMAXRTX) {
1002       ++pcb_remove;
1003       LWIP_DEBUGF(TCP_DEBUG, ("tcp_slowtmr: max SYN retries reached\n"));
1004     }
1005     else if (pcb->nrtx == TCP_MAXRTX) {
1006       ++pcb_remove;
1007       LWIP_DEBUGF(TCP_DEBUG, ("tcp_slowtmr: max DATA retries reached\n"));
1008     } else {
1009       if (pcb->persist_backoff > 0) {
1010         /* If snd_wnd is zero, use persist timer to send 1 byte probes
1011          * instead of using the standard retransmission mechanism. */
1012         pcb->persist_cnt++;
1013         if (pcb->persist_cnt >= tcp_persist_backoff[pcb->persist_backoff-1]) {
1014           pcb->persist_cnt = 0;
1015           if (pcb->persist_backoff < sizeof(tcp_persist_backoff)) {
1016             pcb->persist_backoff++;
1017           }
1018           tcp_zero_window_probe(pcb);
1019         }
1020       } else {
1021         /* Increase the retransmission timer if it is running */
1022         if(pcb->rtime >= 0)
1023           ++pcb->rtime;
1024
1025         if (pcb->unacked != NULL && pcb->rtime >= pcb->rto) {
1026           /* Time for a retransmission. */
1027           LWIP_DEBUGF(TCP_RTO_DEBUG, ("tcp_slowtmr: rtime %"S16_F
1028                                       " pcb->rto %"S16_F"\n",
1029                                       pcb->rtime, pcb->rto));
1030
1031           /* Double retransmission time-out unless we are trying to
1032            * connect to somebody (i.e., we are in SYN_SENT). */
1033           if (pcb->state != SYN_SENT) {
1034             pcb->rto = ((pcb->sa >> 3) + pcb->sv) << tcp_backoff[pcb->nrtx];
1035           }
1036
1037           /* Reset the retransmission timer. */
1038           pcb->rtime = 0;
1039
1040           /* Reduce congestion window and ssthresh. */
1041           eff_wnd = MIN(pcb->cwnd, pcb->snd_wnd);
1042           pcb->ssthresh = eff_wnd >> 1;
1043           if (pcb->ssthresh < (pcb->mss << 1)) {
1044             pcb->ssthresh = (pcb->mss << 1);
1045           }
1046           pcb->cwnd = pcb->mss;
1047           LWIP_DEBUGF(TCP_CWND_DEBUG, ("tcp_slowtmr: cwnd %"U16_F
1048                                        " ssthresh %"U16_F"\n",
1049                                        pcb->cwnd, pcb->ssthresh));
1050  
1051           /* The following needs to be called AFTER cwnd is set to one
1052              mss - STJ */
1053           tcp_rexmit_rto(pcb);
1054         }
1055       }
1056     }
1057     /* Check if this PCB has stayed too long in FIN-WAIT-2 */
1058     if (pcb->state == FIN_WAIT_2) {
1059       if ((uint32_t)(tcp_ticks - pcb->tmr) >
1060           TCP_FIN_WAIT_TIMEOUT / TCP_SLOW_INTERVAL) {
1061         ++pcb_remove;
1062         LWIP_DEBUGF(TCP_DEBUG, ("tcp_slowtmr: removing pcb stuck in FIN-WAIT-2\n"));
1063       }
1064     }
1065
1066     /* Check if KEEPALIVE should be sent */
1067     if((pcb->so_options & SO_KEEPALIVE) &&
1068        ((pcb->state == ESTABLISHED) ||
1069         (pcb->state == CLOSE_WAIT))) {
1070 #if LWIP_TCP_KEEPALIVE
1071       if((uint32_t)(tcp_ticks - pcb->tmr) >
1072          (pcb->keep_idle + (pcb->keep_cnt*pcb->keep_intvl))
1073          / TCP_SLOW_INTERVAL)
1074 #else      
1075       if((uint32_t)(tcp_ticks - pcb->tmr) >
1076          (pcb->keep_idle + TCP_MAXIDLE) / TCP_SLOW_INTERVAL)
1077 #endif /* LWIP_TCP_KEEPALIVE */
1078       {
1079         LWIP_DEBUGF(TCP_DEBUG, ("tcp_slowtmr: KEEPALIVE timeout. Aborting connection to %"U16_F".%"U16_F".%"U16_F".%"U16_F".\n",
1080                                 ip4_addr1_16(&pcb->remote_ip), ip4_addr2_16(&pcb->remote_ip),
1081                                 ip4_addr3_16(&pcb->remote_ip), ip4_addr4_16(&pcb->remote_ip)));
1082         
1083         ++pcb_remove;
1084         ++pcb_reset;
1085       }
1086 #if LWIP_TCP_KEEPALIVE
1087       else if((uint32_t)(tcp_ticks - pcb->tmr) > 
1088               (pcb->keep_idle + pcb->keep_cnt_sent * pcb->keep_intvl)
1089               / TCP_SLOW_INTERVAL)
1090 #else
1091       else if((uint32_t)(tcp_ticks - pcb->tmr) > 
1092               (pcb->keep_idle + pcb->keep_cnt_sent * TCP_KEEPINTVL_DEFAULT) 
1093               / TCP_SLOW_INTERVAL)
1094 #endif /* LWIP_TCP_KEEPALIVE */
1095       {
1096         tcp_keepalive(pcb);
1097         pcb->keep_cnt_sent++;
1098       }
1099     }
1100
1101     /* If this PCB has queued out of sequence data, but has been
1102        inactive for too long, will drop the data (it will eventually
1103        be retransmitted). */
1104 #if TCP_QUEUE_OOSEQ
1105     if (pcb->ooseq != NULL &&
1106         (uint32_t)tcp_ticks - pcb->tmr >= pcb->rto * TCP_OOSEQ_TIMEOUT) {
1107       tcp_segs_free(pcb->ooseq);
1108       pcb->ooseq = NULL;
1109       LWIP_DEBUGF(TCP_CWND_DEBUG, ("tcp_slowtmr: dropping OOSEQ queued data\n"));
1110     }
1111 #endif /* TCP_QUEUE_OOSEQ */
1112
1113     /* Check if this PCB has stayed too long in SYN-RCVD */
1114     if (pcb->state == SYN_RCVD) {
1115       if ((uint32_t)(tcp_ticks - pcb->tmr) >
1116           TCP_SYN_RCVD_TIMEOUT / TCP_SLOW_INTERVAL) {
1117         ++pcb_remove;
1118         LWIP_DEBUGF(TCP_DEBUG, ("tcp_slowtmr: removing pcb stuck in SYN-RCVD\n"));
1119       }
1120     }
1121
1122     /* Check if this PCB has stayed too long in LAST-ACK */
1123     if (pcb->state == LAST_ACK) {
1124       if ((uint32_t)(tcp_ticks - pcb->tmr) > 2 * TCP_MSL / TCP_SLOW_INTERVAL) {
1125         ++pcb_remove;
1126         LWIP_DEBUGF(TCP_DEBUG, ("tcp_slowtmr: removing pcb stuck in LAST-ACK\n"));
1127       }
1128     }
1129
1130     /* If the PCB should be removed, do it. */
1131     if (pcb_remove) {
1132       struct tcp_pcb *pcb2;
1133       tcp_pcb_purge(pcb);
1134       /* Remove PCB from tcp_active_pcbs list. */
1135       if (prev != NULL) {
1136         LWIP_ASSERT("tcp_slowtmr: middle tcp != tcp_active_pcbs", pcb != tcp_active_pcbs);
1137         prev->next = pcb->next;
1138       } else {
1139         /* This PCB was the first. */
1140         LWIP_ASSERT("tcp_slowtmr: first pcb == tcp_active_pcbs", tcp_active_pcbs == pcb);
1141         tcp_active_pcbs = pcb->next;
1142       }
1143
1144       TCP_EVENT_ERR(pcb->errf, pcb->callback_arg, ECONNABORTED);
1145       if (pcb_reset) {
1146         tcp_rst(pcb->snd_nxt, pcb->rcv_nxt, &pcb->local_ip, &pcb->remote_ip,
1147           pcb->local_port, pcb->remote_port);
1148       }
1149
1150       pcb2 = pcb;
1151       pcb = pcb->next;
1152                         kmem_cache_free(tcp_pcb_kcache, (void*)pcb2);
1153     } else {
1154       /* get the 'next' element now and work with 'prev' below (in case of abort) */
1155       prev = pcb;
1156       pcb = pcb->next;
1157
1158       /* We check if we should poll the connection. */
1159       ++prev->polltmr;
1160       if (prev->polltmr >= prev->pollinterval) {
1161         prev->polltmr = 0;
1162         LWIP_DEBUGF(TCP_DEBUG, ("tcp_slowtmr: polling application\n"));
1163         TCP_EVENT_POLL(prev, err);
1164         /* if err == ECONNABORTED, 'prev' is already deallocated */
1165         if (err == ESUCCESS) {
1166           tcp_output(prev);
1167         }
1168       }
1169     }
1170   }
1171
1172   
1173   /* Steps through all of the TIME-WAIT PCBs. */
1174   prev = NULL;
1175   pcb = tcp_tw_pcbs;
1176   while (pcb != NULL) {
1177     LWIP_ASSERT("tcp_slowtmr: TIME-WAIT pcb->state == TIME-WAIT", pcb->state == TIME_WAIT);
1178     pcb_remove = 0;
1179
1180     /* Check if this PCB has stayed long enough in TIME-WAIT */
1181     if ((uint32_t)(tcp_ticks - pcb->tmr) > 2 * TCP_MSL / TCP_SLOW_INTERVAL) {
1182       ++pcb_remove;
1183     }
1184     
1185
1186
1187     /* If the PCB should be removed, do it. */
1188     if (pcb_remove) {
1189       struct tcp_pcb *pcb2;
1190       tcp_pcb_purge(pcb);
1191       /* Remove PCB from tcp_tw_pcbs list. */
1192       if (prev != NULL) {
1193         LWIP_ASSERT("tcp_slowtmr: middle tcp != tcp_tw_pcbs", pcb != tcp_tw_pcbs);
1194         prev->next = pcb->next;
1195       } else {
1196         /* This PCB was the first. */
1197         LWIP_ASSERT("tcp_slowtmr: first pcb == tcp_tw_pcbs", tcp_tw_pcbs == pcb);
1198         tcp_tw_pcbs = pcb->next;
1199       }
1200       pcb2 = pcb;
1201       pcb = pcb->next;
1202                         kmem_cache_free(tcp_pcb_kcache, (void*)pcb2);
1203     } else {
1204       prev = pcb;
1205       pcb = pcb->next;
1206     }
1207   }
1208 }
1209
1210
1211 /**
1212  * Deallocates a list of TCP segments (tcp_seg structures).
1213  *
1214  * @param seg tcp_seg list of TCP segments to free
1215  */
1216 void
1217 tcp_segs_free(struct tcp_seg *seg)
1218 {
1219   while (seg != NULL) {
1220     struct tcp_seg *next = seg->next;
1221     tcp_seg_free(seg);
1222     seg = next;
1223   }
1224 }
1225
1226 /**
1227  * Frees a TCP segment (tcp_seg structure).
1228  *
1229  * @param seg single tcp_seg to free
1230  */
1231 void
1232 tcp_seg_free(struct tcp_seg *seg)
1233 {
1234   if (seg != NULL) {
1235     if (seg->p != NULL) {
1236       pbuf_free(seg->p);
1237 #if TCP_DEBUG
1238       seg->p = NULL;
1239 #endif /* TCP_DEBUG */
1240     }
1241                 kmem_cache_free(tcp_segment_kcache, seg);
1242   }
1243 }
1244
1245 /**
1246  * Sets the priority of a connection.
1247  *
1248  * @param pcb the tcp_pcb to manipulate
1249  * @param prio new priority
1250  */
1251 void
1252 tcp_setprio(struct tcp_pcb *pcb, uint8_t prio)
1253 {
1254   pcb->prio = prio;
1255 }
1256
1257 #if TCP_QUEUE_OOSEQ
1258 /**
1259  * Returns a copy of the given TCP segment.
1260  * The pbuf and data are not copied, only the pointers
1261  *
1262  * @param seg the old tcp_seg
1263  * @return a copy of seg
1264  */ 
1265 struct tcp_seg *
1266 tcp_seg_copy(struct tcp_seg *seg)
1267 {
1268   struct tcp_seg *cseg;
1269
1270   cseg = (struct tcp_seg *)kmem_cache_alloc(tcp_segment_kcache, 0);
1271   if (cseg == NULL) {
1272     return NULL;
1273   }
1274   memcpy((uint8_t *)cseg, (const uint8_t *)seg, sizeof(struct tcp_seg)); 
1275   pbuf_ref(cseg->p);
1276   return cseg;
1277 }
1278 #endif /* TCP_QUEUE_OOSEQ */
1279
1280
1281
1282 /**
1283  * Used to specify the argument that should be passed callback
1284  * functions.
1285  *
1286  * @param pcb tcp_pcb to set the callback argument
1287  * @param arg void pointer argument to pass to callback functions
1288  */ 
1289 void
1290 tcp_arg(struct tcp_pcb *pcb, void *arg)
1291 {  
1292   pcb->callback_arg = arg;
1293 }
1294 #if LWIP_CALLBACK_API
1295
1296 /**
1297  * Used to specify the function that should be called when a TCP
1298  * connection receives data.
1299  *
1300  * @param pcb tcp_pcb to set the recv callback
1301  * @param recv callback function to call for this pcb when data is received
1302  */ 
1303 void
1304 tcp_recv(struct tcp_pcb *pcb, tcp_recv_fn recv)
1305 {
1306   pcb->recv = recv;
1307 }
1308
1309 /**
1310  * Used to specify the function that should be called when TCP data
1311  * has been successfully delivered to the remote host.
1312  *
1313  * @param pcb tcp_pcb to set the sent callback
1314  * @param sent callback function to call for this pcb when data is successfully sent
1315  */ 
1316 void
1317 tcp_sent(struct tcp_pcb *pcb, tcp_sent_fn sent)
1318 {
1319   pcb->sent = sent;
1320 }
1321
1322 /**
1323  * Used to specify the function that should be called when a fatal error
1324  * has occured on the connection.
1325  *
1326  * @param pcb tcp_pcb to set the err callback
1327  * @param err callback function to call for this pcb when a fatal error
1328  *        has occured on the connection
1329  */ 
1330 void
1331 tcp_err(struct tcp_pcb *pcb, tcp_err_fn err)
1332 {
1333   pcb->errf = err;
1334 }
1335
1336 /**
1337  * Used for specifying the function that should be called when a
1338  * LISTENing connection has been connected to another host.
1339  *
1340  * @param pcb tcp_pcb to set the accept callback
1341  * @param accept callback function to call for this pcb when LISTENing
1342  *        connection has been connected to another host
1343  */ 
1344 void
1345 tcp_accept(struct tcp_pcb *pcb, tcp_accept_fn accept)
1346 {
1347   pcb->accept = accept;
1348 }
1349 #endif /* LWIP_CALLBACK_API */
1350
1351
1352 /**
1353  * Used to specify the function that should be called periodically
1354  * from TCP. The interval is specified in terms of the TCP coarse
1355  * timer interval, which is called twice a second.
1356  *
1357  */ 
1358 void
1359 tcp_poll(struct tcp_pcb *pcb, tcp_poll_fn poll, uint8_t interval)
1360 {
1361 #if LWIP_CALLBACK_API
1362   pcb->poll = poll;
1363 #else /* LWIP_CALLBACK_API */  
1364   LWIP_UNUSED_ARG(poll);
1365 #endif /* LWIP_CALLBACK_API */  
1366   pcb->pollinterval = interval;
1367 }
1368
1369 /**
1370  * Purges a TCP PCB. Removes any buffered data and frees the buffer memory
1371  * (pcb->ooseq, pcb->unsent and pcb->unacked are freed).
1372  *
1373  * @param pcb tcp_pcb to purge. The pcb itself is not deallocated!
1374  */
1375 void
1376 tcp_pcb_purge(struct tcp_pcb *pcb)
1377 {
1378   if (pcb->state != CLOSED &&
1379      pcb->state != TIME_WAIT &&
1380      pcb->state != LISTEN) {
1381
1382     printd("tcp_pcb_purge\n");
1383
1384 #if TCP_LISTEN_BACKLOG
1385     if (pcb->state == SYN_RCVD) {
1386       /* Need to find the corresponding listen_pcb and decrease its accepts_pending */
1387       struct tcp_pcb_listen *lpcb;
1388       LWIP_ASSERT("tcp_pcb_purge: pcb->state == SYN_RCVD but tcp_listen_pcbs is NULL",
1389         tcp_listen_pcbs.listen_pcbs != NULL);
1390       for (lpcb = tcp_listen_pcbs.listen_pcbs; lpcb != NULL; lpcb = lpcb->next) {
1391         if ((lpcb->local_port == pcb->local_port) &&
1392             (ip_addr_isany(&lpcb->local_ip) ||
1393              ip_addr_cmp(&pcb->local_ip, &lpcb->local_ip))) {
1394             /* port and address of the listen pcb match the timed-out pcb */
1395             LWIP_ASSERT("tcp_pcb_purge: listen pcb does not have accepts pending",
1396               lpcb->accepts_pending > 0);
1397             lpcb->accepts_pending--;
1398             break;
1399           }
1400       }
1401     }
1402 #endif /* TCP_LISTEN_BACKLOG */
1403
1404
1405     if (pcb->refused_data != NULL) {
1406       LWIP_DEBUGF(TCP_DEBUG, ("tcp_pcb_purge: data left on ->refused_data\n"));
1407       pbuf_free(pcb->refused_data);
1408       pcb->refused_data = NULL;
1409     }
1410     if (pcb->unsent != NULL) {
1411       LWIP_DEBUGF(TCP_DEBUG, ("tcp_pcb_purge: not all data sent\n"));
1412     }
1413     if (pcb->unacked != NULL) {
1414       LWIP_DEBUGF(TCP_DEBUG, ("tcp_pcb_purge: data left on ->unacked\n"));
1415     }
1416 #if TCP_QUEUE_OOSEQ
1417     if (pcb->ooseq != NULL) {
1418       LWIP_DEBUGF(TCP_DEBUG, ("tcp_pcb_purge: data left on ->ooseq\n"));
1419     }
1420     tcp_segs_free(pcb->ooseq);
1421     pcb->ooseq = NULL;
1422 #endif /* TCP_QUEUE_OOSEQ */
1423
1424     /* Stop the retransmission timer as it will expect data on unacked
1425        queue if it fires */
1426     pcb->rtime = -1;
1427
1428     tcp_segs_free(pcb->unsent);
1429     tcp_segs_free(pcb->unacked);
1430     pcb->unacked = pcb->unsent = NULL;
1431 #if TCP_OVERSIZE
1432     pcb->unsent_oversize = 0;
1433 #endif /* TCP_OVERSIZE */
1434   }
1435 }
1436
1437 /**
1438  * Purges the PCB and removes it from a PCB list. Any delayed ACKs are sent first.
1439  *
1440  * @param pcblist PCB list to purge.
1441  * @param pcb tcp_pcb to purge. The pcb itself is NOT deallocated!
1442  */
1443 void
1444 tcp_pcb_remove(struct tcp_pcb **pcblist, struct tcp_pcb *pcb)
1445 {
1446   TCP_RMV(pcblist, pcb);
1447
1448   tcp_pcb_purge(pcb);
1449   
1450   /* if there is an outstanding delayed ACKs, send it */
1451   if (pcb->state != TIME_WAIT &&
1452      pcb->state != LISTEN &&
1453      pcb->flags & TF_ACK_DELAY) {
1454     pcb->flags |= TF_ACK_NOW;
1455     tcp_output(pcb);
1456   }
1457
1458   if (pcb->state != LISTEN) {
1459     LWIP_ASSERT("unsent segments leaking", pcb->unsent == NULL);
1460     LWIP_ASSERT("unacked segments leaking", pcb->unacked == NULL);
1461 #if TCP_QUEUE_OOSEQ
1462     LWIP_ASSERT("ooseq segments leaking", pcb->ooseq == NULL);
1463 #endif /* TCP_QUEUE_OOSEQ */
1464   }
1465
1466   pcb->state = CLOSED;
1467
1468   LWIP_ASSERT("tcp_pcb_remove: tcp_pcbs_sane()", tcp_pcbs_sane());
1469 }
1470
1471 #if TCP_CALCULATE_EFF_SEND_MSS
1472 /**
1473  * Calcluates the effective send mss that can be used for a specific IP address
1474  * by using ip_route to determin the netif used to send to the address and
1475  * calculating the minimum of TCP_MSS and that netif's mtu (if set).
1476  */
1477 uint16_t
1478 tcp_eff_send_mss(uint16_t sendmss, ip_addr_t *addr)
1479 {
1480   uint16_t mss_s;
1481   struct netif *outif;
1482
1483   //outif = ip_route(addr);
1484     mss_s = DEFAULT_MTU - IP_HDR_SZ - TCP_HLEN;
1485     /* RFC 1122, chap 4.2.2.6:
1486      * Eff.snd.MSS = min(SendMSS+20, MMS_S) - TCPhdrsize - IPoptionsize
1487      * We correct for TCP options in tcp_write(), and don't support IP options.
1488      */
1489     sendmss = MIN(sendmss, mss_s);
1490   return sendmss;
1491 }
1492 #endif /* TCP_CALCULATE_EFF_SEND_MSS */
1493
1494 const char*
1495 tcp_debug_state_str(enum tcp_state s)
1496 {
1497   return tcp_state_str[s];
1498 }
1499
1500 #if TCP_DEBUG || TCP_INPUT_DEBUG || TCP_OUTPUT_DEBUG
1501 /**
1502  * Print a tcp header for debugging purposes.
1503  *
1504  * @param tcphdr pointer to a struct tcp_hdr
1505  */
1506 void
1507 tcp_debug_print(struct tcp_hdr *tcphdr)
1508 {
1509   LWIP_DEBUGF(TCP_DEBUG, ("TCP header:\n"));
1510   LWIP_DEBUGF(TCP_DEBUG, ("+-------------------------------+\n"));
1511   LWIP_DEBUGF(TCP_DEBUG, ("|    %5"U16_F"      |    %5"U16_F"      | (src port, dest port)\n",
1512          ntohs(tcphdr->src), ntohs(tcphdr->dest)));
1513   LWIP_DEBUGF(TCP_DEBUG, ("+-------------------------------+\n"));
1514   LWIP_DEBUGF(TCP_DEBUG, ("|           %010"U32_F"          | (seq no)\n",
1515           ntohl(tcphdr->seqno)));
1516   LWIP_DEBUGF(TCP_DEBUG, ("+-------------------------------+\n"));
1517   LWIP_DEBUGF(TCP_DEBUG, ("|           %010"U32_F"          | (ack no)\n",
1518          ntohl(tcphdr->ackno)));
1519   LWIP_DEBUGF(TCP_DEBUG, ("+-------------------------------+\n"));
1520   LWIP_DEBUGF(TCP_DEBUG, ("| %2"U16_F" |   |%"U16_F"%"U16_F"%"U16_F"%"U16_F"%"U16_F"%"U16_F"|     %5"U16_F"     | (hdrlen, flags (",
1521        TCPH_HDRLEN(tcphdr),
1522          TCPH_FLAGS(tcphdr) >> 5 & 1,
1523          TCPH_FLAGS(tcphdr) >> 4 & 1,
1524          TCPH_FLAGS(tcphdr) >> 3 & 1,
1525          TCPH_FLAGS(tcphdr) >> 2 & 1,
1526          TCPH_FLAGS(tcphdr) >> 1 & 1,
1527          TCPH_FLAGS(tcphdr) & 1,
1528          ntohs(tcphdr->wnd)));
1529   tcp_debug_print_flags(TCPH_FLAGS(tcphdr));
1530   LWIP_DEBUGF(TCP_DEBUG, ("), win)\n"));
1531   LWIP_DEBUGF(TCP_DEBUG, ("+-------------------------------+\n"));
1532   LWIP_DEBUGF(TCP_DEBUG, ("|    0x%04"X16_F"     |     %5"U16_F"     | (chksum, urgp)\n",
1533          ntohs(tcphdr->chksum), ntohs(tcphdr->urgp)));
1534   LWIP_DEBUGF(TCP_DEBUG, ("+-------------------------------+\n"));
1535 }
1536
1537 /**
1538  * Print a tcp state for debugging purposes.
1539  *
1540  * @param s enum tcp_state to print
1541  */
1542 void
1543 tcp_debug_print_state(enum tcp_state s)
1544 {
1545   LWIP_DEBUGF(TCP_DEBUG, ("State: %s\n", tcp_state_str[s]));
1546 }
1547
1548 /**
1549  * Print tcp flags for debugging purposes.
1550  *
1551  * @param flags tcp flags, all active flags are printed
1552  */
1553 void
1554 tcp_debug_print_flags(uint8_t flags)
1555 {
1556   if (flags & TCP_FIN) {
1557     LWIP_DEBUGF(TCP_DEBUG, ("FIN "));
1558   }
1559   if (flags & TCP_SYN) {
1560     LWIP_DEBUGF(TCP_DEBUG, ("SYN "));
1561   }
1562   if (flags & TCP_RST) {
1563     LWIP_DEBUGF(TCP_DEBUG, ("RST "));
1564   }
1565   if (flags & TCP_PSH) {
1566     LWIP_DEBUGF(TCP_DEBUG, ("PSH "));
1567   }
1568   if (flags & TCP_ACK) {
1569     LWIP_DEBUGF(TCP_DEBUG, ("ACK "));
1570   }
1571   if (flags & TCP_URG) {
1572     LWIP_DEBUGF(TCP_DEBUG, ("URG "));
1573   }
1574   if (flags & TCP_ECE) {
1575     LWIP_DEBUGF(TCP_DEBUG, ("ECE "));
1576   }
1577   if (flags & TCP_CWR) {
1578     LWIP_DEBUGF(TCP_DEBUG, ("CWR "));
1579   }
1580   LWIP_DEBUGF(TCP_DEBUG, ("\n"));
1581 }
1582
1583 /**
1584  * Print all tcp_pcbs in every list for debugging purposes.
1585  */
1586 void
1587 tcp_debug_print_pcbs(void)
1588 {
1589   struct tcp_pcb *pcb;
1590   LWIP_DEBUGF(TCP_DEBUG, ("Active PCB states:\n"));
1591   for(pcb = tcp_active_pcbs; pcb != NULL; pcb = pcb->next) {
1592     LWIP_DEBUGF(TCP_DEBUG, ("Local port %"U16_F", foreign port %"U16_F" snd_nxt %"U32_F" rcv_nxt %"U32_F" ",
1593                        pcb->local_port, pcb->remote_port,
1594                        pcb->snd_nxt, pcb->rcv_nxt));
1595     tcp_debug_print_state(pcb->state);
1596   }    
1597   LWIP_DEBUGF(TCP_DEBUG, ("Listen PCB states:\n"));
1598   for(pcb = (struct tcp_pcb *)tcp_listen_pcbs.pcbs; pcb != NULL; pcb = pcb->next) {
1599     LWIP_DEBUGF(TCP_DEBUG, ("Local port %"U16_F", foreign port %"U16_F" snd_nxt %"U32_F" rcv_nxt %"U32_F" ",
1600                        pcb->local_port, pcb->remote_port,
1601                        pcb->snd_nxt, pcb->rcv_nxt));
1602     tcp_debug_print_state(pcb->state);
1603   }    
1604   LWIP_DEBUGF(TCP_DEBUG, ("TIME-WAIT PCB states:\n"));
1605   for(pcb = tcp_tw_pcbs; pcb != NULL; pcb = pcb->next) {
1606     LWIP_DEBUGF(TCP_DEBUG, ("Local port %"U16_F", foreign port %"U16_F" snd_nxt %"U32_F" rcv_nxt %"U32_F" ",
1607                        pcb->local_port, pcb->remote_port,
1608                        pcb->snd_nxt, pcb->rcv_nxt));
1609     tcp_debug_print_state(pcb->state);
1610   }    
1611 }
1612
1613 /**
1614  * Check state consistency of the tcp_pcb lists.
1615  */
1616 s16_t tcp_pcbs_sane(void)
1617 {
1618   struct tcp_pcb *pcb;
1619   for(pcb = tcp_active_pcbs; pcb != NULL; pcb = pcb->next) {
1620     LWIP_ASSERT("tcp_pcbs_sane: active pcb->state != CLOSED", pcb->state != CLOSED);
1621     LWIP_ASSERT("tcp_pcbs_sane: active pcb->state != LISTEN", pcb->state != LISTEN);
1622     LWIP_ASSERT("tcp_pcbs_sane: active pcb->state != TIME-WAIT", pcb->state != TIME_WAIT);
1623   }
1624   for(pcb = tcp_tw_pcbs; pcb != NULL; pcb = pcb->next) {
1625     LWIP_ASSERT("tcp_pcbs_sane: tw pcb->state == TIME-WAIT", pcb->state == TIME_WAIT);
1626   }
1627   return 1;
1628 }
1629 #endif /* TCP_DEBUG */