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