c3b7271d9bd787b72f20f92d62ef3185f6468331
[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                         stop_timer ( &conn->timer );
388                         DBG ( "Timeout! Connection closed\n" );
389                         return;
390                 }
391                 goto send_tcp_nomsg;
392         case TCP_SYN_RCVD:
393                 if ( over ) {
394                         tcp_trans ( conn, TCP_CLOSED );
395                         stop_timer ( &conn->timer );
396                         goto send_tcp_nomsg;
397                 }
398                 goto send_tcp_nomsg;
399         case TCP_ESTABLISHED:
400                 if ( conn->tcp_lstate == TCP_SYN_SENT ) {
401                         goto send_tcp_nomsg;
402                 }
403                 break;
404         case TCP_CLOSE_WAIT:
405                 if ( conn->tcp_lstate == TCP_ESTABLISHED ) {
406                         goto send_tcp_nomsg;
407                 }
408                 break;
409         case TCP_FIN_WAIT_1:
410         case TCP_FIN_WAIT_2:
411                 goto send_tcp_nomsg;
412         case TCP_CLOSING:
413         case TCP_LAST_ACK:
414                 if ( conn->tcp_lstate == TCP_CLOSE_WAIT ) {
415                         goto send_tcp_nomsg;
416                 }
417                 return;
418         case TCP_TIME_WAIT:
419                 tcp_trans ( conn, TCP_CLOSED );
420                 stop_timer ( &conn->timer );
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         return 0;
636 }
637
638 /**
639  * Transmit data
640  *
641  * @v conn      TCP connection
642  * @v data      Data to be sent
643  * @v len       Length of the data
644  *
645  * This function sends data to the peer socket address
646  */
647 int tcp_send ( struct tcp_connection *conn, const void *data, size_t len ) {
648         struct sockaddr_tcpip *peer = &conn->peer;
649         struct pk_buff *pkb;
650         int slen;
651
652         /* Take ownership of the TX buffer from the connection */
653         pkb = conn->tx_pkb;
654         conn->tx_pkb = NULL;
655
656         /* Determine the amount of data to be sent */
657         slen = len < conn->snd_win ? len : conn->snd_win;
658         /* Copy payload */
659         memmove ( pkb_put ( pkb, slen ), data, slen );
660
661         /* Fill up the TCP header */
662         struct tcp_header *tcphdr = pkb_push ( pkb, sizeof ( *tcphdr ) );
663
664         /* Source port, assumed to be in network byte order in conn */
665         tcphdr->src = conn->local_port;
666         /* Destination port, assumed to be in network byte order in peer */
667         tcphdr->dest = peer->st_port;
668         tcphdr->seq = htonl ( conn->snd_una );
669         tcphdr->ack = htonl ( conn->rcv_nxt );
670         /* Header length, = 0x50 (without TCP options) */
671         tcphdr->hlen = ( uint8_t ) ( ( sizeof ( *tcphdr ) / 4 ) << 4 );
672         /* Copy TCP flags, and then reset the variable */
673         tcphdr->flags = conn->tcp_flags;
674         conn->tcp_flags = 0;
675         /* Advertised window, in network byte order */
676         tcphdr->win = htons ( conn->rcv_win );
677         /* Set urgent pointer to 0 */
678         tcphdr->urg = 0;
679         /* Calculate and store partial checksum, in host byte order */
680         tcphdr->csum = 0;
681         tcphdr->csum = tcpip_chksum ( pkb->data, pkb_len ( pkb ) );
682         
683         /* Dump the TCP header */
684
685         /* Start the timer */
686         if ( ( conn->tcp_state == TCP_ESTABLISHED && conn->tcp_lstate == TCP_SYN_SENT ) ||
687              ( conn->tcp_state == TCP_LISTEN && conn->tcp_lstate == TCP_SYN_RCVD ) ||
688              ( conn->tcp_state == TCP_CLOSED && conn->tcp_lstate == TCP_SYN_RCVD ) ) {
689                 // Don't start the timer
690         } else {
691                 start_timer ( &conn->timer );
692         }
693
694         /* Transmit packet */
695         return tcpip_tx ( pkb, &tcp_protocol, peer );
696 }
697
698 /**
699  * Process received packet
700  *
701  * @v pkb       Packet buffer
702  * @v partial   Partial checksum
703  */
704 static int tcp_rx ( struct pk_buff *pkb,
705                     struct sockaddr_tcpip *st_src __unused,
706                     struct sockaddr_tcpip *st_dest __unused ) {
707         struct tcp_connection *conn;
708         struct tcp_header *tcphdr;
709         uint32_t acked, toack;
710         int hlen;
711         int rc;
712
713         /* Sanity check */
714         if ( pkb_len ( pkb ) < sizeof ( *tcphdr ) ) {
715                 DBG ( "Packet too short (%d bytes)\n", pkb_len ( pkb ) );
716                 rc = -EINVAL;
717                 goto done;
718         }
719
720
721         /* Process TCP header */
722         tcphdr = pkb->data;
723         tcp_dump ( tcphdr );
724
725         /* Verify header length */
726         hlen = ( ( tcphdr->hlen & TCP_MASK_HLEN ) / 16 ) * 4;
727         if ( hlen != sizeof ( *tcphdr ) ) {
728                 if ( hlen == sizeof ( *tcphdr ) + 4 ) {
729                         DBG ( "TCP options sent\n" );
730                 } else {
731                         DBG ( "Bad header length (%d bytes)\n", hlen );
732                         rc = -EINVAL;
733                         goto done;
734                 }
735         }
736
737
738         /* TODO: Verify checksum */
739         
740         /* Demux TCP connection */
741         list_for_each_entry ( conn, &tcp_conns, list ) {
742                 if ( tcphdr->dest == conn->local_port ) {
743                         goto found_conn;
744                 }
745         }
746         
747         DBG ( "No connection found on port %d\n", ntohs ( tcphdr->dest ) );
748         rc = 0;
749         goto done;
750
751   found_conn:
752         /* Stop the timer */
753         stop_timer ( &conn->timer );
754
755         /* Set the advertised window */
756         conn->snd_win = tcphdr->win;
757
758         /* TCP State Machine */
759         conn->tcp_lstate = conn->tcp_state;
760         switch ( conn->tcp_state ) {
761         case TCP_CLOSED:
762                 DBG ( "tcp_rx(): Invalid state %s\n",
763                                 tcp_states[conn->tcp_state] );
764                 rc = -EINVAL;
765                 goto done;
766         case TCP_LISTEN:
767                 if ( tcphdr->flags & TCP_SYN ) {
768                         tcp_trans ( conn, TCP_SYN_RCVD );
769                         /* Synchronize the sequence numbers */
770                         conn->rcv_nxt = ntohl ( tcphdr->seq ) + 1;
771                         conn->tcp_flags |= TCP_ACK;
772
773                         /* Set the sequence number for the snd stream */
774                         conn->snd_una = random();
775                         conn->tcp_flags |= TCP_SYN;
776
777                         /* Send a SYN,ACK packet */
778                         goto send_tcp_nomsg;
779                 }
780                 /* Unexpected packet */
781                 goto unexpected;
782         case TCP_SYN_SENT:
783                 if ( tcphdr->flags & TCP_SYN ) {
784                         /* Synchronize the sequence number in rcv stream */
785                         conn->rcv_nxt = ntohl ( tcphdr->seq ) + 1;
786                         conn->tcp_flags |= TCP_ACK;
787
788                         if ( tcphdr->flags & TCP_ACK ) {
789                                 tcp_trans ( conn, TCP_ESTABLISHED );
790                                 /**
791                                  * Process ACK of SYN. This does not invoke the
792                                  * acked() callback function.
793                                  */
794                                 conn->snd_una = ntohl ( tcphdr->ack );
795                                 conn->tcp_op->connected ( conn );
796                                 conn->tcp_flags |= TCP_ACK;
797                                 tcp_senddata ( conn );
798                                 rc = 0;
799                                 goto done;
800                         } else {
801                                 tcp_trans ( conn, TCP_SYN_RCVD );
802                                 conn->tcp_flags |= TCP_SYN;
803                                 goto send_tcp_nomsg;
804                         }
805                 }
806                 /* Unexpected packet */
807                 goto unexpected;
808         case TCP_SYN_RCVD:
809                 if ( tcphdr->flags & TCP_RST ) {
810                         tcp_trans ( conn, TCP_LISTEN );
811                         conn->tcp_op->closed ( conn, CONN_RESTART );
812                         rc = 0;
813                         goto done;
814                 }
815                 if ( tcphdr->flags & TCP_ACK ) {
816                         tcp_trans ( conn, TCP_ESTABLISHED );
817                         /**
818                          * Process ACK of SYN. It neither invokes the callback
819                          * function nor does it send an ACK.
820                          */
821                         conn->snd_una = tcphdr->ack - 1;
822                         conn->tcp_op->connected ( conn );
823                         rc = 0;
824                         goto done;
825                 }
826                 /* Unexpected packet */
827                 goto unexpected;
828         case TCP_ESTABLISHED:
829 #if 0
830                 if ( tcphdr->flags & TCP_FIN ) {
831                         tcp_trans ( conn, TCP_CLOSE_WAIT );
832                         /* FIN consumes one byte */
833                         conn->rcv_nxt++;
834                         conn->tcp_flags |= TCP_ACK;
835                         /* Send an acknowledgement */
836                         goto send_tcp_nomsg;
837                 }
838 #endif
839                 /* Packet might contain data */
840                 break;
841         case TCP_FIN_WAIT_1:
842                 if ( tcphdr->flags & TCP_FIN ) {
843                         conn->rcv_nxt++;
844                         conn->tcp_flags |= TCP_ACK;
845                         conn->tcp_op->closed ( conn, CONN_SNDCLOSE );
846
847                         if ( tcphdr->flags & TCP_ACK ) {
848                                 tcp_trans ( conn, TCP_TIME_WAIT );
849                         } else {
850                                 tcp_trans ( conn, TCP_CLOSING );
851                         }
852                         /* Send an acknowledgement */
853                         goto send_tcp_nomsg;
854                 }
855                 if ( tcphdr->flags & TCP_ACK ) {
856                         tcp_trans ( conn, TCP_FIN_WAIT_2 );
857                 }
858                 /* Packet might contain data */
859                 break;
860         case TCP_FIN_WAIT_2:
861                 if ( tcphdr->flags & TCP_FIN ) {
862                         tcp_trans ( conn, TCP_TIME_WAIT );
863                         /* FIN consumes one byte */
864                         conn->rcv_nxt++;
865                         conn->tcp_flags |= TCP_ACK;
866                         goto send_tcp_nomsg;
867                 }
868                 /* Packet might contain data */
869                 break;
870         case TCP_CLOSING:
871                 if ( tcphdr->flags & TCP_ACK ) {
872                         tcp_trans ( conn, TCP_TIME_WAIT );
873                         start_timer ( &conn->timer );
874                         rc = 0;
875                         goto done;
876                 }
877                 /* Unexpected packet */
878                 goto unexpected;
879         case TCP_TIME_WAIT:
880                 /* Unexpected packet */
881                 goto unexpected;
882         case TCP_CLOSE_WAIT:
883                 /* Packet could acknowledge data */
884                 break;
885         case TCP_LAST_ACK:
886                 if ( tcphdr->flags & TCP_ACK ) {
887                         tcp_trans ( conn, TCP_CLOSED );
888                         rc = 0;
889                         goto done;
890                 }
891                 /* Unexpected packet */
892                 goto unexpected;
893         }
894
895         /**
896          * Any packet reaching this point either contains new data or
897          * acknowledges previously transmitted data.
898          */
899         assert ( ( tcphdr->flags & TCP_ACK ) ||
900                  pkb_len ( pkb ) > sizeof ( *tcphdr ) );
901
902         /* Check for new data */
903         toack = pkb_len ( pkb ) - hlen;
904         if ( toack > 0 ) {
905                 /* Check if expected sequence number */
906                 if ( conn->rcv_nxt == ntohl ( tcphdr->seq ) ) {
907                         conn->rcv_nxt += toack;
908                         conn->tcp_op->newdata ( conn, pkb->data + hlen,
909                                                 toack );
910                 } else {
911                         DBG ( "Unexpected sequence number %lx (wanted %lx)\n", 
912                               ntohl ( tcphdr->seq ), conn->rcv_nxt );
913                 }
914
915                 /* Send an ACK only if required to */
916                 if ( conn->rcv_nxt <= ntohl ( tcphdr->seq ) ) {
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
925         /* Process ACK */
926         if ( tcphdr->flags & TCP_ACK ) {
927                 acked = ntohl ( tcphdr->ack ) - conn->snd_una;
928                 if ( acked < 0 ) { /* TODO: Replace all uint32_t arith */
929                         DBG ( "Previously ACKed (%d)\n", tcphdr->ack );
930                         rc = 0;
931                         goto done;
932                 }
933                 /* Advance snd stream */
934                 conn->snd_una += acked;
935                 /* Invoke the acked() callback function */
936                 conn->tcp_op->acked ( conn, acked );
937                 /* Invoke the senddata() callback function */
938                 tcp_senddata ( conn );
939         }
940
941         /* If the connection is in ESTABLISHED and it receives a FIN */
942         if ( conn->tcp_state == ESTABLISHED && ( tcphdr->flags & TCP_FIN ) ) {
943                 if ( tcphdr->flags & TCP_ACK ) {
944                         tcp_trans ( conn, TCP_LAST_ACK );
945                         goto send_tcp_nomsg;
946                 }
947                 tcp_trans ( conn, TCP_CLOSE_WAIT );
948 //              conn->tcp_op->closed ( conn, CONN_SNDCLOSE );   
949                 conn->rcv_nxt++;
950                 if ( ! ( tcphdr->flags & TCP_ACK ) ) {
951                         conn->tcp_flags |= TCP_ACK;
952                         /* Send an acknowledgement */
953                         goto send_tcp_nomsg;
954                 }
955                 /* Otherwise, the packet has been ACKed already */
956         }
957         rc = 0;
958         goto done;
959
960   send_tcp_nomsg:
961         free_pkb ( conn->tx_pkb );
962         conn->tx_pkb = alloc_pkb ( MIN_PKB_LEN );
963         pkb_reserve ( conn->tx_pkb, MAX_HDR_LEN );
964         if ( ( rc = tcp_send ( conn, TCP_NOMSG, TCP_NOMSG_LEN ) ) != 0 ) {
965                 DBG ( "Error sending TCP message (rc = %d)\n", rc );
966         }
967         goto done;
968
969   unexpected:
970         DBG ( "Unexpected packet received in %s with flags = %#hx\n",
971                         tcp_states[conn->tcp_state], tcphdr->flags & TCP_MASK_FLAGS );
972         tcp_close ( conn );
973         free_pkb ( conn->tx_pkb );
974         conn->tx_pkb = NULL;
975         rc = -EINVAL;
976         goto done;
977
978  done:
979         free_pkb ( pkb );
980         return rc;
981 }
982
983 /** TCP protocol */
984 struct tcpip_protocol tcp_protocol __tcpip_protocol = {
985         .name = "TCP",
986         .rx = tcp_rx,
987         .tcpip_proto = IP_TCP,
988         .csum_offset = 16,
989 };
990
991 #endif /* USE_UIP */