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