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