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