097b77d96b1607c99ff74572aad03ade5080b4a3
[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                 if ( conn->tcp_lstate == TCP_ESTABLISHED ) {
318                         conn->tcp_flags |= ( TCP_FIN | TCP_ACK );
319                 }
320                 break;
321         default:
322                 DBG ( "TCP_INVALID state %d\n", conn->tcp_state );
323                 return;
324         }
325 }
326
327 void tcp_trans ( struct tcp_connection *conn, int nxt_state ) {
328         /* Remember the last state */
329         conn->tcp_lstate = conn->tcp_state;
330         conn->tcp_state = nxt_state;
331
332         /* TODO: Check if this check is required */
333         if ( conn->tcp_lstate == conn->tcp_state || 
334              conn->tcp_state == TCP_INVALID ) {
335                 conn->tcp_flags = 0;
336                 return;
337         }
338         tcp_set_flags ( conn );
339 }
340
341 /**
342  * Dump TCP header
343  *
344  * @v tcphdr    TCP header
345  */
346 void tcp_dump ( struct tcp_header *tcphdr ) {
347         DBG ( "TCP %p src:%d dest:%d seq:%lx ack:%lx hlen:%hd flags:%#hx\n",
348                 tcphdr, ntohs ( tcphdr->src ), ntohs ( tcphdr->dest ), ntohl ( tcphdr->seq ),
349                 ntohl ( tcphdr->ack ), ( ( tcphdr->hlen & TCP_MASK_HLEN ) / 16 ), ( tcphdr->flags & TCP_MASK_FLAGS ) );
350 }
351
352 /**
353  * Initialize a TCP connection
354  *
355  * @v conn      TCP connection
356  *
357  * This function assigns initial values to some fields in the connection
358  * structure. The application should call tcp_init_conn after creating a new
359  * connection before calling any other "tcp_*" function.
360  *
361  * struct tcp_connection my_conn;
362  * tcp_init_conn ( &my_conn );
363  * ... 
364  */
365 void tcp_init_conn ( struct tcp_connection *conn ) {
366         conn->local_port = 0;
367         conn->tcp_state = TCP_CLOSED;
368         conn->tcp_lstate = TCP_INVALID;
369         conn->tx_pkb = NULL;
370         conn->tcp_op = NULL;
371 }
372
373 /** Retry timer
374  *
375  * @v timer     Retry timer
376  * @v over      Failure indicator
377  */
378 void tcp_expired ( struct retry_timer *timer, int over ) {
379         struct tcp_connection *conn;
380         conn = ( struct tcp_connection * ) container_of ( timer, 
381                                         struct tcp_connection, timer );
382         DBG ( "Timer expired in %s\n", tcp_states[conn->tcp_state] );
383         switch ( conn->tcp_state ) {
384         case TCP_SYN_SENT:
385                 if ( over ) {
386                         tcp_trans ( conn, TCP_CLOSED );
387                         DBG ( "Timeout! Connection closed\n" );
388                         return;
389                 }
390                 goto send_tcp_nomsg;
391         case TCP_SYN_RCVD:
392                 if ( over ) {
393                         tcp_trans ( conn, TCP_CLOSED );
394                         goto send_tcp_nomsg;
395                 }
396                 goto send_tcp_nomsg;
397         case TCP_ESTABLISHED:
398                 if ( conn->tcp_lstate == TCP_SYN_SENT ) {
399                         goto send_tcp_nomsg;
400                 }
401                 break;
402         case TCP_CLOSE_WAIT:
403                 if ( conn->tcp_lstate == TCP_ESTABLISHED ) {
404                         goto send_tcp_nomsg;
405                 }
406                 break;
407         case TCP_FIN_WAIT_1:
408         case TCP_FIN_WAIT_2:
409                 goto send_tcp_nomsg;
410         case TCP_CLOSING:
411         case TCP_LAST_ACK:
412                 if ( conn->tcp_lstate == TCP_CLOSE_WAIT ) {
413                         goto send_tcp_nomsg;
414                 }
415                 return;
416         case TCP_TIME_WAIT:
417                 tcp_trans ( conn, TCP_CLOSED );
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 #warning "Fix the port re-use bug"
566         /* If we re-use the same port, the connection should be reset
567          * and a new connection set up.  This doesn't happen yet, so
568          * randomise the port to avoid hitting the problem.
569          */
570         try_port = random();
571
572         /* If no port specified, find the first available port */
573         if ( ! local_port ) {
574                 for ( ; try_port ; try_port++ ) {
575                         if ( try_port < 1024 )
576                                 continue;
577                         if ( tcp_listen ( conn, htons ( try_port ) ) == 0 )
578                                 return 0;
579                 }
580                 return -EADDRINUSE;
581         }
582
583         /* Attempt bind to local port */
584         if ( ( rc = tcp_bind ( conn, local_port ) ) != 0 )
585                 return rc;
586
587         /* Add to TCP connection list */
588         list_add ( &conn->list, &tcp_conns );
589         DBG ( "TCP opened %p on port %d\n", conn, ntohs ( local_port ) );
590
591         return 0;
592 }
593
594 /**
595  * Send data
596  *
597  * @v conn      TCP connection
598  * 
599  * This function allocates space to the transmit buffer and invokes the
600  * senddata() callback function. It passes the allocated buffer to senddata().
601  * The applicaion may use this space to write it's data.
602  */
603 int tcp_senddata ( struct tcp_connection *conn ) {
604         /* The connection must be in a state in which the user can send data */
605         switch ( conn->tcp_state ) {
606         case TCP_LISTEN:
607                 tcp_trans ( conn, TCP_SYN_SENT );
608                 conn->snd_una = random();
609                 break;
610         case TCP_ESTABLISHED:
611         case TCP_CLOSE_WAIT:
612                 break;
613         default:
614                 DBG ( "tcp_senddata: Invalid state %s\n",
615                                 tcp_states[conn->tcp_state] );
616                 return -EPROTO;
617         }
618
619         /* Allocate space to the TX buffer */
620         free_pkb ( conn->tx_pkb );
621         conn->tx_pkb = alloc_pkb ( MAX_PKB_LEN );
622         if ( !conn->tx_pkb ) {
623                 DBG ( "Insufficient memory\n" );
624                 return -ENOMEM;
625         }
626         pkb_reserve ( conn->tx_pkb, MAX_HDR_LEN );
627         /* Set the advertised window */
628         conn->rcv_win = pkb_available ( conn->tx_pkb );
629         /* Call the senddata() call back function */
630         conn->tcp_op->senddata ( conn, conn->tx_pkb->data, 
631                                         pkb_available ( conn->tx_pkb ) );
632         /* Send pure ACK if senddata() didn't call tcp_send() */
633         if ( conn->tx_pkb ) {
634                 tcp_send ( conn, TCP_NOMSG, TCP_NOMSG_LEN );
635         }
636         return 0;
637 }
638
639 /**
640  * Transmit data
641  *
642  * @v conn      TCP connection
643  * @v data      Data to be sent
644  * @v len       Length of the data
645  *
646  * This function sends data to the peer socket address
647  */
648 int tcp_send ( struct tcp_connection *conn, const void *data, size_t len ) {
649         struct sockaddr_tcpip *peer = &conn->peer;
650         struct pk_buff *pkb;
651         int slen;
652
653         /* Take ownership of the TX buffer from the connection */
654         pkb = conn->tx_pkb;
655         conn->tx_pkb = NULL;
656
657         /* Determine the amount of data to be sent */
658         slen = len < conn->snd_win ? len : conn->snd_win;
659         /* Copy payload */
660         memmove ( pkb_put ( pkb, slen ), data, slen );
661
662         /* Fill up the TCP header */
663         struct tcp_header *tcphdr = pkb_push ( pkb, sizeof ( *tcphdr ) );
664
665         /* Source port, assumed to be in network byte order in conn */
666         tcphdr->src = conn->local_port;
667         /* Destination port, assumed to be in network byte order in peer */
668         tcphdr->dest = peer->st_port;
669         tcphdr->seq = htonl ( conn->snd_una );
670         tcphdr->ack = htonl ( conn->rcv_nxt );
671         /* Header length, = 0x50 (without TCP options) */
672         tcphdr->hlen = ( uint8_t ) ( ( sizeof ( *tcphdr ) / 4 ) << 4 );
673         /* Copy TCP flags, and then reset the variable */
674         tcphdr->flags = conn->tcp_flags;
675         conn->tcp_flags = 0;
676         /* Advertised window, in network byte order */
677         tcphdr->win = htons ( conn->rcv_win );
678         /* Set urgent pointer to 0 */
679         tcphdr->urg = 0;
680         /* Calculate and store partial checksum, in host byte order */
681         tcphdr->csum = 0;
682         tcphdr->csum = tcpip_chksum ( pkb->data, pkb_len ( pkb ) );
683         
684         /* Dump the TCP header */
685
686         /* Start the timer */
687         if ( ( conn->tcp_state == TCP_ESTABLISHED && conn->tcp_lstate == TCP_SYN_SENT ) ||
688              ( conn->tcp_state == TCP_LISTEN && conn->tcp_lstate == TCP_SYN_RCVD ) ||
689              ( conn->tcp_state == TCP_CLOSED && conn->tcp_lstate == TCP_SYN_RCVD ) ||
690              ( conn->tcp_state == TCP_ESTABLISHED && ( len == 0 ) ) ) {
691                 // Don't start the timer
692         } else {
693                 start_timer ( &conn->timer );
694         }
695
696         /* Transmit packet */
697         return tcpip_tx ( pkb, &tcp_protocol, peer );
698 }
699
700 /**
701  * Process received packet
702  *
703  * @v pkb       Packet buffer
704  * @v partial   Partial checksum
705  */
706 static int tcp_rx ( struct pk_buff *pkb,
707                     struct sockaddr_tcpip *st_src __unused,
708                     struct sockaddr_tcpip *st_dest __unused ) {
709         struct tcp_connection *conn;
710         struct tcp_header *tcphdr;
711         uint32_t acked, toack;
712         int hlen;
713         int rc;
714
715         /* Sanity check */
716         if ( pkb_len ( pkb ) < sizeof ( *tcphdr ) ) {
717                 DBG ( "Packet too short (%d bytes)\n", pkb_len ( pkb ) );
718                 rc = -EINVAL;
719                 goto done;
720         }
721
722
723         /* Process TCP header */
724         tcphdr = pkb->data;
725         tcp_dump ( tcphdr );
726
727         /* Verify header length */
728         hlen = ( ( tcphdr->hlen & TCP_MASK_HLEN ) / 16 ) * 4;
729         if ( hlen != sizeof ( *tcphdr ) ) {
730                 if ( hlen == sizeof ( *tcphdr ) + 4 ) {
731                         DBG ( "TCP options sent\n" );
732                 } else {
733                         DBG ( "Bad header length (%d bytes)\n", hlen );
734                         rc = -EINVAL;
735                         goto done;
736                 }
737         }
738
739
740         /* TODO: Verify checksum */
741         
742         /* Demux TCP connection */
743         list_for_each_entry ( conn, &tcp_conns, list ) {
744                 if ( tcphdr->dest == conn->local_port ) {
745                         goto found_conn;
746                 }
747         }
748         
749         DBG ( "No connection found on port %d\n", ntohs ( tcphdr->dest ) );
750         rc = 0;
751         goto done;
752
753   found_conn:
754         /* Stop the timer */
755         stop_timer ( &conn->timer );
756
757         /* Set the advertised window */
758         conn->snd_win = tcphdr->win;
759
760         /* TCP State Machine */
761         conn->tcp_lstate = conn->tcp_state;
762         switch ( conn->tcp_state ) {
763         case TCP_CLOSED:
764                 DBG ( "tcp_rx(): Invalid state %s\n",
765                                 tcp_states[conn->tcp_state] );
766                 rc = -EINVAL;
767                 goto done;
768         case TCP_LISTEN:
769                 if ( tcphdr->flags & TCP_SYN ) {
770                         tcp_trans ( conn, TCP_SYN_RCVD );
771                         /* Synchronize the sequence numbers */
772                         conn->rcv_nxt = ntohl ( tcphdr->seq ) + 1;
773                         conn->tcp_flags |= TCP_ACK;
774
775                         /* Set the sequence number for the snd stream */
776                         conn->snd_una = random();
777                         conn->tcp_flags |= TCP_SYN;
778
779                         /* Send a SYN,ACK packet */
780                         goto send_tcp_nomsg;
781                 }
782                 /* Unexpected packet */
783                 goto unexpected;
784         case TCP_SYN_SENT:
785                 if ( tcphdr->flags & TCP_SYN ) {
786                         /* Synchronize the sequence number in rcv stream */
787                         conn->rcv_nxt = ntohl ( tcphdr->seq ) + 1;
788                         conn->tcp_flags |= TCP_ACK;
789
790                         if ( tcphdr->flags & TCP_ACK ) {
791                                 tcp_trans ( conn, TCP_ESTABLISHED );
792                                 /**
793                                  * Process ACK of SYN. This does not invoke the
794                                  * acked() callback function.
795                                  */
796                                 conn->snd_una = ntohl ( tcphdr->ack );
797                                 conn->tcp_op->connected ( conn );
798                                 conn->tcp_flags |= TCP_ACK;
799                                 tcp_senddata ( conn );
800                                 rc = 0;
801                                 goto done;
802                         } else {
803                                 tcp_trans ( conn, TCP_SYN_RCVD );
804                                 conn->tcp_flags |= TCP_SYN;
805                                 goto send_tcp_nomsg;
806                         }
807                 }
808                 /* Unexpected packet */
809                 goto unexpected;
810         case TCP_SYN_RCVD:
811                 if ( tcphdr->flags & TCP_RST ) {
812                         tcp_trans ( conn, TCP_LISTEN );
813                         conn->tcp_op->closed ( conn, CONN_RESTART );
814                         rc = 0;
815                         goto done;
816                 }
817                 if ( tcphdr->flags & TCP_ACK ) {
818                         tcp_trans ( conn, TCP_ESTABLISHED );
819                         /**
820                          * Process ACK of SYN. It neither invokes the callback
821                          * function nor does it send an ACK.
822                          */
823                         conn->snd_una = tcphdr->ack - 1;
824                         conn->tcp_op->connected ( conn );
825                         rc = 0;
826                         goto done;
827                 }
828                 /* Unexpected packet */
829                 goto unexpected;
830         case TCP_ESTABLISHED:
831 #if 0
832                 if ( tcphdr->flags & TCP_FIN ) {
833                         tcp_trans ( conn, TCP_CLOSE_WAIT );
834                         /* FIN consumes one byte */
835                         conn->rcv_nxt++;
836                         conn->tcp_flags |= TCP_ACK;
837                         /* Send an acknowledgement */
838                         goto send_tcp_nomsg;
839                 }
840 #endif
841                 /* Packet might contain data */
842                 break;
843         case TCP_FIN_WAIT_1:
844                 if ( tcphdr->flags & TCP_FIN ) {
845                         conn->rcv_nxt++;
846                         conn->tcp_flags |= TCP_ACK;
847                         conn->tcp_op->closed ( conn, CONN_SNDCLOSE );
848
849                         if ( tcphdr->flags & TCP_ACK ) {
850                                 tcp_trans ( conn, TCP_TIME_WAIT );
851                         } else {
852                                 tcp_trans ( conn, TCP_CLOSING );
853                         }
854                         /* Send an acknowledgement */
855                         goto send_tcp_nomsg;
856                 }
857                 if ( tcphdr->flags & TCP_ACK ) {
858                         tcp_trans ( conn, TCP_FIN_WAIT_2 );
859                 }
860                 /* Packet might contain data */
861                 break;
862         case TCP_FIN_WAIT_2:
863                 if ( tcphdr->flags & TCP_FIN ) {
864                         tcp_trans ( conn, TCP_TIME_WAIT );
865                         /* FIN consumes one byte */
866                         conn->rcv_nxt++;
867                         conn->tcp_flags |= TCP_ACK;
868                         goto send_tcp_nomsg;
869                 }
870                 /* Packet might contain data */
871                 break;
872         case TCP_CLOSING:
873                 if ( tcphdr->flags & TCP_ACK ) {
874                         tcp_trans ( conn, TCP_TIME_WAIT );
875                         start_timer ( &conn->timer );
876                         rc = 0;
877                         goto done;
878                 }
879                 /* Unexpected packet */
880                 goto unexpected;
881         case TCP_TIME_WAIT:
882                 /* Unexpected packet */
883                 goto unexpected;
884         case TCP_CLOSE_WAIT:
885                 /* Packet could acknowledge data */
886                 break;
887         case TCP_LAST_ACK:
888                 if ( tcphdr->flags & TCP_ACK ) {
889                         tcp_trans ( conn, TCP_CLOSED );
890                         rc = 0;
891                         goto done;
892                 }
893                 /* Unexpected packet */
894                 goto unexpected;
895         }
896
897         /**
898          * Any packet reaching this point either contains new data or
899          * acknowledges previously transmitted data.
900          */
901         assert ( ( tcphdr->flags & TCP_ACK ) ||
902                  pkb_len ( pkb ) > sizeof ( *tcphdr ) );
903
904         /* Check for new data */
905         toack = pkb_len ( pkb ) - hlen;
906         if ( toack > 0 ) {
907                 /* Check if expected sequence number */
908                 if ( conn->rcv_nxt == ntohl ( tcphdr->seq ) ) {
909                         conn->rcv_nxt += toack;
910                         conn->tcp_op->newdata ( conn, pkb->data + hlen,
911                                                 toack );
912                 } else {
913                         DBG ( "Unexpected sequence number %lx (wanted %lx)\n", 
914                               ntohl ( tcphdr->seq ), conn->rcv_nxt );
915                 }
916
917                 /* Acknowledge new data */
918                 conn->tcp_flags |= TCP_ACK;
919                 if ( !( tcphdr->flags & TCP_ACK ) ) {
920                         goto send_tcp_nomsg;
921                 }
922         }
923
924         /* Process ACK */
925         if ( tcphdr->flags & TCP_ACK ) {
926                 acked = ntohl ( tcphdr->ack ) - conn->snd_una;
927                 if ( acked < 0 ) { /* TODO: Replace all uint32_t arith */
928                         DBG ( "Previously ACKed (%d)\n", tcphdr->ack );
929                         rc = 0;
930                         goto done;
931                 }
932                 /* Advance snd stream */
933                 conn->snd_una += acked;
934                 /* Invoke the acked() callback function */
935                 conn->tcp_op->acked ( conn, acked );
936                 /* Invoke the senddata() callback function */
937                 tcp_senddata ( conn );
938         }
939
940         /* If the connection is in ESTABLISHED and it receives a FIN */
941         if ( conn->tcp_state == ESTABLISHED && ( tcphdr->flags & TCP_FIN ) ) {
942                 if ( tcphdr->flags & TCP_ACK ) {
943                         tcp_trans ( conn, TCP_LAST_ACK );
944                         goto send_tcp_nomsg;
945                 }
946                 tcp_trans ( conn, TCP_CLOSE_WAIT );
947 //              conn->tcp_op->closed ( conn, CONN_SNDCLOSE );   
948                 conn->rcv_nxt++;
949                 if ( ! ( tcphdr->flags & TCP_ACK ) ) {
950                         conn->tcp_flags |= TCP_ACK;
951                         /* Send an acknowledgement */
952                         goto send_tcp_nomsg;
953                 }
954                 /* Otherwise, the packet has been ACKed already */
955         }
956         rc = 0;
957         goto done;
958
959   send_tcp_nomsg:
960         free_pkb ( conn->tx_pkb );
961         conn->tx_pkb = alloc_pkb ( MIN_PKB_LEN );
962         pkb_reserve ( conn->tx_pkb, MAX_HDR_LEN );
963         if ( ( rc = tcp_send ( conn, TCP_NOMSG, TCP_NOMSG_LEN ) ) != 0 ) {
964                 DBG ( "Error sending TCP message (rc = %d)\n", rc );
965         }
966         goto done;
967
968   unexpected:
969         DBG ( "Unexpected packet received in %s with flags = %#hx\n",
970                         tcp_states[conn->tcp_state], tcphdr->flags & TCP_MASK_FLAGS );
971         tcp_close ( conn );
972         free_pkb ( conn->tx_pkb );
973         conn->tx_pkb = NULL;
974         rc = -EINVAL;
975         goto done;
976
977  done:
978         free_pkb ( pkb );
979         return rc;
980 }
981
982 /** TCP protocol */
983 struct tcpip_protocol tcp_protocol __tcpip_protocol = {
984         .name = "TCP",
985         .rx = tcp_rx,
986         .tcpip_proto = IP_TCP,
987         .csum_offset = 16,
988 };
989
990 #endif /* USE_UIP */