Correct some packet ownership and freeing bugs.
[people/xl0/gpxe.git] / src / net / tcp.c
1 #include <string.h>
2 #include <stdlib.h>
3 #include <assert.h>
4 #include <byteswap.h>
5 #include <latch.h>
6 #include <errno.h>
7 #include <gpxe/process.h>
8 #include <gpxe/init.h>
9 #include <gpxe/netdevice.h>
10 #include <gpxe/pkbuff.h>
11 #include <gpxe/ip.h>
12 #include <gpxe/tcp.h>
13 #include <gpxe/tcpip.h>
14 #include <gpxe/retry.h>
15 #include "uip/uip.h"
16
17 /** @file
18  *
19  * TCP protocol
20  *
21  * The gPXE TCP stack is currently implemented on top of the uIP
22  * protocol stack.  This file provides wrappers around uIP so that
23  * higher-level protocol implementations do not need to talk directly
24  * to uIP (which has a somewhat baroque API).
25  *
26  * Basic operation is to create a #tcp_connection structure, call
27  * tcp_connect() and then call run_tcpip() in a loop until the
28  * operation has completed.  The TCP stack will call the various
29  * methods defined in the #tcp_operations structure in order to send
30  * and receive data.
31  *
32  * See hello.c for a trivial example of a TCP protocol using this
33  * API.
34  *
35  */
36
37 #if USE_UIP
38
39 /**
40  * TCP transmit buffer
41  *
42  * When a tcp_operations::senddata() method is called, it is
43  * guaranteed to be able to use this buffer as temporary space for
44  * constructing the data to be sent.  For example, code such as
45  *
46  * @code
47  *
48  *     static void my_senddata ( struct tcp_connection *conn, void *buf,
49  *                               size_t len ) {
50  *         len = snprintf ( buf, len, "FETCH %s\r\n", filename );
51  *         tcp_send ( conn, buf + already_sent, len - already_sent );
52  *     }
53  *
54  * @endcode
55  *
56  * is allowed, and is probably the best way to deal with
57  * variably-sized data.
58  *
59  * Note that you cannot use this simple mechanism if you want to be
60  * able to construct single data blocks of more than #len bytes.
61  */
62 static void *tcp_buffer = uip_buf + ( 40 + UIP_LLH_LEN );
63
64 /** Size of #tcp_buffer */
65 static size_t tcp_buflen = UIP_BUFSIZE - ( 40 + UIP_LLH_LEN );
66
67 /**
68  * Open a TCP connection
69  *
70  * @v conn      TCP connection
71  * 
72  * This sets up a new TCP connection to the remote host specified in
73  * tcp_connection::sin.
74  */
75 void tcp_connect ( struct tcp_connection *conn ) {
76         struct uip_conn *uip_conn;
77         u16_t ipaddr[2];
78
79         assert ( conn->sin.sin_addr.s_addr != 0 );
80         assert ( conn->sin.sin_port != 0 );
81         assert ( conn->tcp_op != NULL );
82         assert ( sizeof ( uip_conn->appstate ) == sizeof ( conn ) );
83
84         * ( ( uint32_t * ) ipaddr ) = conn->sin.sin_addr.s_addr;
85         uip_conn = uip_connect ( ipaddr, conn->sin.sin_port );
86 #warning "Use linked lists so that uip_connect() cannot fail"
87         assert ( uip_conn != NULL );
88         *( ( void ** ) uip_conn->appstate ) = conn;
89 }
90
91 /**
92  * Send data via a TCP connection
93  *
94  * @v conn      TCP connection
95  * @v data      Data to send
96  * @v len       Length of data
97  *
98  * Data will be automatically limited to the current TCP window size.
99  *
100  * If retransmission is required, the connection's
101  * tcp_operations::senddata() method will be called again in order to
102  * regenerate the data.
103  */
104 void tcp_send ( struct tcp_connection *conn __unused,
105                 const void *data, size_t len ) {
106
107         assert ( conn = *( ( void ** ) uip_conn->appstate ) );
108
109         if ( len > tcp_buflen )
110                 len = tcp_buflen;
111         memmove ( tcp_buffer, data, len );
112
113         uip_send ( tcp_buffer, len );
114 }
115
116 /**
117  * Close a TCP connection
118  *
119  * @v conn      TCP connection
120  */
121 void tcp_close ( struct tcp_connection *conn __unused ) {
122         assert ( conn = *( ( void ** ) uip_conn->appstate ) );
123         uip_close();
124 }
125
126 /**
127  * uIP TCP application call interface
128  *
129  * This is the entry point of gPXE from the point of view of the uIP
130  * protocol stack.  This function calls the appropriate methods from
131  * the connection's @tcp_operations table in order to process received
132  * data, transmit new data etc.
133  */
134 void uip_tcp_appcall ( void ) {
135         struct tcp_connection *conn = *( ( void ** ) uip_conn->appstate );
136         struct tcp_operations *op = conn->tcp_op;
137
138         if ( op->closed ) {
139                 if ( uip_aborted() )
140                         op->closed ( conn, -ECONNABORTED );
141                 if ( uip_timedout() )
142                         op->closed ( conn, -ETIMEDOUT );
143                 if ( uip_closed() )
144                         op->closed ( conn, 0 );
145         }
146         if ( uip_connected() && op->connected )
147                 op->connected ( conn );
148         if ( uip_acked() && op->acked )
149                 op->acked ( conn, uip_conn->len );
150         if ( uip_newdata() && op->newdata )
151                 op->newdata ( conn, ( void * ) uip_appdata, uip_len );
152         if ( ( uip_rexmit() || uip_newdata() || uip_acked() ||
153                uip_connected() || uip_poll() ) && op->senddata )
154                 op->senddata ( conn, tcp_buffer, tcp_buflen );
155 }
156
157 /* Present here to allow everything to link.  Will go into separate
158  * udp.c file
159  */
160 void uip_udp_appcall ( void ) {
161 }
162
163 /**
164  * Perform periodic processing of all TCP connections
165  *
166  * This allows TCP connections to retransmit data if necessary.
167  */
168 static void tcp_periodic ( void ) {
169         struct pk_buff *pkb;
170         int i;
171
172         for ( i = 0 ; i < UIP_CONNS ; i++ ) {
173                 uip_periodic ( i );
174                 if ( uip_len > 0 ) {
175                         pkb = alloc_pkb ( uip_len + MAX_LL_HEADER_LEN);
176                         if ( ! pkb )
177                                 continue;
178                                 
179                         pkb_reserve ( pkb, MAX_LL_HEADER_LEN );
180                         pkb_put ( pkb, uip_len );
181                         memcpy ( pkb->data, uip_buf, uip_len );
182
183                         ipv4_uip_tx ( pkb );
184                 }
185         }
186 }
187
188 /**
189  * Kick a connection into life
190  *
191  * @v conn      TCP connection
192  *
193  * Call this function when you have new data to send and are not
194  * already being called as part of TCP processing.
195  */
196 void tcp_kick ( struct tcp_connection *conn __unused ) {
197         /* Just kick all the connections; this will work for now */
198         tcp_periodic();
199 }
200
201 /**
202  * Single-step the TCP stack
203  *
204  * @v process   TCP process
205  *
206  * This calls tcp_periodic() at regular intervals.
207  */
208 static void tcp_step ( struct process *process ) {
209         static unsigned long timeout = 0;
210
211         if ( currticks() > timeout ) {
212                 timeout = currticks() + ( TICKS_PER_SEC / 10 );
213                 tcp_periodic ();
214         }
215
216         schedule ( process );
217 }
218
219 /** TCP stack process */
220 static struct process tcp_process = {
221         .step = tcp_step,
222 };
223
224 /** Initialise the TCP stack */
225 static void init_tcp ( void ) {
226         schedule ( &tcp_process );
227 }
228
229 INIT_FN ( INIT_PROCESS, init_tcp, NULL, NULL );
230
231 #else
232
233 /**
234  * List of registered TCP connections
235  */
236 static LIST_HEAD ( tcp_conns );
237
238 /**
239  * List of TCP states
240  */
241 static const char *tcp_states[] = {
242         "CLOSED",
243         "LISTEN",
244         "SYN_SENT",
245         "SYN_RCVD",
246         "ESTABLISHED",
247         "FIN_WAIT_1",
248         "FIN_WAIT_2",
249         "CLOSING",
250         "TIME_WAIT",
251         "CLOSE_WAIT",
252         "LAST_ACK",
253         "INVALID" };
254
255 /**
256  * TCP state transition function
257  *
258  * @v conn      TCP connection
259  * @v nxt_state Next TCP state
260  */
261 void tcp_set_flags ( struct tcp_connection *conn ) {
262
263         /* Set the TCP flags */
264         switch ( conn->tcp_state ) {
265         case TCP_CLOSED:
266                 if ( conn->tcp_lstate == TCP_SYN_RCVD ) {
267                         conn->tcp_flags |= TCP_RST;
268                 }
269                 break;
270         case TCP_LISTEN:
271                 break;
272         case TCP_SYN_SENT:
273                 if ( conn->tcp_lstate == TCP_LISTEN ||
274                      conn->tcp_lstate == TCP_CLOSED ) {
275                         conn->tcp_flags |= TCP_SYN;
276                 }
277                 break;
278         case TCP_SYN_RCVD:
279                 if ( conn->tcp_lstate == TCP_LISTEN ||
280                      conn->tcp_lstate == TCP_SYN_SENT ) {
281                         conn->tcp_flags |= ( TCP_SYN | TCP_ACK );
282                 }
283                 break;
284         case TCP_ESTABLISHED:
285                 if ( conn->tcp_lstate == TCP_SYN_SENT ) {
286                         conn->tcp_flags |= TCP_ACK;
287                 }
288                 break;
289         case TCP_FIN_WAIT_1:
290                 if ( conn->tcp_lstate == TCP_SYN_RCVD ||
291                      conn->tcp_lstate == TCP_ESTABLISHED ) {
292                         conn->tcp_flags |= TCP_FIN;
293                 }
294                 break;
295         case TCP_FIN_WAIT_2:
296                 break;
297         case TCP_CLOSING:
298                 if ( conn->tcp_lstate == TCP_FIN_WAIT_1 ) {
299                         conn->tcp_flags |= TCP_ACK;
300                 }
301                 break;
302         case TCP_TIME_WAIT:
303                 if ( conn->tcp_lstate == TCP_FIN_WAIT_1 ||
304                      conn->tcp_lstate == TCP_FIN_WAIT_2 ) {
305                         conn->tcp_flags |= TCP_ACK;
306                 }
307                 break;
308         case TCP_CLOSE_WAIT:
309                 if ( conn->tcp_lstate == TCP_ESTABLISHED ) {
310                         conn->tcp_flags |= TCP_ACK;
311                 }
312                 break;
313         case TCP_LAST_ACK:
314                 if ( conn->tcp_lstate == TCP_CLOSE_WAIT ) {
315                         conn->tcp_flags |= TCP_FIN;
316                 }
317                 break;
318         default:
319                 DBG ( "TCP_INVALID state %d\n", conn->tcp_state );
320                 return;
321         }
322 }
323
324 void tcp_trans ( struct tcp_connection *conn, int nxt_state ) {
325         /* Remember the last state */
326         conn->tcp_lstate = conn->tcp_state;
327         conn->tcp_state = nxt_state;
328
329         /* TODO: Check if this check is required */
330         if ( conn->tcp_lstate == conn->tcp_state || 
331              conn->tcp_state == TCP_INVALID ) {
332                 conn->tcp_flags = 0;
333                 return;
334         }
335         tcp_set_flags ( conn );
336 }
337
338 /**
339  * Dump TCP header
340  *
341  * @v tcphdr    TCP header
342  */
343 void tcp_dump ( struct tcp_header *tcphdr ) {
344         DBG ( "TCP %p src:%d dest:%d seq:%lx ack:%lx hlen:%hd flags:%#hx\n",
345                 tcphdr, ntohs ( tcphdr->src ), ntohs ( tcphdr->dest ), ntohl ( tcphdr->seq ),
346                 ntohl ( tcphdr->ack ), ( ( tcphdr->hlen & TCP_MASK_HLEN ) / 16 ), ( tcphdr->flags & TCP_MASK_FLAGS ) );
347 }
348
349 /**
350  * Initialize a TCP connection
351  *
352  * @v conn      TCP connection
353  *
354  * This function assigns initial values to some fields in the connection
355  * structure. The application should call tcp_init_conn after creating a new
356  * connection before calling any other "tcp_*" function.
357  *
358  * struct tcp_connection my_conn;
359  * tcp_init_conn ( &my_conn );
360  * ... 
361  */
362 void tcp_init_conn ( struct tcp_connection *conn ) {
363         conn->local_port = 0;
364         conn->tcp_state = TCP_CLOSED;
365         conn->tcp_lstate = TCP_INVALID;
366         conn->tx_pkb = NULL;
367         conn->tcp_op = NULL;
368 }
369
370 /** Retry timer
371  *
372  * @v timer     Retry timer
373  * @v over      Failure indicator
374  */
375 void tcp_expired ( struct retry_timer *timer, int over ) {
376         struct tcp_connection *conn;
377         conn = ( struct tcp_connection * ) container_of ( timer, 
378                                         struct tcp_connection, timer );
379         DBG ( "Timer expired in %s\n", tcp_states[conn->tcp_state] );
380         switch ( conn->tcp_state ) {
381         case TCP_SYN_SENT:
382                 if ( over ) {
383                         tcp_trans ( conn, TCP_CLOSED );
384                         stop_timer ( &conn->timer );
385                         DBG ( "Timeout! Connection closed\n" );
386                         return;
387                 }
388                 goto send_tcp_nomsg;
389         case TCP_SYN_RCVD:
390                 if ( over ) {
391                         tcp_trans ( conn, TCP_CLOSED );
392                         stop_timer ( &conn->timer );
393                         goto send_tcp_nomsg;
394                 }
395                 goto send_tcp_nomsg;
396         case TCP_ESTABLISHED:
397                 if ( conn->tcp_lstate == TCP_SYN_SENT ) {
398                         goto send_tcp_nomsg;
399                 }
400                 break;
401         case TCP_CLOSE_WAIT:
402                 if ( conn->tcp_lstate == TCP_ESTABLISHED ) {
403                         goto send_tcp_nomsg;
404                 }
405                 break;
406         case TCP_FIN_WAIT_1:
407         case TCP_FIN_WAIT_2:
408                 goto send_tcp_nomsg;
409         case TCP_CLOSING:
410         case TCP_LAST_ACK:
411                 if ( conn->tcp_lstate == TCP_CLOSE_WAIT ) {
412                         goto send_tcp_nomsg;
413                 }
414                 return;
415         case TCP_TIME_WAIT:
416                 tcp_trans ( conn, TCP_CLOSED );
417                 stop_timer ( &conn->timer );
418                 return;
419         }
420         /* Retransmit the data */
421         tcp_set_flags ( conn );
422         tcp_senddata ( conn );
423         return;
424
425   send_tcp_nomsg:
426         free_pkb ( conn->tx_pkb );
427         conn->tx_pkb = alloc_pkb ( MIN_PKB_LEN );
428         pkb_reserve ( conn->tx_pkb, MAX_HDR_LEN );
429         tcp_set_flags ( conn );
430         int rc;
431         if ( ( rc = tcp_send ( conn, TCP_NOMSG, TCP_NOMSG_LEN ) ) != 0 ) {
432                 DBG ( "Error sending TCP message (rc = %d)\n", rc );
433         }
434         return;
435 }
436
437 /**
438  * Connect to a remote server
439  *
440  * @v conn      TCP connection
441  * @v peer      Remote socket address
442  *
443  * This function initiates a TCP connection to the socket address specified in
444  * peer. It sends a SYN packet to peer. When the connection is established, the
445  * TCP stack calls the connected() callback function.
446  */
447 int tcp_connectto ( struct tcp_connection *conn,
448                     struct sockaddr_tcpip *peer ) {
449         int rc;
450
451         /* A connection can only be established from the CLOSED state */
452         if ( conn->tcp_state != TCP_CLOSED ) {
453                 DBG ( "Error opening connection: Invalid state %s\n",
454                                 tcp_states[conn->tcp_state] );
455                 return -EISCONN;
456         }
457
458         /* Add the connection to the set of listening connections */
459         if ( ( rc = tcp_listen ( conn, conn->local_port ) ) != 0 ) {
460                 return rc;
461         }
462         memcpy ( &conn->peer, peer, sizeof ( conn->peer ) );
463
464         /* Initialize the TCP timer */
465         conn->timer.expired = tcp_expired;
466
467         /* Send a SYN packet and transition to TCP_SYN_SENT */
468         conn->snd_una = random();
469         tcp_trans ( conn, TCP_SYN_SENT );
470         /* Allocate space for the packet */
471         free_pkb ( conn->tx_pkb );
472         conn->tx_pkb = alloc_pkb ( MIN_PKB_LEN );
473         pkb_reserve ( conn->tx_pkb, MAX_HDR_LEN );
474         conn->rcv_win = MAX_PKB_LEN - MAX_HDR_LEN; /* TODO: Is this OK? */
475         return tcp_send ( conn, TCP_NOMSG, TCP_NOMSG_LEN );
476 }
477
478 int tcp_connect ( struct tcp_connection *conn ) {
479         return tcp_connectto ( conn, &conn->peer );
480 }
481
482 /**
483  * Close the connection
484  *
485  * @v conn
486  *
487  * This function sends a FIN packet to the remote end of the connection. When
488  * the remote end of the connection ACKs the FIN (FIN consumes one byte on the
489  * snd stream), the stack invokes the closed() callback function.
490  */
491 int tcp_close ( struct tcp_connection *conn ) {
492         /* A connection can only be closed if it is a connected state */
493         switch ( conn->tcp_state ) {
494         case TCP_SYN_RCVD:
495         case TCP_ESTABLISHED:
496                 tcp_trans ( conn, TCP_FIN_WAIT_1 );
497                 conn->tcp_op->closed ( conn, CONN_SNDCLOSE ); /* TODO: Check! */
498                 /* FIN consumes one byte on the snd stream */
499 //              conn->snd_una++;
500                 goto send_tcp_nomsg;
501         case TCP_SYN_SENT:
502         case TCP_LISTEN:
503                 /**
504                  * Since the connection does not expect any packets from the
505                  * remote end, it can be removed from the set of listening
506                  * connections.
507                  */
508                 list_del ( &conn->list );
509                 tcp_trans ( conn, TCP_CLOSED );
510                 conn->tcp_op->closed ( conn, CONN_SNDCLOSE );
511                 return 0;
512         case TCP_CLOSE_WAIT:
513                 tcp_trans ( conn, TCP_LAST_ACK );
514                 conn->tcp_op->closed ( conn, CONN_SNDCLOSE ); /* TODO: Check! */
515                 /* FIN consumes one byte on the snd stream */
516 //              conn->snd_una++;
517                 goto send_tcp_nomsg;
518         default:
519                 DBG ( "tcp_close(): Invalid state %s\n",
520                                         tcp_states[conn->tcp_state] );
521                 return -EPROTO;
522         }
523
524   send_tcp_nomsg:
525         free_pkb ( conn->tx_pkb );
526         conn->tx_pkb = alloc_pkb ( MIN_PKB_LEN );
527         conn->tcp_flags = TCP_FIN;
528         pkb_reserve ( conn->tx_pkb, MAX_HDR_LEN );
529         return tcp_send ( conn, TCP_NOMSG, TCP_NOMSG_LEN );
530 }
531
532 /**
533  * Bind TCP connection to local port
534  *
535  * @v conn              TCP connection
536  * @v local_port        Local port, in network byte order
537  * @ret rc              Return status code
538  */
539 int tcp_bind ( struct tcp_connection *conn, uint16_t local_port ) {
540         struct tcp_connection *existing;
541
542         list_for_each_entry ( existing, &tcp_conns, list ) {
543                 if ( existing->local_port == local_port )
544                         return -EADDRINUSE;
545         }
546         conn->local_port = local_port;
547         return 0;
548 }
549
550
551 /**
552  * Listen for a packet
553  *
554  * @v conn              TCP connection
555  * @v local_port        Local port, in network byte order
556  *
557  * This function adds the connection to a list of registered tcp
558  * connections. If the local port is 0, the connection is assigned an
559  * available port between MIN_TCP_PORT and 65535.
560  */
561 int tcp_listen ( struct tcp_connection *conn, uint16_t local_port ) {
562         static uint16_t try_port = 1024;
563         int rc;
564
565         /* If no port specified, find the first available port */
566         if ( ! local_port ) {
567                 for ( ; try_port ; try_port++ ) {
568                         if ( try_port < 1024 )
569                                 continue;
570                         if ( tcp_listen ( conn, htons ( try_port ) ) == 0 )
571                                 return 0;
572                 }
573                 return -EADDRINUSE;
574         }
575
576         /* Attempt bind to local port */
577         if ( ( rc = tcp_bind ( conn, local_port ) ) != 0 )
578                 return rc;
579
580         /* Add to TCP connection list */
581         list_add ( &conn->list, &tcp_conns );
582         DBG ( "TCP opened %p on port %d\n", conn, ntohs ( local_port ) );
583
584         return 0;
585 }
586
587 /**
588  * Send data
589  *
590  * @v conn      TCP connection
591  * 
592  * This function allocates space to the transmit buffer and invokes the
593  * senddata() callback function. It passes the allocated buffer to senddata().
594  * The applicaion may use this space to write it's data.
595  */
596 int tcp_senddata ( struct tcp_connection *conn ) {
597         /* The connection must be in a state in which the user can send data */
598         switch ( conn->tcp_state ) {
599         case TCP_LISTEN:
600                 tcp_trans ( conn, TCP_SYN_SENT );
601                 conn->snd_una = random();
602                 break;
603         case TCP_ESTABLISHED:
604         case TCP_CLOSE_WAIT:
605                 break;
606         default:
607                 DBG ( "tcp_senddata: Invalid state %s\n",
608                                 tcp_states[conn->tcp_state] );
609                 return -EPROTO;
610         }
611
612         /* Allocate space to the TX buffer */
613         free_pkb ( conn->tx_pkb );
614         conn->tx_pkb = alloc_pkb ( MAX_PKB_LEN );
615         if ( !conn->tx_pkb ) {
616                 DBG ( "Insufficient memory\n" );
617                 return -ENOMEM;
618         }
619         pkb_reserve ( conn->tx_pkb, MAX_HDR_LEN );
620         /* Set the advertised window */
621         conn->rcv_win = pkb_available ( conn->tx_pkb );
622         /* Call the senddata() call back function */
623         conn->tcp_op->senddata ( conn, conn->tx_pkb->data, 
624                                         pkb_available ( conn->tx_pkb ) );
625         return 0;
626 }
627
628 /**
629  * Transmit data
630  *
631  * @v conn      TCP connection
632  * @v data      Data to be sent
633  * @v len       Length of the data
634  *
635  * This function sends data to the peer socket address
636  */
637 int tcp_send ( struct tcp_connection *conn, const void *data, size_t len ) {
638         struct sockaddr_tcpip *peer = &conn->peer;
639         struct pk_buff *pkb;
640         int slen;
641
642         /* Take ownership of the TX buffer from the connection */
643         pkb = conn->tx_pkb;
644         conn->tx_pkb = NULL;
645
646         /* Determine the amount of data to be sent */
647         slen = len < conn->snd_win ? len : conn->snd_win;
648         /* Copy payload */
649         memmove ( pkb_put ( pkb, slen ), data, slen );
650
651         /* Fill up the TCP header */
652         struct tcp_header *tcphdr = pkb_push ( pkb, sizeof ( *tcphdr ) );
653
654         /* Source port, assumed to be in network byte order in conn */
655         tcphdr->src = conn->local_port;
656         /* Destination port, assumed to be in network byte order in peer */
657         tcphdr->dest = peer->st_port;
658         tcphdr->seq = htonl ( conn->snd_una );
659         tcphdr->ack = htonl ( conn->rcv_nxt );
660         /* Header length, = 0x50 (without TCP options) */
661         tcphdr->hlen = ( uint8_t ) ( ( sizeof ( *tcphdr ) / 4 ) << 4 );
662         /* Copy TCP flags, and then reset the variable */
663         tcphdr->flags = conn->tcp_flags;
664         conn->tcp_flags = 0;
665         /* Advertised window, in network byte order */
666         tcphdr->win = htons ( conn->rcv_win );
667         /* Set urgent pointer to 0 */
668         tcphdr->urg = 0;
669         /* Calculate and store partial checksum, in host byte order */
670         tcphdr->csum = 0;
671         tcphdr->csum = tcpip_chksum ( pkb->data, pkb_len ( pkb ) );
672         
673         /* Dump the TCP header */
674
675         /* Start the timer */
676         if ( ( conn->tcp_state == TCP_ESTABLISHED && conn->tcp_lstate == TCP_SYN_SENT ) ||
677              ( conn->tcp_state == TCP_LISTEN && conn->tcp_lstate == TCP_SYN_RCVD ) ||
678              ( conn->tcp_state == TCP_CLOSED && conn->tcp_lstate == TCP_SYN_RCVD ) ) {
679                 // Don't start the timer
680         } else {
681                 start_timer ( &conn->timer );
682         }
683
684         /* Transmit packet */
685         return tcpip_tx ( pkb, &tcp_protocol, peer );
686 }
687
688 /**
689  * Process received packet
690  *
691  * @v pkb       Packet buffer
692  * @v partial   Partial checksum
693  */
694 static int tcp_rx ( struct pk_buff *pkb,
695                     struct sockaddr_tcpip *st_src __unused,
696                     struct sockaddr_tcpip *st_dest __unused ) {
697         struct tcp_connection *conn;
698         struct tcp_header *tcphdr;
699         uint32_t acked, toack;
700         int hlen;
701         int rc;
702
703         /* Sanity check */
704         if ( pkb_len ( pkb ) < sizeof ( *tcphdr ) ) {
705                 DBG ( "Packet too short (%d bytes)\n", pkb_len ( pkb ) );
706                 rc = -EINVAL;
707                 goto done;
708         }
709
710
711         /* Process TCP header */
712         tcphdr = pkb->data;
713         tcp_dump ( tcphdr );
714
715         /* Verify header length */
716         hlen = ( ( tcphdr->hlen & TCP_MASK_HLEN ) / 16 ) * 4;
717         if ( hlen != sizeof ( *tcphdr ) ) {
718                 if ( hlen == sizeof ( *tcphdr ) + 4 ) {
719                         DBG ( "TCP options sent\n" );
720                 } else {
721                         DBG ( "Bad header length (%d bytes)\n", hlen );
722                         rc = -EINVAL;
723                         goto done;
724                 }
725         }
726
727
728         /* TODO: Verify checksum */
729         
730         /* Demux TCP connection */
731         list_for_each_entry ( conn, &tcp_conns, list ) {
732                 if ( tcphdr->dest == conn->local_port ) {
733                         goto found_conn;
734                 }
735         }
736         
737         DBG ( "No connection found on port %d\n", ntohs ( tcphdr->dest ) );
738         rc = 0;
739         goto done;
740
741   found_conn:
742         /* Stop the timer */
743         stop_timer ( &conn->timer );
744
745         /* Set the advertised window */
746         conn->snd_win = tcphdr->win;
747
748         /* TCP State Machine */
749         conn->tcp_lstate = conn->tcp_state;
750         switch ( conn->tcp_state ) {
751         case TCP_CLOSED:
752                 DBG ( "tcp_rx(): Invalid state %s\n",
753                                 tcp_states[conn->tcp_state] );
754                 rc = -EINVAL;
755                 goto done;
756         case TCP_LISTEN:
757                 if ( tcphdr->flags & TCP_SYN ) {
758                         tcp_trans ( conn, TCP_SYN_RCVD );
759                         /* Synchronize the sequence numbers */
760                         conn->rcv_nxt = ntohl ( tcphdr->seq ) + 1;
761                         conn->tcp_flags |= TCP_ACK;
762
763                         /* Set the sequence number for the snd stream */
764                         conn->snd_una = random();
765                         conn->tcp_flags |= TCP_SYN;
766
767                         /* Send a SYN,ACK packet */
768                         goto send_tcp_nomsg;
769                 }
770                 /* Unexpected packet */
771                 goto unexpected;
772         case TCP_SYN_SENT:
773                 if ( tcphdr->flags & TCP_SYN ) {
774                         /* Synchronize the sequence number in rcv stream */
775                         conn->rcv_nxt = ntohl ( tcphdr->seq ) + 1;
776                         conn->tcp_flags |= TCP_ACK;
777
778                         if ( tcphdr->flags & TCP_ACK ) {
779                                 tcp_trans ( conn, TCP_ESTABLISHED );
780                                 /**
781                                  * Process ACK of SYN. This does not invoke the
782                                  * acked() callback function.
783                                  */
784                                 conn->snd_una = ntohl ( tcphdr->ack );
785                                 conn->tcp_op->connected ( conn );
786                                 conn->tcp_flags |= TCP_ACK;
787                                 tcp_senddata ( conn );
788                                 rc = 0;
789                                 goto done;
790                         } else {
791                                 tcp_trans ( conn, TCP_SYN_RCVD );
792                                 conn->tcp_flags |= TCP_SYN;
793                                 goto send_tcp_nomsg;
794                         }
795                 }
796                 /* Unexpected packet */
797                 goto unexpected;
798         case TCP_SYN_RCVD:
799                 if ( tcphdr->flags & TCP_RST ) {
800                         tcp_trans ( conn, TCP_LISTEN );
801                         conn->tcp_op->closed ( conn, CONN_RESTART );
802                         rc = 0;
803                         goto done;
804                 }
805                 if ( tcphdr->flags & TCP_ACK ) {
806                         tcp_trans ( conn, TCP_ESTABLISHED );
807                         /**
808                          * Process ACK of SYN. It neither invokes the callback
809                          * function nor does it send an ACK.
810                          */
811                         conn->snd_una = tcphdr->ack - 1;
812                         conn->tcp_op->connected ( conn );
813                         rc = 0;
814                         goto done;
815                 }
816                 /* Unexpected packet */
817                 goto unexpected;
818         case TCP_ESTABLISHED:
819 #if 0
820                 if ( tcphdr->flags & TCP_FIN ) {
821                         tcp_trans ( conn, TCP_CLOSE_WAIT );
822                         /* FIN consumes one byte */
823                         conn->rcv_nxt++;
824                         conn->tcp_flags |= TCP_ACK;
825                         /* Send an acknowledgement */
826                         goto send_tcp_nomsg;
827                 }
828 #endif
829                 /* Packet might contain data */
830                 break;
831         case TCP_FIN_WAIT_1:
832                 if ( tcphdr->flags & TCP_FIN ) {
833                         conn->rcv_nxt++;
834                         conn->tcp_flags |= TCP_ACK;
835                         conn->tcp_op->closed ( conn, CONN_SNDCLOSE );
836
837                         if ( tcphdr->flags & TCP_ACK ) {
838                                 tcp_trans ( conn, TCP_TIME_WAIT );
839                         } else {
840                                 tcp_trans ( conn, TCP_CLOSING );
841                         }
842                         /* Send an acknowledgement */
843                         goto send_tcp_nomsg;
844                 }
845                 if ( tcphdr->flags & TCP_ACK ) {
846                         tcp_trans ( conn, TCP_FIN_WAIT_2 );
847                 }
848                 /* Packet might contain data */
849                 break;
850         case TCP_FIN_WAIT_2:
851                 if ( tcphdr->flags & TCP_FIN ) {
852                         tcp_trans ( conn, TCP_TIME_WAIT );
853                         /* FIN consumes one byte */
854                         conn->rcv_nxt++;
855                         conn->tcp_flags |= TCP_ACK;
856                         goto send_tcp_nomsg;
857                 }
858                 /* Packet might contain data */
859                 break;
860         case TCP_CLOSING:
861                 if ( tcphdr->flags & TCP_ACK ) {
862                         tcp_trans ( conn, TCP_TIME_WAIT );
863                         start_timer ( &conn->timer );
864                         rc = 0;
865                         goto done;
866                 }
867                 /* Unexpected packet */
868                 goto unexpected;
869         case TCP_TIME_WAIT:
870                 /* Unexpected packet */
871                 goto unexpected;
872         case TCP_CLOSE_WAIT:
873                 /* Packet could acknowledge data */
874                 break;
875         case TCP_LAST_ACK:
876                 if ( tcphdr->flags & TCP_ACK ) {
877                         tcp_trans ( conn, TCP_CLOSED );
878                         rc = 0;
879                         goto done;
880                 }
881                 /* Unexpected packet */
882                 goto unexpected;
883         }
884
885         /**
886          * Any packet reaching this point either contains new data or
887          * acknowledges previously transmitted data.
888          */
889         assert ( ( tcphdr->flags & TCP_ACK ) ||
890                  pkb_len ( pkb ) > sizeof ( *tcphdr ) );
891
892         /* Check for new data */
893         toack = pkb_len ( pkb ) - hlen;
894         if ( toack > 0 ) {
895                 /* Check if expected sequence number */
896                 if ( conn->rcv_nxt == ntohl ( tcphdr->seq ) ) {
897                         conn->rcv_nxt += toack;
898                         conn->tcp_op->newdata ( conn, pkb->data + hlen,
899                                                 toack );
900                 } else {
901                         DBG ( "Unexpected sequence number %lx (wanted %lx)\n", 
902                               ntohl ( tcphdr->seq ), conn->rcv_nxt );
903                 }
904
905                 /* Acknowledge new data */
906                 conn->tcp_flags |= TCP_ACK;
907                 if ( !( tcphdr->flags & TCP_ACK ) ) {
908                         goto send_tcp_nomsg;
909                 }
910         }
911
912         /* Process ACK */
913         if ( tcphdr->flags & TCP_ACK ) {
914                 acked = ntohl ( tcphdr->ack ) - conn->snd_una;
915                 if ( acked < 0 ) { /* TODO: Replace all uint32_t arith */
916                         DBG ( "Previously ACKed (%d)\n", tcphdr->ack );
917                         rc = 0;
918                         goto done;
919                 }
920                 /* Advance snd stream */
921                 conn->snd_una += acked;
922                 /* Invoke the acked() callback function */
923                 conn->tcp_op->acked ( conn, acked );
924                 /* Invoke the senddata() callback function */
925                 tcp_senddata ( conn );
926         }
927
928         /* If the connection is in ESTABLISHED and it receives a FIN */
929         if ( conn->tcp_state == ESTABLISHED && ( tcphdr->flags & TCP_FIN ) ) {
930                 tcp_trans ( conn, TCP_CLOSE_WAIT );
931                 conn->tcp_op->closed ( conn, CONN_SNDCLOSE );   
932                 conn->rcv_nxt++;
933                 if ( ! ( tcphdr->flags & TCP_ACK ) ) {
934                         conn->tcp_flags |= TCP_ACK;
935                         /* Send an acknowledgement */
936                         goto send_tcp_nomsg;
937                 }
938                 /* Otherwise, the packet has been ACKed already */
939         }
940         rc = 0;
941         goto done;
942
943   send_tcp_nomsg:
944         free_pkb ( conn->tx_pkb );
945         conn->tx_pkb = alloc_pkb ( MIN_PKB_LEN );
946         pkb_reserve ( conn->tx_pkb, MAX_HDR_LEN );
947         if ( ( rc = tcp_send ( conn, TCP_NOMSG, TCP_NOMSG_LEN ) ) != 0 ) {
948                 DBG ( "Error sending TCP message (rc = %d)\n", rc );
949         }
950         goto done;
951
952   unexpected:
953         DBG ( "Unexpected packet received in %s with flags = %#hx\n",
954                         tcp_states[conn->tcp_state], tcphdr->flags & TCP_MASK_FLAGS );
955         tcp_close ( conn );
956         free_pkb ( conn->tx_pkb );
957         conn->tx_pkb = NULL;
958         rc = -EINVAL;
959         goto done;
960
961  done:
962         free_pkb ( pkb );
963         return rc;
964 }
965
966 /** TCP protocol */
967 struct tcpip_protocol tcp_protocol __tcpip_protocol = {
968         .name = "TCP",
969         .rx = tcp_rx,
970         .tcpip_proto = IP_TCP,
971         .csum_offset = 16,
972 };
973
974 #endif /* USE_UIP */