Verify checksums on the RX datapath.
[gpxe.git] / src / net / tcp.c
1 #include <string.h>
2 #include <stdlib.h>
3 #include <assert.h>
4 #include <errno.h>
5 #include <byteswap.h>
6 #include <timer.h>
7 #include <vsprintf.h>
8 #include <gpxe/pkbuff.h>
9 #include <gpxe/retry.h>
10 #include <gpxe/tcpip.h>
11 #include <gpxe/tcp.h>
12
13 /** @file
14  *
15  * TCP protocol
16  *
17  */
18
19 static void tcp_expired ( struct retry_timer *timer, int over );
20
21 /**
22  * A TCP connection
23  *
24  * This data structure represents the internal state of a TCP
25  * connection.  It is kept separate from @c struct @c tcp_application
26  * because the internal state is still required for some time after
27  * the application closes the connection.
28  */
29 struct tcp_connection {
30         /** List of TCP connections */
31         struct list_head list;
32         /** The associated TCP application, if any */
33         struct tcp_application *app;
34
35         /** Remote socket address */
36         struct sockaddr_tcpip peer;
37         /** Local port, in network byte order */
38         uint16_t local_port;
39
40         /** Current TCP state */
41         unsigned int tcp_state;
42         /** Previous TCP state
43          *
44          * Maintained only for debug messages
45          */
46         unsigned int prev_tcp_state;
47         /** Current sequence number
48          *
49          * Equivalent to SND.UNA in RFC 793 terminology.
50          */
51         uint32_t snd_seq;
52         /** Unacknowledged sequence count
53          *
54          * Equivalent to (SND.NXT-SND.UNA) in RFC 793 terminology.
55          */
56         uint32_t snd_sent;
57         /** Send window
58          *
59          * Equivalent to SND.WND in RFC 793 terminology
60          */
61         uint32_t snd_win;
62         /** Current acknowledgement number
63          *
64          * Equivalent to RCV.NXT in RFC 793 terminology.
65          */
66         uint32_t rcv_ack;
67
68         /** Transmit packet buffer
69          *
70          * This buffer is allocated prior to calling the application's
71          * senddata() method, to provide temporary storage space.
72          */
73         struct pk_buff *tx_pkb;
74         /** Retransmission timer */
75         struct retry_timer timer;
76 };
77
78 /**
79  * List of registered TCP connections
80  */
81 static LIST_HEAD ( tcp_conns );
82
83 /**
84  * Name TCP state
85  *
86  * @v state             TCP state
87  * @ret name            Name of TCP state
88  */
89 static inline __attribute__ (( always_inline )) const char *
90 tcp_state ( int state ) {
91         switch ( state ) {
92         case TCP_CLOSED:                return "CLOSED";
93         case TCP_LISTEN:                return "LISTEN";
94         case TCP_SYN_SENT:              return "SYN_SENT";
95         case TCP_SYN_RCVD:              return "SYN_RCVD";
96         case TCP_ESTABLISHED:           return "ESTABLISHED";
97         case TCP_FIN_WAIT_1:            return "FIN_WAIT_1";
98         case TCP_FIN_WAIT_2:            return "FIN_WAIT_2";
99         case TCP_CLOSING_OR_LAST_ACK:   return "CLOSING/LAST_ACK";
100         case TCP_TIME_WAIT:             return "TIME_WAIT";
101         case TCP_CLOSE_WAIT:            return "CLOSE_WAIT";
102         default:                        return "INVALID";
103         }
104 }
105
106 /**
107  * Dump TCP state transition
108  *
109  * @v conn              TCP connection
110  */
111 static inline __attribute__ (( always_inline )) void
112 tcp_dump_state ( struct tcp_connection *conn ) {
113
114         if ( conn->tcp_state != conn->prev_tcp_state ) {
115                 DBGC ( conn, "TCP %p transitioned from %s to %s\n", conn,
116                        tcp_state ( conn->prev_tcp_state ),
117                        tcp_state ( conn->tcp_state ) );
118         }
119         conn->prev_tcp_state = conn->tcp_state;
120 }
121
122 /**
123  * Dump TCP flags
124  *
125  * @v flags             TCP flags
126  */
127 static inline __attribute__ (( always_inline )) void
128 tcp_dump_flags ( struct tcp_connection *conn, unsigned int flags ) {
129         if ( flags & TCP_RST )
130                 DBGC ( conn, " RST" );
131         if ( flags & TCP_SYN )
132                 DBGC ( conn, " SYN" );
133         if ( flags & TCP_PSH )
134                 DBGC ( conn, " PSH" );
135         if ( flags & TCP_FIN )
136                 DBGC ( conn, " FIN" );
137         if ( flags & TCP_ACK )
138                 DBGC ( conn, " ACK" );
139 }
140
141 /**
142  * Allocate TCP connection
143  *
144  * @ret conn            TCP connection, or NULL
145  *
146  * Allocates TCP connection and adds it to the TCP connection list.
147  */
148 static struct tcp_connection * alloc_tcp ( void ) {
149         struct tcp_connection *conn;
150
151         conn = calloc ( 1, sizeof ( *conn ) );
152         if ( conn ) {
153                 DBGC ( conn, "TCP %p allocated\n", conn );
154                 conn->tcp_state = conn->prev_tcp_state = TCP_CLOSED;
155                 conn->snd_seq = random();
156                 conn->timer.expired = tcp_expired;
157                 list_add ( &conn->list, &tcp_conns );
158         }
159         return conn;
160 }
161
162 /**
163  * Free TCP connection
164  *
165  * @v conn              TCP connection
166  *
167  * Removes connection from TCP connection list and frees the data
168  * structure.
169  */
170 static void free_tcp ( struct tcp_connection *conn ) {
171
172         assert ( conn );
173         assert ( conn->tcp_state == TCP_CLOSED );
174         assert ( conn->app == NULL );
175
176         stop_timer ( &conn->timer );
177         list_del ( &conn->list );
178         free ( conn );
179         DBGC ( conn, "TCP %p freed\n", conn );
180 }
181
182 /**
183  * Associate TCP connection with application
184  *
185  * @v conn              TCP connection
186  * @v app               TCP application
187  */
188 static void tcp_associate ( struct tcp_connection *conn,
189                             struct tcp_application *app ) {
190         assert ( conn->app == NULL );
191         assert ( app->conn == NULL );
192         conn->app = app;
193         app->conn = conn;
194         DBGC ( conn, "TCP %p associated with application %p\n", conn, app );
195 }
196
197 /**
198  * Disassociate TCP connection from application
199  *
200  * @v conn              TCP connection
201  */
202 static void tcp_disassociate ( struct tcp_connection *conn ) {
203         struct tcp_application *app = conn->app;
204
205         if ( app ) {
206                 assert ( app->conn == conn );
207                 conn->app = NULL;
208                 app->conn = NULL;
209                 DBGC ( conn, "TCP %p disassociated from application %p\n",
210                        conn, app );
211         }
212 }
213
214 /**
215  * Transmit any outstanding data
216  *
217  * @v conn              TCP connection
218  * @v force_send        Force sending of packet
219  * 
220  * Transmits any outstanding data on the connection.  If the
221  * connection is in a connected state, the application's senddata()
222  * method will be called to generate the data payload, if any.
223  *
224  * Note that even if an error is returned, the retransmission timer
225  * will have been started if necessary, and so the stack will
226  * eventually attempt to retransmit the failed packet.
227  */
228 static int tcp_senddata_conn ( struct tcp_connection *conn, int force_send ) {
229         struct tcp_application *app = conn->app;
230         struct pk_buff *pkb;
231         struct tcp_header *tcphdr;
232         unsigned int flags;
233         size_t len;
234         size_t seq_len;
235
236         /* Allocate space to the TX buffer */
237         pkb = alloc_pkb ( MAX_PKB_LEN );
238         if ( ! pkb ) {
239                 DBGC ( conn, "TCP %p could not allocate data buffer\n", conn );
240                 /* Start the retry timer so that we attempt to
241                  * retransmit this packet later.  (Start it
242                  * unconditionally, since without a packet buffer we
243                  * can't call the senddata() callback, and so may not
244                  * be able to tell whether or not we have something
245                  * that actually needs to be retransmitted).
246                  */
247                 start_timer ( &conn->timer );
248                 return -ENOMEM;
249         }
250         pkb_reserve ( pkb, MAX_HDR_LEN );
251
252         /* If we are connected, call the senddata() method, which may
253          * call tcp_send() to queue up a data payload.
254          */
255         if ( TCP_CAN_SEND_DATA ( conn->tcp_state ) &&
256              app && app->tcp_op->senddata ) {
257                 conn->tx_pkb = pkb;
258                 app->tcp_op->senddata ( app, pkb->data, pkb_available ( pkb ));
259                 conn->tx_pkb = NULL;
260         }
261
262         /* Truncate payload length to fit transmit window */
263         len = pkb_len ( pkb );
264         if ( len > conn->snd_win )
265                 len = conn->snd_win;
266
267         /* Calculate amount of sequence space that this transmission
268          * consumes.  (SYN or FIN consume one byte, and we can never
269          * send both at once).
270          */
271         seq_len = len;
272         flags = TCP_FLAGS_SENDING ( conn->tcp_state );
273         assert ( ! ( ( flags & TCP_SYN ) && ( flags & TCP_FIN ) ) );
274         if ( flags & ( TCP_SYN | TCP_FIN ) )
275                 seq_len++;
276         conn->snd_sent = seq_len;
277
278         /* If we have nothing to transmit, drop the packet */
279         if ( ( seq_len == 0 ) && ! force_send ) {
280                 free_pkb ( pkb );
281                 return 0;
282         }
283
284         /* If we are transmitting anything that requires
285          * acknowledgement (i.e. consumes sequence space), start the
286          * retransmission timer.
287          */
288         if ( seq_len )
289                 start_timer ( &conn->timer );
290
291         /* Fill up the TCP header */
292         tcphdr = pkb_push ( pkb, sizeof ( *tcphdr ) );
293         memset ( tcphdr, 0, sizeof ( *tcphdr ) );
294         tcphdr->src = conn->local_port;
295         tcphdr->dest = conn->peer.st_port;
296         tcphdr->seq = htonl ( conn->snd_seq );
297         tcphdr->ack = htonl ( conn->rcv_ack );
298         tcphdr->hlen = ( ( sizeof ( *tcphdr ) / 4 ) << 4 );
299         tcphdr->flags = flags;
300         tcphdr->win = htons ( TCP_WINDOW_SIZE );
301         tcphdr->csum = tcpip_chksum ( pkb->data, pkb_len ( pkb ) );
302
303         /* Dump header */
304         DBGC ( conn, "TCP %p TX %d->%d %08lx..%08lx           %08lx %4zd",
305                conn, ntohs ( tcphdr->src ), ntohs ( tcphdr->dest ),
306                ntohl ( tcphdr->seq ), ( ntohl ( tcphdr->seq ) + seq_len ),
307                ntohl ( tcphdr->ack ), len );
308         tcp_dump_flags ( conn, tcphdr->flags );
309         DBGC ( conn, "\n" );
310
311         /* Transmit packet */
312         return tcpip_tx ( pkb, &tcp_protocol, &conn->peer, &tcphdr->csum );
313 }
314
315 /**
316  * Transmit any outstanding data
317  *
318  * @v conn      TCP connection
319  * 
320  * This function allocates space to the transmit buffer and invokes
321  * the senddata() callback function, to allow the application to
322  * transmit new data.
323  */
324 int tcp_senddata ( struct tcp_application *app ) {
325         struct tcp_connection *conn = app->conn;
326
327         /* Check connection actually exists */
328         if ( ! conn ) {
329                 DBG ( "TCP app %p has no connection\n", app );
330                 return -ENOTCONN;
331         }
332
333         return tcp_senddata_conn ( conn, 0 );
334 }
335
336 /**
337  * Transmit data
338  *
339  * @v app               TCP application
340  * @v data              Data to be sent
341  * @v len               Length of the data
342  * @ret rc              Return status code
343  *
344  * This function queues data to be sent via the TCP connection.  It
345  * can be called only in the context of an application's senddata()
346  * method.
347  */
348 int tcp_send ( struct tcp_application *app, const void *data, size_t len ) {
349         struct tcp_connection *conn = app->conn;
350         struct pk_buff *pkb;
351
352         /* Check connection actually exists */
353         if ( ! conn ) {
354                 DBG ( "TCP app %p has no connection\n", app );
355                 return -ENOTCONN;
356         }
357
358         /* Check that we have a packet buffer to fill */
359         pkb = conn->tx_pkb;
360         if ( ! pkb ) {
361                 DBG ( "TCP app %p tried to send data outside of the "
362                       "senddata() method\n", app );
363                 return -EINVAL;
364         }
365
366         /* Truncate length to fit packet buffer */
367         if ( len > pkb_available ( pkb ) )
368                 len = pkb_available ( pkb );
369
370         /* Copy payload */
371         memmove ( pkb_put ( pkb, len ), data, len );
372
373         return 0;
374 }
375
376 /**
377  * Retransmission timer expired
378  *
379  * @v timer     Retry timer
380  * @v over      Failure indicator
381  */
382 static void tcp_expired ( struct retry_timer *timer, int over ) {
383         struct tcp_connection *conn =
384                 container_of ( timer, struct tcp_connection, timer );
385         struct tcp_application *app = conn->app;
386         int graceful_close = TCP_CLOSED_GRACEFULLY ( conn->tcp_state );
387
388         DBGC ( conn, "TCP %p timer %s in %s\n", conn,
389                ( over ? "expired" : "fired" ), tcp_state ( conn->tcp_state ) );
390
391         assert ( ( conn->tcp_state == TCP_SYN_SENT ) ||
392                  ( conn->tcp_state == TCP_SYN_RCVD ) ||
393                  ( conn->tcp_state == TCP_ESTABLISHED ) ||
394                  ( conn->tcp_state == TCP_FIN_WAIT_1 ) ||
395                  ( conn->tcp_state == TCP_TIME_WAIT ) ||
396                  ( conn->tcp_state == TCP_CLOSE_WAIT ) ||
397                  ( conn->tcp_state == TCP_CLOSING_OR_LAST_ACK ) );
398
399         /* If we have finally timed out and given up, or if this is
400          * the result of a graceful close, terminate the connection
401          */
402         if ( over || graceful_close ) {
403
404                 /* Transition to CLOSED */
405                 conn->tcp_state = TCP_CLOSED;
406                 tcp_dump_state ( conn );
407
408                 /* If we haven't closed gracefully, send a RST */
409                 if ( ! graceful_close )
410                         tcp_senddata_conn ( conn, 1 );
411
412                 /* Break association between application and connection */
413                 tcp_disassociate ( conn );
414
415                 /* Free the connection */
416                 free_tcp ( conn );
417
418                 /* Notify application */
419                 if ( app && app->tcp_op->closed )
420                         app->tcp_op->closed ( app, -ETIMEDOUT );
421
422         } else {
423                 /* Otherwise, retransmit the packet */
424                 tcp_senddata_conn ( conn, 0 );
425         }
426 }
427
428 /**
429  * Identify TCP connection by local port number
430  *
431  * @v local_port        Local port (in network-endian order)
432  * @ret conn            TCP connection, or NULL
433  */
434 static struct tcp_connection * tcp_demux ( uint16_t local_port ) {
435         struct tcp_connection *conn;
436
437         list_for_each_entry ( conn, &tcp_conns, list ) {
438                 if ( conn->local_port == local_port )
439                         return conn;
440         }
441         return NULL;
442 }
443
444 /**
445  * Handle TCP received SYN
446  *
447  * @v conn              TCP connection
448  * @v seq               SEQ value (in host-endian order)
449  * @ret rc              Return status code
450  */
451 static int tcp_rx_syn ( struct tcp_connection *conn, uint32_t seq ) {
452
453         /* Synchronise sequence numbers on first SYN */
454         if ( ! ( conn->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) )
455                 conn->rcv_ack = seq;
456
457         /* Ignore duplicate SYN */
458         if ( ( conn->rcv_ack - seq ) > 0 )
459                 return 0;
460
461         /* Mark SYN as received and start sending ACKs with each packet */
462         conn->tcp_state |= ( TCP_STATE_SENT ( TCP_ACK ) |
463                              TCP_STATE_RCVD ( TCP_SYN ) );
464
465         /* Acknowledge SYN */
466         conn->rcv_ack++;
467
468         return 0;
469 }
470
471 /**
472  * Handle TCP received ACK
473  *
474  * @v conn              TCP connection
475  * @v ack               ACK value (in host-endian order)
476  * @v win               WIN value (in host-endian order)
477  * @ret rc              Return status code
478  */
479 static int tcp_rx_ack ( struct tcp_connection *conn, uint32_t ack,
480                         uint32_t win ) {
481         struct tcp_application *app = conn->app;
482         size_t ack_len = ( ack - conn->snd_seq );
483         size_t len;
484         unsigned int acked_flags = 0;
485
486         /* Ignore duplicate or out-of-range ACK */
487         if ( ack_len > conn->snd_sent ) {
488                 DBGC ( conn, "TCP %p received ACK for [%08lx,%08lx), "
489                        "sent only [%08lx,%08lx)\n", conn, conn->snd_seq,
490                        ( conn->snd_seq + ack_len ), conn->snd_seq,
491                        ( conn->snd_seq + conn->snd_sent ) );
492                 return -EINVAL;
493         }
494
495         /* If we are sending flags and this ACK acknowledges all
496          * outstanding sequence points, then it acknowledges the
497          * flags.  (This works since both SYN and FIN will always be
498          * the last outstanding sequence point.)
499          */
500         len = ack_len;
501         if ( ack_len == conn->snd_sent ) {
502                 acked_flags = ( TCP_FLAGS_SENDING ( conn->tcp_state ) &
503                                 ( TCP_SYN | TCP_FIN ) );
504                 if ( acked_flags )
505                         len--;
506         }
507
508         /* Update SEQ and sent counters, and window size */
509         conn->snd_seq = ack;
510         conn->snd_sent = 0;
511         conn->snd_win = win;
512
513         /* Stop the retransmission timer */
514         stop_timer ( &conn->timer );
515
516         /* Notify application of acknowledged data, if any */
517         if ( len && app && app->tcp_op->acked )
518                 app->tcp_op->acked ( app, len );
519
520         /* Mark SYN/FIN as acknowledged if applicable. */
521         if ( acked_flags )
522                 conn->tcp_state |= TCP_STATE_ACKED ( acked_flags );
523
524         /* Notify application of established connection, if applicable */
525         if ( ( acked_flags & TCP_SYN ) && app && app->tcp_op->connected )
526                 app->tcp_op->connected ( app );
527
528         return 0;
529 }
530
531 /**
532  * Handle TCP received data
533  *
534  * @v conn              TCP connection
535  * @v seq               SEQ value (in host-endian order)
536  * @v data              Data buffer
537  * @v len               Length of data buffer
538  * @ret rc              Return status code
539  */
540 static int tcp_rx_data ( struct tcp_connection *conn, uint32_t seq,
541                          void *data, size_t len ) {
542         struct tcp_application *app = conn->app;
543         size_t already_rcvd;
544
545         /* Ignore duplicate data */
546         already_rcvd = ( conn->rcv_ack - seq );
547         if ( already_rcvd >= len )
548                 return 0;
549         data += already_rcvd;
550         len -= already_rcvd;
551
552         /* Acknowledge new data */
553         conn->rcv_ack += len;
554
555         /* Notify application */
556         if ( app && app->tcp_op->newdata )
557                 app->tcp_op->newdata ( app, data, len );
558
559         return 0;
560 }
561
562 /** Handle TCP received FIN
563  *
564  * @v conn              TCP connection
565  * @v seq               SEQ value (in host-endian order)
566  * @ret rc              Return status code
567  */
568 static int tcp_rx_fin ( struct tcp_connection *conn, uint32_t seq ) {
569         struct tcp_application *app = conn->app;
570
571         /* Ignore duplicate FIN */
572         if ( ( conn->rcv_ack - seq ) > 0 )
573                 return 0;
574
575         /* Mark FIN as received, acknowledge it, and send our own FIN */
576         conn->tcp_state |= ( TCP_STATE_RCVD ( TCP_FIN ) |
577                              TCP_STATE_SENT ( TCP_FIN ) );
578         conn->rcv_ack++;
579
580         /* Break association with application */
581         tcp_disassociate ( conn );
582
583         /* Notify application */
584         if ( app && app->tcp_op->closed )
585                 app->tcp_op->closed ( app, 0 );
586
587         return 0;
588 }
589
590 /**
591  * Process received packet
592  *
593  * @v pkb               Packet buffer
594  * @v st_src            Partially-filled source address
595  * @v st_dest           Partially-filled destination address
596  * @v pshdr_csum        Pseudo-header checksum
597  * @ret rc              Return status code
598   */
599 static int tcp_rx ( struct pk_buff *pkb,
600                     struct sockaddr_tcpip *st_src __unused,
601                     struct sockaddr_tcpip *st_dest __unused,
602                     uint16_t pshdr_csum ) {
603         struct tcp_header *tcphdr;
604         struct tcp_connection *conn;
605         unsigned int hlen;
606         uint16_t csum;
607         uint32_t start_seq;
608         uint32_t seq;
609         uint32_t ack;
610         uint32_t win;
611         unsigned int flags;
612         void *data;
613         size_t len;
614         int rc = 0;
615
616         /* Sanity check packet */
617         if ( pkb_len ( pkb ) < sizeof ( *tcphdr ) ) {
618                 DBG ( "TCP packet too short at %d bytes (min %d bytes)\n",
619                       pkb_len ( pkb ), sizeof ( *tcphdr ) );
620                 rc = -EINVAL;
621                 goto err;
622         }
623         tcphdr = pkb->data;
624         hlen = ( ( tcphdr->hlen & TCP_MASK_HLEN ) / 16 ) * 4;
625         if ( hlen < sizeof ( *tcphdr ) ) {
626                 DBG ( "TCP header too short at %d bytes (min %d bytes)\n",
627                       hlen, sizeof ( *tcphdr ) );
628                 rc = -EINVAL;
629                 goto err;
630         }
631         if ( hlen > pkb_len ( pkb ) ) {
632                 DBG ( "TCP header too long at %d bytes (max %d bytes)\n",
633                       hlen, pkb_len ( pkb ) );
634                 rc = -EINVAL;
635                 goto err;
636         }
637         csum = tcpip_continue_chksum ( pshdr_csum, pkb->data, pkb_len ( pkb ));
638         if ( csum != 0 ) {
639                 DBG ( "TCP checksum incorrect (is %04x including checksum "
640                       "field, should be 0000)\n", csum );
641                 goto err;
642         }
643         
644         /* Parse parameters from header and strip header */
645         conn = tcp_demux ( tcphdr->dest );
646         start_seq = seq = ntohl ( tcphdr->seq );
647         ack = ntohl ( tcphdr->ack );
648         win = ntohs ( tcphdr->win );
649         flags = tcphdr->flags;
650         data = pkb_pull ( pkb, hlen );
651         len = pkb_len ( pkb );
652
653         /* Dump header */
654         DBGC ( conn, "TCP %p RX %d<-%d           %08lx %08lx..%08lx %4zd",
655                conn, ntohs ( tcphdr->dest ), ntohs ( tcphdr->src ),
656                ntohl ( tcphdr->ack ), ntohl ( tcphdr->seq ),
657                ( ntohl ( tcphdr->seq ) + len +
658                  ( ( tcphdr->flags & ( TCP_SYN | TCP_FIN ) ) ? 1 : 0 ) ), len);
659         tcp_dump_flags ( conn, tcphdr->flags );
660         DBGC ( conn, "\n" );
661
662         /* If no connection was found, create dummy connection for
663          * sending RST
664          */
665 #warning "Handle non-matched connections"
666         if ( ! conn )
667                 goto err;
668
669         /* Handle RST, if present */
670 #warning "Handle RST"
671         if ( flags & TCP_RST )
672                 goto err;
673
674         /* Handle ACK, if present */
675         if ( flags & TCP_ACK )
676                 tcp_rx_ack ( conn, ack, win );
677
678         /* Handle SYN, if present */
679         if ( flags & TCP_SYN ) {
680                 tcp_rx_syn ( conn, seq );
681                 seq++;
682         }
683
684         /* Handle new data, if any */
685         tcp_rx_data ( conn, seq, data, len );
686         seq += len;
687
688         /* Handle FIN, if present */
689         if ( flags & TCP_FIN ) {
690                 tcp_rx_fin ( conn, seq );
691                 seq++;
692         }
693
694         /* Dump out any state change as a result of SYN, FIN or ACK */
695         tcp_dump_state ( conn );
696
697         /* Send out any pending data.  If peer is expecting an ACK for
698          * this packet then force sending a reply.
699          */
700         tcp_senddata_conn ( conn, ( start_seq != seq ) );
701
702         /* If this packet was the last we expect to receive, set up
703          * timer to expire and cause the connection to be freed.
704          */
705         if ( TCP_CLOSED_GRACEFULLY ( conn->tcp_state ) ) {
706                 conn->timer.timeout = ( 2 * TCP_MSL );
707                 start_timer ( &conn->timer );
708         }
709
710  err:
711         /* Free received packet */
712         free_pkb ( pkb );
713         return rc;
714 }
715
716 /**
717  * Bind TCP connection to local port
718  *
719  * @v conn              TCP connection
720  * @v local_port        Local port (in network byte order), or 0
721  * @ret rc              Return status code
722  *
723  * This function adds the connection to the list of registered TCP
724  * connections.  If the local port is 0, the connection is assigned an
725  * available port between 1024 and 65535.
726  */
727 static int tcp_bind ( struct tcp_connection *conn, uint16_t local_port ) {
728         struct tcp_connection *existing;
729         static uint16_t try_port = 1024;
730
731 #warning "Fix the port re-use bug"
732         try_port = random();
733
734         /* If no port specified, find the first available port */
735         if ( ! local_port ) {
736                 for ( ; try_port ; try_port++ ) {
737                         if ( try_port < 1024 )
738                                 continue;
739                         if ( tcp_bind ( conn, htons ( try_port ) ) == 0 )
740                                 return 0;
741                 }
742                 DBGC ( conn, "TCP %p could not bind: no free ports\n", conn );
743                 return -EADDRINUSE;
744         }
745
746         /* Attempt bind to local port */
747         list_for_each_entry ( existing, &tcp_conns, list ) {
748                 if ( existing->local_port == local_port ) {
749                         DBGC ( conn, "TCP %p could not bind: port %d in use\n",
750                                conn, ntohs ( local_port ) );
751                         return -EADDRINUSE;
752                 }
753         }
754         conn->local_port = local_port;
755
756         DBGC ( conn, "TCP %p bound to port %d\n", conn, ntohs ( local_port ) );
757         return 0;
758 }
759
760 /**
761  * Connect to a remote server
762  *
763  * @v app               TCP application
764  * @v peer              Remote socket address
765  * @v local_port        Local port number (in network byte order), or 0
766  * @ret rc              Return status code
767  *
768  * This function initiates a TCP connection to the socket address specified in
769  * peer. It sends a SYN packet to peer. When the connection is established, the
770  * TCP stack calls the connected() callback function.
771  */
772 int tcp_connect ( struct tcp_application *app, struct sockaddr_tcpip *peer,
773                   uint16_t local_port ) {
774         struct tcp_connection *conn;
775         int rc;
776
777         /* Application must not already have an open connection */
778         if ( app->conn ) {
779                 DBG ( "TCP app %p already open on %p\n", app, app->conn );
780                 return -EISCONN;
781         }
782
783         /* Allocate connection state storage and add to connection list */
784         conn = alloc_tcp();
785         if ( ! conn ) {
786                 DBG ( "TCP app %p could not allocate connection\n", app );
787                 return -ENOMEM;
788         }
789
790         /* Bind to peer and to local port */
791         memcpy ( &conn->peer, peer, sizeof ( conn->peer ) );
792         if ( ( rc = tcp_bind ( conn, local_port ) ) != 0 ) {
793                 free_tcp ( conn );
794                 return rc;
795         }
796
797         /* Associate with application */
798         tcp_associate ( conn, app );
799
800         /* Transition to TCP_SYN_SENT and send the SYN */
801         conn->tcp_state = TCP_SYN_SENT;
802         tcp_dump_state ( conn );
803         tcp_senddata_conn ( conn, 0 );
804
805         return 0;
806 }
807
808 /**
809  * Close the connection
810  *
811  * @v app               TCP application
812  *
813  * The association between the application and the TCP connection is
814  * immediately severed, and the TCP application data structure can be
815  * reused or freed immediately.  The TCP connection will persist until
816  * the state machine has returned to the TCP_CLOSED state.
817  */
818 void tcp_close ( struct tcp_application *app ) {
819         struct tcp_connection *conn = app->conn;
820
821         /* If no connection exists, do nothing */
822         if ( ! conn )
823                 return;
824
825         /* Break association between application and connection */
826         tcp_disassociate ( conn );
827
828         /* If we have not yet received a SYN (i.e. we are in CLOSED,
829          * LISTEN or SYN_SENT), just delete the connection
830          */
831         if ( ! ( conn->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) ) {
832                 conn->tcp_state = TCP_CLOSED;
833                 tcp_dump_state ( conn );
834                 free_tcp ( conn );
835                 return;
836         }
837
838         /* If we have not had our SYN acknowledged (i.e. we are in
839          * SYN_RCVD), pretend that it has been acknowledged so that we
840          * can send a FIN without breaking things.
841          */
842         if ( ! ( conn->tcp_state & TCP_STATE_ACKED ( TCP_SYN ) ) )
843                 tcp_rx_ack ( conn, ( conn->snd_seq + 1 ), 0 );
844
845         /* Send a FIN to initiate the close */
846         conn->tcp_state |= TCP_STATE_SENT ( TCP_FIN );
847         tcp_dump_state ( conn );
848         tcp_senddata_conn ( conn, 0 );
849 }
850
851 /** TCP protocol */
852 struct tcpip_protocol tcp_protocol __tcpip_protocol = {
853         .name = "TCP",
854         .rx = tcp_rx,
855         .tcpip_proto = IP_TCP,
856 };