97d9dea17764db5e4d04b0581677d0c161f3c5c4
[people/indolent/gpxe.git/.git] / src / net / tcp.c
1 #include <string.h>
2 #include <stdlib.h>
3 #include <stdio.h>
4 #include <assert.h>
5 #include <errno.h>
6 #include <byteswap.h>
7 #include <timer.h>
8 #include <gpxe/iobuf.h>
9 #include <gpxe/malloc.h>
10 #include <gpxe/retry.h>
11 #include <gpxe/refcnt.h>
12 #include <gpxe/xfer.h>
13 #include <gpxe/open.h>
14 #include <gpxe/uri.h>
15 #include <gpxe/tcpip.h>
16 #include <gpxe/tcp.h>
17
18 /** @file
19  *
20  * TCP protocol
21  *
22  */
23
24 /** A TCP connection */
25 struct tcp_connection {
26         /** Reference counter */
27         struct refcnt refcnt;
28         /** List of TCP connections */
29         struct list_head list;
30
31         /** Data transfer interface */
32         struct xfer_interface xfer;
33         /** Data transfer interface closed flag */
34         int xfer_closed;
35
36         /** Remote socket address */
37         struct sockaddr_tcpip peer;
38         /** Local port, in network byte order */
39         unsigned int local_port;
40
41         /** Current TCP state */
42         unsigned int tcp_state;
43         /** Previous TCP state
44          *
45          * Maintained only for debug messages
46          */
47         unsigned int prev_tcp_state;
48         /** Current sequence number
49          *
50          * Equivalent to SND.UNA in RFC 793 terminology.
51          */
52         uint32_t snd_seq;
53         /** Unacknowledged sequence count
54          *
55          * Equivalent to (SND.NXT-SND.UNA) in RFC 793 terminology.
56          */
57         uint32_t snd_sent;
58         /** Send window
59          *
60          * Equivalent to SND.WND in RFC 793 terminology
61          */
62         uint32_t snd_win;
63         /** Current acknowledgement number
64          *
65          * Equivalent to RCV.NXT in RFC 793 terminology.
66          */
67         uint32_t rcv_ack;
68
69         /** Transmit queue */
70         struct list_head queue;
71         /** Retransmission timer */
72         struct retry_timer timer;
73 };
74
75 /**
76  * List of registered TCP connections
77  */
78 static LIST_HEAD ( tcp_conns );
79
80 /* Forward declarations */
81 static struct xfer_interface_operations tcp_xfer_operations;
82 static void tcp_expired ( struct retry_timer *timer, int over );
83 static int tcp_rx_ack ( struct tcp_connection *tcp, uint32_t ack,
84                         uint32_t win );
85
86 /**
87  * Name TCP state
88  *
89  * @v state             TCP state
90  * @ret name            Name of TCP state
91  */
92 static inline __attribute__ (( always_inline )) const char *
93 tcp_state ( int state ) {
94         switch ( state ) {
95         case TCP_CLOSED:                return "CLOSED";
96         case TCP_LISTEN:                return "LISTEN";
97         case TCP_SYN_SENT:              return "SYN_SENT";
98         case TCP_SYN_RCVD:              return "SYN_RCVD";
99         case TCP_ESTABLISHED:           return "ESTABLISHED";
100         case TCP_FIN_WAIT_1:            return "FIN_WAIT_1";
101         case TCP_FIN_WAIT_2:            return "FIN_WAIT_2";
102         case TCP_CLOSING_OR_LAST_ACK:   return "CLOSING/LAST_ACK";
103         case TCP_TIME_WAIT:             return "TIME_WAIT";
104         case TCP_CLOSE_WAIT:            return "CLOSE_WAIT";
105         default:                        return "INVALID";
106         }
107 }
108
109 /**
110  * Dump TCP state transition
111  *
112  * @v tcp               TCP connection
113  */
114 static inline __attribute__ (( always_inline )) void
115 tcp_dump_state ( struct tcp_connection *tcp ) {
116
117         if ( tcp->tcp_state != tcp->prev_tcp_state ) {
118                 DBGC ( tcp, "TCP %p transitioned from %s to %s\n", tcp,
119                        tcp_state ( tcp->prev_tcp_state ),
120                        tcp_state ( tcp->tcp_state ) );
121         }
122         tcp->prev_tcp_state = tcp->tcp_state;
123 }
124
125 /**
126  * Dump TCP flags
127  *
128  * @v flags             TCP flags
129  */
130 static inline __attribute__ (( always_inline )) void
131 tcp_dump_flags ( struct tcp_connection *tcp, unsigned int flags ) {
132         if ( flags & TCP_RST )
133                 DBGC ( tcp, " RST" );
134         if ( flags & TCP_SYN )
135                 DBGC ( tcp, " SYN" );
136         if ( flags & TCP_PSH )
137                 DBGC ( tcp, " PSH" );
138         if ( flags & TCP_FIN )
139                 DBGC ( tcp, " FIN" );
140         if ( flags & TCP_ACK )
141                 DBGC ( tcp, " ACK" );
142 }
143
144 /***************************************************************************
145  *
146  * Open and close
147  *
148  ***************************************************************************
149  */
150
151 /**
152  * Bind TCP connection to local port
153  *
154  * @v tcp               TCP connection
155  * @v port              Local port number, in network-endian order
156  * @ret rc              Return status code
157  *
158  * If the port is 0, the connection is assigned an available port
159  * between 1024 and 65535.
160  */
161 static int tcp_bind ( struct tcp_connection *tcp, unsigned int port ) {
162         struct tcp_connection *existing;
163         static uint16_t try_port = 1023;
164
165         /* If no port specified, find the first available port */
166         if ( ! port ) {
167                 while ( try_port ) {
168                         try_port++;
169                         if ( try_port < 1024 )
170                                 continue;
171                         if ( tcp_bind ( tcp, htons ( try_port ) ) == 0 )
172                                 return 0;
173                 }
174                 DBGC ( tcp, "TCP %p could not bind: no free ports\n", tcp );
175                 return -EADDRINUSE;
176         }
177
178         /* Attempt bind to local port */
179         list_for_each_entry ( existing, &tcp_conns, list ) {
180                 if ( existing->local_port == port ) {
181                         DBGC ( tcp, "TCP %p could not bind: port %d in use\n",
182                                tcp, ntohs ( port ) );
183                         return -EADDRINUSE;
184                 }
185         }
186         tcp->local_port = port;
187
188         DBGC ( tcp, "TCP %p bound to port %d\n", tcp, ntohs ( port ) );
189         return 0;
190 }
191
192 /**
193  * Open a TCP connection
194  *
195  * @v xfer              Data transfer interface
196  * @v peer              Peer socket address
197  * @v local             Local socket address, or NULL
198  * @ret rc              Return status code
199  */
200 static int tcp_open ( struct xfer_interface *xfer, struct sockaddr *peer,
201                       struct sockaddr *local ) {
202         struct sockaddr_tcpip *st_peer = ( struct sockaddr_tcpip * ) peer;
203         struct sockaddr_tcpip *st_local = ( struct sockaddr_tcpip * ) local;
204         struct tcp_connection *tcp;
205         unsigned int bind_port;
206         int rc;
207
208         /* Allocate and initialise structure */
209         tcp = zalloc ( sizeof ( *tcp ) );
210         if ( ! tcp )
211                 return -ENOMEM;
212         DBGC ( tcp, "TCP %p allocated\n", tcp );
213         xfer_init ( &tcp->xfer, &tcp_xfer_operations, &tcp->refcnt );
214         tcp->prev_tcp_state = TCP_CLOSED;
215         tcp->tcp_state = TCP_STATE_SENT ( TCP_SYN );
216         tcp_dump_state ( tcp );
217         tcp->snd_seq = random();
218         INIT_LIST_HEAD ( &tcp->queue );
219         tcp->timer.expired = tcp_expired;
220         memcpy ( &tcp->peer, st_peer, sizeof ( tcp->peer ) );
221
222         /* Bind to local port */
223         bind_port = ( st_local ? st_local->st_port : 0 );
224         if ( ( rc = tcp_bind ( tcp, bind_port ) ) != 0 )
225                 goto err;
226
227         /* Start timer to initiate SYN */
228         start_timer ( &tcp->timer );
229
230         /* Attach parent interface, transfer reference to connection
231          * list and return
232          */
233         xfer_plug_plug ( &tcp->xfer, xfer );
234         list_add ( &tcp->list, &tcp_conns );
235         return 0;
236
237  err:
238         ref_put ( &tcp->refcnt );
239         return rc;
240 }
241
242 /**
243  * Close TCP connection
244  *
245  * @v tcp               TCP connection
246  * @v rc                Reason for close
247  *
248  * Closes the data transfer interface.  If the TCP state machine is in
249  * a suitable state, the connection will be deleted.
250  */
251 static void tcp_close ( struct tcp_connection *tcp, int rc ) {
252         struct io_buffer *iobuf;
253         struct io_buffer *tmp;
254
255         /* Close data transfer interface */
256         xfer_nullify ( &tcp->xfer );
257         xfer_close ( &tcp->xfer, rc );
258         tcp->xfer_closed = 1;
259
260         /* If we are in CLOSED, or have otherwise not yet received a
261          * SYN (i.e. we are in LISTEN or SYN_SENT), just delete the
262          * connection.
263          */
264         if ( ! ( tcp->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) ) {
265
266                 /* Transition to CLOSED for the sake of debugging messages */
267                 tcp->tcp_state = TCP_CLOSED;
268                 tcp_dump_state ( tcp );
269
270                 /* Free any unsent I/O buffers */
271                 list_for_each_entry_safe ( iobuf, tmp, &tcp->queue, list ) {
272                         list_del ( &iobuf->list );
273                         free_iob ( iobuf );
274                 }
275
276                 /* Remove from list and drop reference */
277                 stop_timer ( &tcp->timer );
278                 list_del ( &tcp->list );
279                 ref_put ( &tcp->refcnt );
280                 DBGC ( tcp, "TCP %p connection deleted\n", tcp );
281                 return;
282         }
283
284         /* If we have not had our SYN acknowledged (i.e. we are in
285          * SYN_RCVD), pretend that it has been acknowledged so that we
286          * can send a FIN without breaking things.
287          */
288         if ( ! ( tcp->tcp_state & TCP_STATE_ACKED ( TCP_SYN ) ) )
289                 tcp_rx_ack ( tcp, ( tcp->snd_seq + 1 ), 0 );
290
291         /* If we have no data remaining to send, start sending FIN */
292         if ( list_empty ( &tcp->queue ) ) {
293                 tcp->tcp_state |= TCP_STATE_SENT ( TCP_FIN );
294                 tcp_dump_state ( tcp );
295         }
296 }
297
298 /***************************************************************************
299  *
300  * Transmit data path
301  *
302  ***************************************************************************
303  */
304
305 /**
306  * Calculate transmission window
307  *
308  * @v tcp               TCP connection
309  * @ret len             Maximum length that can be sent in a single packet
310  */
311 static size_t tcp_xmit_win ( struct tcp_connection *tcp ) {
312         size_t len;
313
314         /* Not ready if we're not in a suitable connection state */
315         if ( ! TCP_CAN_SEND_DATA ( tcp->tcp_state ) )
316                 return 0;
317
318         /* Length is the minimum of the receiver's window and the path MTU */
319         len = tcp->snd_win;
320         if ( len > TCP_PATH_MTU )
321                 len = TCP_PATH_MTU;
322
323         return len;
324 }
325
326 /**
327  * Process TCP transmit queue
328  *
329  * @v tcp               TCP connection
330  * @v max_len           Maximum length to process
331  * @v dest              I/O buffer to fill with data, or NULL
332  * @v remove            Remove data from queue
333  * @ret len             Length of data processed
334  *
335  * This processes at most @c max_len bytes from the TCP connection's
336  * transmit queue.  Data will be copied into the @c dest I/O buffer
337  * (if provided) and, if @c remove is true, removed from the transmit
338  * queue.
339  */
340 static size_t tcp_process_queue ( struct tcp_connection *tcp, size_t max_len,
341                                   struct io_buffer *dest, int remove ) {
342         struct io_buffer *iobuf;
343         struct io_buffer *tmp;
344         size_t frag_len;
345         size_t len = 0;
346
347         list_for_each_entry_safe ( iobuf, tmp, &tcp->queue, list ) {
348                 frag_len = iob_len ( iobuf );
349                 if ( frag_len > max_len )
350                         frag_len = max_len;
351                 if ( dest ) {
352                         memcpy ( iob_put ( dest, frag_len ), iobuf->data,
353                                  frag_len );
354                 }
355                 if ( remove ) {
356                         iob_pull ( iobuf, frag_len );
357                         if ( ! iob_len ( iobuf ) ) {
358                                 list_del ( &iobuf->list );
359                                 free_iob ( iobuf );
360                         }
361                 }
362                 len += frag_len;
363                 max_len -= frag_len;
364         }
365         return len;
366 }
367
368 /**
369  * Transmit any outstanding data
370  *
371  * @v tcp               TCP connection
372  * @v force_send        Force sending of packet
373  * 
374  * Transmits any outstanding data on the connection.
375  *
376  * Note that even if an error is returned, the retransmission timer
377  * will have been started if necessary, and so the stack will
378  * eventually attempt to retransmit the failed packet.
379  */
380 static int tcp_xmit ( struct tcp_connection *tcp, int force_send ) {
381         struct io_buffer *iobuf;
382         struct tcp_header *tcphdr;
383         struct tcp_mss_option *mssopt;
384         void *payload;
385         unsigned int flags;
386         size_t len = 0;
387         size_t seq_len;
388         size_t app_win;
389         size_t rcv_win;
390         int rc;
391
392         /* If retransmission timer is already running, do nothing */
393         if ( timer_running ( &tcp->timer ) )
394                 return 0;
395
396         /* Calculate both the actual (payload) and sequence space
397          * lengths that we wish to transmit.
398          */
399         if ( TCP_CAN_SEND_DATA ( tcp->tcp_state ) ) {
400                 len = tcp_process_queue ( tcp, tcp_xmit_win ( tcp ),
401                                           NULL, 0 );
402         }
403         seq_len = len;
404         flags = TCP_FLAGS_SENDING ( tcp->tcp_state );
405         if ( flags & ( TCP_SYN | TCP_FIN ) ) {
406                 /* SYN or FIN consume one byte, and we can never send both */
407                 assert ( ! ( ( flags & TCP_SYN ) && ( flags & TCP_FIN ) ) );
408                 seq_len++;
409         }
410         tcp->snd_sent = seq_len;
411
412         /* If we have nothing to transmit, stop now */
413         if ( ( seq_len == 0 ) && ! force_send )
414                 return 0;
415
416         /* If we are transmitting anything that requires
417          * acknowledgement (i.e. consumes sequence space), start the
418          * retransmission timer.  Do this before attempting to
419          * allocate the I/O buffer, in case allocation itself fails.
420          */
421         if ( seq_len )
422                 start_timer ( &tcp->timer );
423
424         /* Allocate I/O buffer */
425         iobuf = alloc_iob ( len + MAX_HDR_LEN );
426         if ( ! iobuf ) {
427                 DBGC ( tcp, "TCP %p could not allocate data buffer\n", tcp );
428                 return -ENOMEM;
429         }
430         iob_reserve ( iobuf, MAX_HDR_LEN );
431
432         /* Fill data payload from transmit queue */
433         tcp_process_queue ( tcp, len, iobuf, 0 );
434
435         /* Estimate window size */
436         rcv_win = ( ( freemem * 3 ) / 4 );
437         if ( rcv_win > TCP_MAX_WINDOW_SIZE )
438                 rcv_win = TCP_MAX_WINDOW_SIZE;
439         app_win = xfer_window ( &tcp->xfer );
440         if ( rcv_win > app_win )
441                 rcv_win = app_win;
442         rcv_win &= ~0x03; /* Keep everything dword-aligned */
443
444         /* Fill up the TCP header */
445         payload = iobuf->data;
446         if ( flags & TCP_SYN ) {
447                 mssopt = iob_push ( iobuf, sizeof ( *mssopt ) );
448                 mssopt->kind = TCP_OPTION_MSS;
449                 mssopt->length = sizeof ( *mssopt );
450                 mssopt->mss = htons ( TCP_MSS );
451         }
452         tcphdr = iob_push ( iobuf, sizeof ( *tcphdr ) );
453         memset ( tcphdr, 0, sizeof ( *tcphdr ) );
454         tcphdr->src = tcp->local_port;
455         tcphdr->dest = tcp->peer.st_port;
456         tcphdr->seq = htonl ( tcp->snd_seq );
457         tcphdr->ack = htonl ( tcp->rcv_ack );
458         tcphdr->hlen = ( ( payload - iobuf->data ) << 2 );
459         tcphdr->flags = flags;
460         tcphdr->win = htons ( rcv_win );
461         tcphdr->csum = tcpip_chksum ( iobuf->data, iob_len ( iobuf ) );
462
463         /* Dump header */
464         DBGC ( tcp, "TCP %p TX %d->%d %08lx..%08lx           %08lx %4zd",
465                tcp, ntohs ( tcphdr->src ), ntohs ( tcphdr->dest ),
466                ntohl ( tcphdr->seq ), ( ntohl ( tcphdr->seq ) + seq_len ),
467                ntohl ( tcphdr->ack ), len );
468         tcp_dump_flags ( tcp, tcphdr->flags );
469         DBGC ( tcp, "\n" );
470
471         /* Transmit packet */
472         rc = tcpip_tx ( iobuf, &tcp_protocol, &tcp->peer, NULL, &tcphdr->csum );
473
474         /* If we got -ENETUNREACH, kill the connection immediately
475          * because there is no point retrying.  This isn't strictly
476          * necessary (since we will eventually time out anyway), but
477          * it avoids irritating needless delays.  Don't do this for
478          * RST packets transmitted on connection abort, to avoid a
479          * potential infinite loop.
480          */
481         if ( ( ! ( tcp->tcp_state & TCP_STATE_SENT ( TCP_RST ) ) ) &&
482              ( rc == -ENETUNREACH ) ) {
483                 DBGC ( tcp, "TCP %p aborting after TX failed: %s\n",
484                        tcp, strerror ( rc ) );
485                 tcp->tcp_state = TCP_CLOSED;
486                 tcp_dump_state ( tcp );
487                 tcp_close ( tcp, rc );
488         }
489
490         return rc;
491 }
492
493 /**
494  * Retransmission timer expired
495  *
496  * @v timer     Retry timer
497  * @v over      Failure indicator
498  */
499 static void tcp_expired ( struct retry_timer *timer, int over ) {
500         struct tcp_connection *tcp =
501                 container_of ( timer, struct tcp_connection, timer );
502         int graceful_close = TCP_CLOSED_GRACEFULLY ( tcp->tcp_state );
503
504         DBGC ( tcp, "TCP %p timer %s in %s\n", tcp,
505                ( over ? "expired" : "fired" ), tcp_state ( tcp->tcp_state ) );
506
507         assert ( ( tcp->tcp_state == TCP_SYN_SENT ) ||
508                  ( tcp->tcp_state == TCP_SYN_RCVD ) ||
509                  ( tcp->tcp_state == TCP_ESTABLISHED ) ||
510                  ( tcp->tcp_state == TCP_FIN_WAIT_1 ) ||
511                  ( tcp->tcp_state == TCP_TIME_WAIT ) ||
512                  ( tcp->tcp_state == TCP_CLOSE_WAIT ) ||
513                  ( tcp->tcp_state == TCP_CLOSING_OR_LAST_ACK ) );
514
515         if ( over || graceful_close ) {
516                 /* If we have finally timed out and given up, or if
517                  * this is the result of a graceful close, terminate
518                  * the connection
519                  */
520                 tcp->tcp_state = TCP_CLOSED;
521                 tcp_dump_state ( tcp );
522                 tcp_close ( tcp, -ETIMEDOUT );
523         } else {
524                 /* Otherwise, retransmit the packet */
525                 tcp_xmit ( tcp, 0 );
526         }
527 }
528
529 /**
530  * Send RST response to incoming packet
531  *
532  * @v in_tcphdr         TCP header of incoming packet
533  * @ret rc              Return status code
534  */
535 static int tcp_xmit_reset ( struct tcp_connection *tcp,
536                             struct sockaddr_tcpip *st_dest,
537                             struct tcp_header *in_tcphdr ) {
538         struct io_buffer *iobuf;
539         struct tcp_header *tcphdr;
540
541         /* Allocate space for dataless TX buffer */
542         iobuf = alloc_iob ( MAX_HDR_LEN );
543         if ( ! iobuf ) {
544                 DBGC ( tcp, "TCP %p could not allocate data buffer\n", tcp );
545                 return -ENOMEM;
546         }
547         iob_reserve ( iobuf, MAX_HDR_LEN );
548
549         /* Construct RST response */
550         tcphdr = iob_push ( iobuf, sizeof ( *tcphdr ) );
551         memset ( tcphdr, 0, sizeof ( *tcphdr ) );
552         tcphdr->src = in_tcphdr->dest;
553         tcphdr->dest = in_tcphdr->src;
554         tcphdr->seq = in_tcphdr->ack;
555         tcphdr->ack = in_tcphdr->seq;
556         tcphdr->hlen = ( ( sizeof ( *tcphdr ) / 4 ) << 4 );
557         tcphdr->flags = ( TCP_RST | TCP_ACK );
558         tcphdr->win = htons ( TCP_MAX_WINDOW_SIZE );
559         tcphdr->csum = tcpip_chksum ( iobuf->data, iob_len ( iobuf ) );
560
561         /* Dump header */
562         DBGC ( tcp, "TCP %p TX %d->%d %08lx..%08lx           %08lx %4zd",
563                tcp, ntohs ( tcphdr->src ), ntohs ( tcphdr->dest ),
564                ntohl ( tcphdr->seq ), ( ntohl ( tcphdr->seq ) ),
565                ntohl ( tcphdr->ack ), 0 );
566         tcp_dump_flags ( tcp, tcphdr->flags );
567         DBGC ( tcp, "\n" );
568
569         /* Transmit packet */
570         return tcpip_tx ( iobuf, &tcp_protocol, st_dest,
571                           NULL, &tcphdr->csum );
572 }
573
574 /***************************************************************************
575  *
576  * Receive data path
577  *
578  ***************************************************************************
579  */
580
581 /**
582  * Identify TCP connection by local port number
583  *
584  * @v local_port        Local port (in network-endian order)
585  * @ret tcp             TCP connection, or NULL
586  */
587 static struct tcp_connection * tcp_demux ( unsigned int local_port ) {
588         struct tcp_connection *tcp;
589
590         list_for_each_entry ( tcp, &tcp_conns, list ) {
591                 if ( tcp->local_port == local_port )
592                         return tcp;
593         }
594         return NULL;
595 }
596
597 /**
598  * Handle TCP received SYN
599  *
600  * @v tcp               TCP connection
601  * @v seq               SEQ value (in host-endian order)
602  * @ret rc              Return status code
603  */
604 static int tcp_rx_syn ( struct tcp_connection *tcp, uint32_t seq ) {
605
606         /* Synchronise sequence numbers on first SYN */
607         if ( ! ( tcp->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) )
608                 tcp->rcv_ack = seq;
609
610         /* Ignore duplicate SYN */
611         if ( ( tcp->rcv_ack - seq ) > 0 )
612                 return 0;
613
614         /* Mark SYN as received and start sending ACKs with each packet */
615         tcp->tcp_state |= ( TCP_STATE_SENT ( TCP_ACK ) |
616                             TCP_STATE_RCVD ( TCP_SYN ) );
617
618         /* Acknowledge SYN */
619         tcp->rcv_ack++;
620
621         return 0;
622 }
623
624 /**
625  * Handle TCP received ACK
626  *
627  * @v tcp               TCP connection
628  * @v ack               ACK value (in host-endian order)
629  * @v win               WIN value (in host-endian order)
630  * @ret rc              Return status code
631  */
632 static int tcp_rx_ack ( struct tcp_connection *tcp, uint32_t ack,
633                         uint32_t win ) {
634         size_t ack_len = ( ack - tcp->snd_seq );
635         size_t len;
636         unsigned int acked_flags;
637
638         /* Ignore duplicate or out-of-range ACK */
639         if ( ack_len > tcp->snd_sent ) {
640                 DBGC ( tcp, "TCP %p received ACK for [%08lx,%08lx), "
641                        "sent only [%08lx,%08lx)\n", tcp, tcp->snd_seq,
642                        ( tcp->snd_seq + ack_len ), tcp->snd_seq,
643                        ( tcp->snd_seq + tcp->snd_sent ) );
644                 return -EINVAL;
645         }
646
647         /* Acknowledge any flags being sent */
648         len = ack_len;
649         acked_flags = ( TCP_FLAGS_SENDING ( tcp->tcp_state ) &
650                         ( TCP_SYN | TCP_FIN ) );
651         if ( acked_flags )
652                 len--;
653
654         /* Update SEQ and sent counters, and window size */
655         tcp->snd_seq = ack;
656         tcp->snd_sent = 0;
657         tcp->snd_win = win;
658
659         /* Stop the retransmission timer */
660         stop_timer ( &tcp->timer );
661
662         /* Remove any acknowledged data from transmit queue */
663         tcp_process_queue ( tcp, len, NULL, 1 );
664                 
665         /* Mark SYN/FIN as acknowledged if applicable. */
666         if ( acked_flags )
667                 tcp->tcp_state |= TCP_STATE_ACKED ( acked_flags );
668
669         /* Start sending FIN if we've had all possible data ACKed */
670         if ( list_empty ( &tcp->queue ) && tcp->xfer_closed )
671                 tcp->tcp_state |= TCP_STATE_SENT ( TCP_FIN );
672
673         return 0;
674 }
675
676 /**
677  * Handle TCP received data
678  *
679  * @v tcp               TCP connection
680  * @v seq               SEQ value (in host-endian order)
681  * @v iobuf             I/O buffer
682  * @ret rc              Return status code
683  *
684  * This function takes ownership of the I/O buffer.
685  */
686 static int tcp_rx_data ( struct tcp_connection *tcp, uint32_t seq,
687                          struct io_buffer *iobuf ) {
688         size_t already_rcvd;
689         size_t len;
690         int rc;
691
692         /* Ignore duplicate data */
693         already_rcvd = ( tcp->rcv_ack - seq );
694         len = iob_len ( iobuf );
695         if ( already_rcvd >= len ) {
696                 free_iob ( iobuf );
697                 return 0;
698         }
699         iob_pull ( iobuf, already_rcvd );
700
701         /* Deliver data to application */
702         if ( ( rc = xfer_deliver_iob ( &tcp->xfer, iobuf ) ) != 0 )
703                 return rc;
704
705         /* Acknowledge new data */
706         tcp->rcv_ack += len;
707         return 0;
708 }
709
710 /**
711  * Handle TCP received FIN
712  *
713  * @v tcp               TCP connection
714  * @v seq               SEQ value (in host-endian order)
715  * @ret rc              Return status code
716  */
717 static int tcp_rx_fin ( struct tcp_connection *tcp, uint32_t seq ) {
718
719         /* Ignore duplicate FIN */
720         if ( ( tcp->rcv_ack - seq ) > 0 )
721                 return 0;
722
723         /* Mark FIN as received and acknowledge it */
724         tcp->tcp_state |= TCP_STATE_RCVD ( TCP_FIN );
725         tcp->rcv_ack++;
726
727         /* Close connection */
728         tcp_close ( tcp, 0 );
729
730         return 0;
731 }
732
733 /**
734  * Handle TCP received RST
735  *
736  * @v tcp               TCP connection
737  * @v seq               SEQ value (in host-endian order)
738  * @ret rc              Return status code
739  */
740 static int tcp_rx_rst ( struct tcp_connection *tcp, uint32_t seq ) {
741
742         /* Accept RST only if it falls within the window.  If we have
743          * not yet received a SYN, then we have no window to test
744          * against, so fall back to checking that our SYN has been
745          * ACKed.
746          */
747         if ( tcp->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) {
748                 if ( ( tcp->rcv_ack - seq ) > 0 )
749                         return 0;
750         } else {
751                 if ( ! ( tcp->tcp_state & TCP_STATE_ACKED ( TCP_SYN ) ) )
752                         return 0;
753         }
754
755         /* Abort connection */
756         tcp->tcp_state = TCP_CLOSED;
757         tcp_dump_state ( tcp );
758         tcp_close ( tcp, -ECONNRESET );
759
760         return -ECONNRESET;
761 }
762
763 /**
764  * Process received packet
765  *
766  * @v iobuf             I/O buffer
767  * @v st_src            Partially-filled source address
768  * @v st_dest           Partially-filled destination address
769  * @v pshdr_csum        Pseudo-header checksum
770  * @ret rc              Return status code
771   */
772 static int tcp_rx ( struct io_buffer *iobuf,
773                     struct sockaddr_tcpip *st_src,
774                     struct sockaddr_tcpip *st_dest __unused,
775                     uint16_t pshdr_csum ) {
776         struct tcp_header *tcphdr = iobuf->data;
777         struct tcp_connection *tcp;
778         unsigned int hlen;
779         uint16_t csum;
780         uint32_t start_seq;
781         uint32_t seq;
782         uint32_t ack;
783         uint32_t win;
784         unsigned int flags;
785         size_t len;
786         int rc;
787
788         /* Sanity check packet */
789         if ( iob_len ( iobuf ) < sizeof ( *tcphdr ) ) {
790                 DBG ( "TCP packet too short at %d bytes (min %d bytes)\n",
791                       iob_len ( iobuf ), sizeof ( *tcphdr ) );
792                 rc = -EINVAL;
793                 goto discard;
794         }
795         hlen = ( ( tcphdr->hlen & TCP_MASK_HLEN ) / 16 ) * 4;
796         if ( hlen < sizeof ( *tcphdr ) ) {
797                 DBG ( "TCP header too short at %d bytes (min %d bytes)\n",
798                       hlen, sizeof ( *tcphdr ) );
799                 rc = -EINVAL;
800                 goto discard;
801         }
802         if ( hlen > iob_len ( iobuf ) ) {
803                 DBG ( "TCP header too long at %d bytes (max %d bytes)\n",
804                       hlen, iob_len ( iobuf ) );
805                 rc = -EINVAL;
806                 goto discard;
807         }
808         csum = tcpip_continue_chksum ( pshdr_csum, iobuf->data, iob_len ( iobuf ));
809         if ( csum != 0 ) {
810                 DBG ( "TCP checksum incorrect (is %04x including checksum "
811                       "field, should be 0000)\n", csum );
812                 rc = -EINVAL;
813                 goto discard;
814         }
815         
816         /* Parse parameters from header and strip header */
817         tcp = tcp_demux ( tcphdr->dest );
818         start_seq = seq = ntohl ( tcphdr->seq );
819         ack = ntohl ( tcphdr->ack );
820         win = ntohs ( tcphdr->win );
821         flags = tcphdr->flags;
822         iob_pull ( iobuf, hlen );
823         len = iob_len ( iobuf );
824
825         /* Dump header */
826         DBGC ( tcp, "TCP %p RX %d<-%d           %08lx %08lx..%08lx %4zd",
827                tcp, ntohs ( tcphdr->dest ), ntohs ( tcphdr->src ),
828                ntohl ( tcphdr->ack ), ntohl ( tcphdr->seq ),
829                ( ntohl ( tcphdr->seq ) + len +
830                  ( ( tcphdr->flags & ( TCP_SYN | TCP_FIN ) ) ? 1 : 0 ) ), len);
831         tcp_dump_flags ( tcp, tcphdr->flags );
832         DBGC ( tcp, "\n" );
833
834         /* If no connection was found, send RST */
835         if ( ! tcp ) {
836                 tcp_xmit_reset ( tcp, st_src, tcphdr );
837                 rc = -ENOTCONN;
838                 goto discard;
839         }
840
841         /* Handle ACK, if present */
842         if ( flags & TCP_ACK ) {
843                 if ( ( rc = tcp_rx_ack ( tcp, ack, win ) ) != 0 ) {
844                         tcp_xmit_reset ( tcp, st_src, tcphdr );
845                         goto discard;
846                 }
847         }
848
849         /* Handle SYN, if present */
850         if ( flags & TCP_SYN ) {
851                 tcp_rx_syn ( tcp, seq );
852                 seq++;
853         }
854
855         /* Handle RST, if present */
856         if ( flags & TCP_RST ) {
857                 if ( ( rc = tcp_rx_rst ( tcp, seq ) ) != 0 )
858                         goto discard;
859         }
860
861         /* Handle new data, if any */
862         tcp_rx_data ( tcp, seq, iobuf );
863         seq += len;
864
865         /* Handle FIN, if present */
866         if ( flags & TCP_FIN ) {
867                 tcp_rx_fin ( tcp, seq );
868                 seq++;
869         }
870
871         /* Dump out any state change as a result of the received packet */
872         tcp_dump_state ( tcp );
873
874         /* Send out any pending data.  If peer is expecting an ACK for
875          * this packet then force sending a reply.
876          */
877         tcp_xmit ( tcp, ( start_seq != seq ) );
878
879         /* If this packet was the last we expect to receive, set up
880          * timer to expire and cause the connection to be freed.
881          */
882         if ( TCP_CLOSED_GRACEFULLY ( tcp->tcp_state ) ) {
883                 tcp->timer.timeout = ( 2 * TCP_MSL );
884                 start_timer ( &tcp->timer );
885         }
886
887         return 0;
888
889  discard:
890         /* Free received packet */
891         free_iob ( iobuf );
892         return rc;
893 }
894
895 /** TCP protocol */
896 struct tcpip_protocol tcp_protocol __tcpip_protocol = {
897         .name = "TCP",
898         .rx = tcp_rx,
899         .tcpip_proto = IP_TCP,
900 };
901
902 /***************************************************************************
903  *
904  * Data transfer interface
905  *
906  ***************************************************************************
907  */
908
909 /**
910  * Close interface
911  *
912  * @v xfer              Data transfer interface
913  * @v rc                Reason for close
914  */
915 static void tcp_xfer_close ( struct xfer_interface *xfer, int rc ) {
916         struct tcp_connection *tcp =
917                 container_of ( xfer, struct tcp_connection, xfer );
918
919         /* Close data transfer interface */
920         tcp_close ( tcp, rc );
921
922         /* Transmit FIN, if possible */
923         tcp_xmit ( tcp, 0 );
924 }
925
926 /**
927  * Check flow control window
928  *
929  * @v xfer              Data transfer interface
930  * @ret len             Length of window
931  */
932 static size_t tcp_xfer_window ( struct xfer_interface *xfer ) {
933         struct tcp_connection *tcp =
934                 container_of ( xfer, struct tcp_connection, xfer );
935
936         /* Not ready if data queue is non-empty.  This imposes a limit
937          * of only one unACKed packet in the TX queue at any time; we
938          * do this to conserve memory usage.
939          */
940         if ( ! list_empty ( &tcp->queue ) )
941                 return 0;
942
943         /* Return TCP window length */
944         return tcp_xmit_win ( tcp );
945 }
946
947 /**
948  * Deliver datagram as I/O buffer
949  *
950  * @v xfer              Data transfer interface
951  * @v iobuf             Datagram I/O buffer
952  * @v meta              Data transfer metadata, or NULL
953  * @ret rc              Return status code
954  */
955 static int tcp_xfer_deliver_iob ( struct xfer_interface *xfer,
956                                   struct io_buffer *iobuf,
957                                   struct xfer_metadata *meta __unused ) {
958         struct tcp_connection *tcp =
959                 container_of ( xfer, struct tcp_connection, xfer );
960
961         /* Enqueue packet */
962         list_add_tail ( &iobuf->list, &tcp->queue );
963
964         /* Transmit data, if possible */
965         tcp_xmit ( tcp, 0 );
966
967         return 0;
968 }
969
970 /** TCP data transfer interface operations */
971 static struct xfer_interface_operations tcp_xfer_operations = {
972         .close          = tcp_xfer_close,
973         .vredirect      = ignore_xfer_vredirect,
974         .seek           = ignore_xfer_seek,
975         .window         = tcp_xfer_window,
976         .alloc_iob      = default_xfer_alloc_iob,
977         .deliver_iob    = tcp_xfer_deliver_iob,
978         .deliver_raw    = xfer_deliver_as_iob,
979 };
980
981 /***************************************************************************
982  *
983  * Openers
984  *
985  ***************************************************************************
986  */
987
988 /** TCP socket opener */
989 struct socket_opener tcp_socket_opener __socket_opener = {
990         .semantics      = SOCK_STREAM,
991         .family         = AF_INET,
992         .open           = tcp_open,
993 };
994
995 char TCP_SOCK_STREAM[1];
996
997 /**
998  * Open TCP URI
999  *
1000  * @v xfer              Data transfer interface
1001  * @v uri               URI
1002  * @ret rc              Return status code
1003  */
1004 static int tcp_open_uri ( struct xfer_interface *xfer, struct uri *uri ) {
1005         struct sockaddr_tcpip peer;
1006
1007         /* Sanity check */
1008         if ( ! uri->host )
1009                 return -EINVAL;
1010
1011         memset ( &peer, 0, sizeof ( peer ) );
1012         peer.st_port = htons ( uri_port ( uri, 0 ) );
1013         return xfer_open_named_socket ( xfer, SOCK_STREAM,
1014                                         ( struct sockaddr * ) &peer,
1015                                         uri->host, NULL );
1016 }
1017
1018 /** TCP URI opener */
1019 struct uri_opener tcp_uri_opener __uri_opener = {
1020         .scheme         = "tcp",
1021         .open           = tcp_open_uri,
1022 };
1023