d9f6c2d1b24c5f7241c105d73f1b2aa61e4334f2
[people/lynusvaz/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                 DBGC2 ( tcp, " RST" );
148         if ( flags & TCP_SYN )
149                 DBGC2 ( tcp, " SYN" );
150         if ( flags & TCP_PSH )
151                 DBGC2 ( tcp, " PSH" );
152         if ( flags & TCP_FIN )
153                 DBGC2 ( tcp, " FIN" );
154         if ( flags & TCP_ACK )
155                 DBGC2 ( 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         DBGC2 ( 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         DBGC2 ( 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 for [%08x,%08x)\n", tcp,
514                ( over ? "expired" : "fired" ), tcp_state ( tcp->tcp_state ),
515                tcp->snd_seq, ( tcp->snd_seq + tcp->snd_sent ) );
516
517         assert ( ( tcp->tcp_state == TCP_SYN_SENT ) ||
518                  ( tcp->tcp_state == TCP_SYN_RCVD ) ||
519                  ( tcp->tcp_state == TCP_ESTABLISHED ) ||
520                  ( tcp->tcp_state == TCP_FIN_WAIT_1 ) ||
521                  ( tcp->tcp_state == TCP_TIME_WAIT ) ||
522                  ( tcp->tcp_state == TCP_CLOSE_WAIT ) ||
523                  ( tcp->tcp_state == TCP_CLOSING_OR_LAST_ACK ) );
524
525         if ( over || graceful_close ) {
526                 /* If we have finally timed out and given up, or if
527                  * this is the result of a graceful close, terminate
528                  * the connection
529                  */
530                 tcp->tcp_state = TCP_CLOSED;
531                 tcp_dump_state ( tcp );
532                 tcp_close ( tcp, -ETIMEDOUT );
533         } else {
534                 /* Otherwise, retransmit the packet */
535                 tcp_xmit ( tcp, 0 );
536         }
537 }
538
539 /**
540  * Send RST response to incoming packet
541  *
542  * @v in_tcphdr         TCP header of incoming packet
543  * @ret rc              Return status code
544  */
545 static int tcp_xmit_reset ( struct tcp_connection *tcp,
546                             struct sockaddr_tcpip *st_dest,
547                             struct tcp_header *in_tcphdr ) {
548         struct io_buffer *iobuf;
549         struct tcp_header *tcphdr;
550
551         /* Allocate space for dataless TX buffer */
552         iobuf = alloc_iob ( MAX_HDR_LEN );
553         if ( ! iobuf ) {
554                 DBGC ( tcp, "TCP %p could not allocate data buffer\n", tcp );
555                 return -ENOMEM;
556         }
557         iob_reserve ( iobuf, MAX_HDR_LEN );
558
559         /* Construct RST response */
560         tcphdr = iob_push ( iobuf, sizeof ( *tcphdr ) );
561         memset ( tcphdr, 0, sizeof ( *tcphdr ) );
562         tcphdr->src = in_tcphdr->dest;
563         tcphdr->dest = in_tcphdr->src;
564         tcphdr->seq = in_tcphdr->ack;
565         tcphdr->ack = in_tcphdr->seq;
566         tcphdr->hlen = ( ( sizeof ( *tcphdr ) / 4 ) << 4 );
567         tcphdr->flags = ( TCP_RST | TCP_ACK );
568         tcphdr->win = htons ( TCP_MAX_WINDOW_SIZE );
569         tcphdr->csum = tcpip_chksum ( iobuf->data, iob_len ( iobuf ) );
570
571         /* Dump header */
572         DBGC2 ( tcp, "TCP %p TX %d->%d %08x..%08x           %08x %4d",
573                 tcp, ntohs ( tcphdr->src ), ntohs ( tcphdr->dest ),
574                 ntohl ( tcphdr->seq ), ( ntohl ( tcphdr->seq ) ),
575                 ntohl ( tcphdr->ack ), 0 );
576         tcp_dump_flags ( tcp, tcphdr->flags );
577         DBGC2 ( tcp, "\n" );
578
579         /* Transmit packet */
580         return tcpip_tx ( iobuf, &tcp_protocol, NULL, st_dest,
581                           NULL, &tcphdr->csum );
582 }
583
584 /***************************************************************************
585  *
586  * Receive data path
587  *
588  ***************************************************************************
589  */
590
591 /**
592  * Identify TCP connection by local port number
593  *
594  * @v local_port        Local port (in network-endian order)
595  * @ret tcp             TCP connection, or NULL
596  */
597 static struct tcp_connection * tcp_demux ( unsigned int local_port ) {
598         struct tcp_connection *tcp;
599
600         list_for_each_entry ( tcp, &tcp_conns, list ) {
601                 if ( tcp->local_port == local_port )
602                         return tcp;
603         }
604         return NULL;
605 }
606
607 /**
608  * Parse TCP received options
609  *
610  * @v tcp               TCP connection
611  * @v data              Raw options data
612  * @v len               Raw options length
613  * @v options           Options structure to fill in
614  */
615 static void tcp_rx_opts ( struct tcp_connection *tcp, const void *data,
616                           size_t len, struct tcp_options *options ) {
617         const void *end = ( data + len );
618         const struct tcp_option *option;
619         unsigned int kind;
620
621         memset ( options, 0, sizeof ( *options ) );
622         while ( data < end ) {
623                 option = data;
624                 kind = option->kind;
625                 if ( kind == TCP_OPTION_END )
626                         return;
627                 if ( kind == TCP_OPTION_NOP ) {
628                         data++;
629                         continue;
630                 }
631                 switch ( kind ) {
632                 case TCP_OPTION_MSS:
633                         options->mssopt = data;
634                         break;
635                 case TCP_OPTION_TS:
636                         options->tsopt = data;
637                         break;
638                 default:
639                         DBGC ( tcp, "TCP %p received unknown option %d\n",
640                                tcp, kind );
641                         break;
642                 }
643                 data += option->length;
644         }
645 }
646
647 /**
648  * Consume received sequence space
649  *
650  * @v tcp               TCP connection
651  * @v seq_len           Sequence space length to consume
652  */
653 static void tcp_rx_seq ( struct tcp_connection *tcp, size_t seq_len ) {
654         tcp->rcv_ack += seq_len;
655         if ( tcp->rcv_win > seq_len ) {
656                 tcp->rcv_win -= seq_len;
657         } else {
658                 tcp->rcv_win = 0;
659         }
660 }
661
662 /**
663  * Handle TCP received SYN
664  *
665  * @v tcp               TCP connection
666  * @v seq               SEQ value (in host-endian order)
667  * @v options           TCP options
668  * @ret rc              Return status code
669  */
670 static int tcp_rx_syn ( struct tcp_connection *tcp, uint32_t seq,
671                         struct tcp_options *options ) {
672
673         /* Synchronise sequence numbers on first SYN */
674         if ( ! ( tcp->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) ) {
675                 tcp->rcv_ack = seq;
676                 if ( options->tsopt )
677                         tcp->timestamps = 1;
678         }
679
680         /* Ignore duplicate SYN */
681         if ( ( tcp->rcv_ack - seq ) > 0 )
682                 return 0;
683
684         /* Mark SYN as received and start sending ACKs with each packet */
685         tcp->tcp_state |= ( TCP_STATE_SENT ( TCP_ACK ) |
686                             TCP_STATE_RCVD ( TCP_SYN ) );
687
688         /* Acknowledge SYN */
689         tcp_rx_seq ( tcp, 1 );
690
691         return 0;
692 }
693
694 /**
695  * Handle TCP received ACK
696  *
697  * @v tcp               TCP connection
698  * @v ack               ACK value (in host-endian order)
699  * @v win               WIN value (in host-endian order)
700  * @ret rc              Return status code
701  */
702 static int tcp_rx_ack ( struct tcp_connection *tcp, uint32_t ack,
703                         uint32_t win ) {
704         size_t ack_len = ( ack - tcp->snd_seq );
705         size_t len;
706         unsigned int acked_flags;
707
708         /* Determine acknowledged flags and data length */
709         len = ack_len;
710         acked_flags = ( TCP_FLAGS_SENDING ( tcp->tcp_state ) &
711                         ( TCP_SYN | TCP_FIN ) );
712         if ( acked_flags )
713                 len--;
714
715         /* Stop retransmission timer if necessary */
716         if ( ack_len == 0 ) {
717                 /* Duplicate ACK (or just a packet that isn't
718                  * intending to ACK any new data).  If the
719                  * retransmission timer is running, leave it running
720                  * so that we don't immediately retransmit and cause a
721                  * sorceror's apprentice syndrome.
722                  */
723         } else if ( ack_len <= tcp->snd_sent ) {
724                 /* ACK of new data.  Stop the retransmission timer. */
725                 stop_timer ( &tcp->timer );
726         } else {
727                 /* Out-of-range (or old duplicate) ACK.  Leave the
728                  * timer running, as for the ack_len==0 case, to
729                  * handle old duplicate ACKs.
730                  */
731                 DBGC ( tcp, "TCP %p received ACK for [%08x,%08zx), "
732                        "sent only [%08x,%08x)\n", tcp, tcp->snd_seq,
733                        ( tcp->snd_seq + ack_len ), tcp->snd_seq,
734                        ( tcp->snd_seq + tcp->snd_sent ) );
735                 /* Send RST if an out-of-range ACK is received on a
736                  * not-yet-established connection.
737                  */
738                 if ( ! TCP_HAS_BEEN_ESTABLISHED ( tcp->tcp_state ) )
739                         return -EINVAL;
740         }
741
742         /* Update SEQ and sent counters, and window size */
743         tcp->snd_seq = ack;
744         tcp->snd_sent = 0;
745         tcp->snd_win = win;
746
747         /* Remove any acknowledged data from transmit queue */
748         tcp_process_queue ( tcp, len, NULL, 1 );
749                 
750         /* Mark SYN/FIN as acknowledged if applicable. */
751         if ( acked_flags )
752                 tcp->tcp_state |= TCP_STATE_ACKED ( acked_flags );
753
754         /* Start sending FIN if we've had all possible data ACKed */
755         if ( list_empty ( &tcp->queue ) && tcp->xfer_closed )
756                 tcp->tcp_state |= TCP_STATE_SENT ( TCP_FIN );
757
758         return 0;
759 }
760
761 /**
762  * Handle TCP received data
763  *
764  * @v tcp               TCP connection
765  * @v seq               SEQ value (in host-endian order)
766  * @v iobuf             I/O buffer
767  * @ret rc              Return status code
768  *
769  * This function takes ownership of the I/O buffer.
770  */
771 static int tcp_rx_data ( struct tcp_connection *tcp, uint32_t seq,
772                          struct io_buffer *iobuf ) {
773         size_t already_rcvd;
774         size_t len;
775         int rc;
776
777         /* Ignore duplicate or out-of-order data */
778         already_rcvd = ( tcp->rcv_ack - seq );
779         len = iob_len ( iobuf );
780         if ( already_rcvd >= len ) {
781                 free_iob ( iobuf );
782                 return 0;
783         }
784         iob_pull ( iobuf, already_rcvd );
785         len -= already_rcvd;
786
787         /* Deliver data to application */
788         if ( ( rc = xfer_deliver_iob ( &tcp->xfer, iobuf ) ) != 0 )
789                 return rc;
790
791         /* Acknowledge new data */
792         tcp_rx_seq ( tcp, len );
793
794         return 0;
795 }
796
797 /**
798  * Handle TCP received FIN
799  *
800  * @v tcp               TCP connection
801  * @v seq               SEQ value (in host-endian order)
802  * @ret rc              Return status code
803  */
804 static int tcp_rx_fin ( struct tcp_connection *tcp, uint32_t seq ) {
805
806         /* Ignore duplicate or out-of-order FIN */
807         if ( ( tcp->rcv_ack - seq ) > 0 )
808                 return 0;
809
810         /* Mark FIN as received and acknowledge it */
811         tcp->tcp_state |= TCP_STATE_RCVD ( TCP_FIN );
812         tcp_rx_seq ( tcp, 1 );
813
814         /* Close connection */
815         tcp_close ( tcp, 0 );
816
817         return 0;
818 }
819
820 /**
821  * Handle TCP received RST
822  *
823  * @v tcp               TCP connection
824  * @v seq               SEQ value (in host-endian order)
825  * @ret rc              Return status code
826  */
827 static int tcp_rx_rst ( struct tcp_connection *tcp, uint32_t seq ) {
828
829         /* Accept RST only if it falls within the window.  If we have
830          * not yet received a SYN, then we have no window to test
831          * against, so fall back to checking that our SYN has been
832          * ACKed.
833          */
834         if ( tcp->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) {
835                 if ( ( seq - tcp->rcv_ack ) >= tcp->rcv_win )
836                         return 0;
837         } else {
838                 if ( ! ( tcp->tcp_state & TCP_STATE_ACKED ( TCP_SYN ) ) )
839                         return 0;
840         }
841
842         /* Abort connection */
843         tcp->tcp_state = TCP_CLOSED;
844         tcp_dump_state ( tcp );
845         tcp_close ( tcp, -ECONNRESET );
846
847         return -ECONNRESET;
848 }
849
850 /**
851  * Process received packet
852  *
853  * @v iobuf             I/O buffer
854  * @v st_src            Partially-filled source address
855  * @v st_dest           Partially-filled destination address
856  * @v pshdr_csum        Pseudo-header checksum
857  * @ret rc              Return status code
858   */
859 static int tcp_rx ( struct io_buffer *iobuf,
860                     struct sockaddr_tcpip *st_src,
861                     struct sockaddr_tcpip *st_dest __unused,
862                     uint16_t pshdr_csum ) {
863         struct tcp_header *tcphdr = iobuf->data;
864         struct tcp_connection *tcp;
865         struct tcp_options options;
866         size_t hlen;
867         uint16_t csum;
868         uint32_t start_seq;
869         uint32_t seq;
870         uint32_t ack;
871         uint32_t win;
872         unsigned int flags;
873         size_t len;
874         int rc;
875
876         /* Sanity check packet */
877         if ( iob_len ( iobuf ) < sizeof ( *tcphdr ) ) {
878                 DBG ( "TCP packet too short at %zd bytes (min %zd bytes)\n",
879                       iob_len ( iobuf ), sizeof ( *tcphdr ) );
880                 rc = -EINVAL;
881                 goto discard;
882         }
883         hlen = ( ( tcphdr->hlen & TCP_MASK_HLEN ) / 16 ) * 4;
884         if ( hlen < sizeof ( *tcphdr ) ) {
885                 DBG ( "TCP header too short at %zd bytes (min %zd bytes)\n",
886                       hlen, sizeof ( *tcphdr ) );
887                 rc = -EINVAL;
888                 goto discard;
889         }
890         if ( hlen > iob_len ( iobuf ) ) {
891                 DBG ( "TCP header too long at %zd bytes (max %zd bytes)\n",
892                       hlen, iob_len ( iobuf ) );
893                 rc = -EINVAL;
894                 goto discard;
895         }
896         csum = tcpip_continue_chksum ( pshdr_csum, iobuf->data,
897                                        iob_len ( iobuf ) );
898         if ( csum != 0 ) {
899                 DBG ( "TCP checksum incorrect (is %04x including checksum "
900                       "field, should be 0000)\n", csum );
901                 rc = -EINVAL;
902                 goto discard;
903         }
904         
905         /* Parse parameters from header and strip header */
906         tcp = tcp_demux ( tcphdr->dest );
907         start_seq = seq = ntohl ( tcphdr->seq );
908         ack = ntohl ( tcphdr->ack );
909         win = ntohs ( tcphdr->win );
910         flags = tcphdr->flags;
911         tcp_rx_opts ( tcp, ( ( ( void * ) tcphdr ) + sizeof ( *tcphdr ) ),
912                       ( hlen - sizeof ( *tcphdr ) ), &options );
913         iob_pull ( iobuf, hlen );
914         len = iob_len ( iobuf );
915
916         /* Dump header */
917         DBGC2 ( tcp, "TCP %p RX %d<-%d           %08x %08x..%08zx %4zd",
918                 tcp, ntohs ( tcphdr->dest ), ntohs ( tcphdr->src ),
919                 ntohl ( tcphdr->ack ), ntohl ( tcphdr->seq ),
920                 ( ntohl ( tcphdr->seq ) + len +
921                   ( ( tcphdr->flags & ( TCP_SYN | TCP_FIN ) ) ? 1 : 0 )), len);
922         tcp_dump_flags ( tcp, tcphdr->flags );
923         DBGC2 ( tcp, "\n" );
924
925         /* If no connection was found, send RST */
926         if ( ! tcp ) {
927                 tcp_xmit_reset ( tcp, st_src, tcphdr );
928                 rc = -ENOTCONN;
929                 goto discard;
930         }
931
932         /* Handle ACK, if present */
933         if ( flags & TCP_ACK ) {
934                 if ( ( rc = tcp_rx_ack ( tcp, ack, win ) ) != 0 ) {
935                         tcp_xmit_reset ( tcp, st_src, tcphdr );
936                         goto discard;
937                 }
938         }
939
940         /* Handle SYN, if present */
941         if ( flags & TCP_SYN ) {
942                 tcp_rx_syn ( tcp, seq, &options );
943                 seq++;
944         }
945
946         /* Handle RST, if present */
947         if ( flags & TCP_RST ) {
948                 if ( ( rc = tcp_rx_rst ( tcp, seq ) ) != 0 )
949                         goto discard;
950         }
951
952         /* Handle new data, if any */
953         tcp_rx_data ( tcp, seq, iobuf );
954         seq += len;
955
956         /* Handle FIN, if present */
957         if ( flags & TCP_FIN ) {
958                 tcp_rx_fin ( tcp, seq );
959                 seq++;
960         }
961
962         /* Update timestamp, if present and applicable */
963         if ( ( seq == tcp->rcv_ack ) && options.tsopt )
964                 tcp->ts_recent = ntohl ( options.tsopt->tsval );
965
966         /* Dump out any state change as a result of the received packet */
967         tcp_dump_state ( tcp );
968
969         /* Send out any pending data.  We force sending a reply if either
970          *
971          *  a) the peer is expecting an ACK (i.e. consumed sequence space), or
972          *  b) either end of the packet was outside the receive window
973          *
974          * Case (b) enables us to support TCP keepalives using
975          * zero-length packets, which we would otherwise ignore.  Note
976          * that for case (b), we need *only* consider zero-length
977          * packets, since non-zero-length packets will already be
978          * caught by case (a).
979          */
980         tcp_xmit ( tcp, ( ( start_seq != seq ) ||
981                           ( ( seq - tcp->rcv_ack ) > tcp->rcv_win ) ) );
982
983         /* If this packet was the last we expect to receive, set up
984          * timer to expire and cause the connection to be freed.
985          */
986         if ( TCP_CLOSED_GRACEFULLY ( tcp->tcp_state ) ) {
987                 tcp->timer.timeout = ( 2 * TCP_MSL );
988                 start_timer ( &tcp->timer );
989         }
990
991         return 0;
992
993  discard:
994         /* Free received packet */
995         free_iob ( iobuf );
996         return rc;
997 }
998
999 /** TCP protocol */
1000 struct tcpip_protocol tcp_protocol __tcpip_protocol = {
1001         .name = "TCP",
1002         .rx = tcp_rx,
1003         .tcpip_proto = IP_TCP,
1004 };
1005
1006 /***************************************************************************
1007  *
1008  * Data transfer interface
1009  *
1010  ***************************************************************************
1011  */
1012
1013 /**
1014  * Close interface
1015  *
1016  * @v xfer              Data transfer interface
1017  * @v rc                Reason for close
1018  */
1019 static void tcp_xfer_close ( struct xfer_interface *xfer, int rc ) {
1020         struct tcp_connection *tcp =
1021                 container_of ( xfer, struct tcp_connection, xfer );
1022
1023         /* Close data transfer interface */
1024         tcp_close ( tcp, rc );
1025
1026         /* Transmit FIN, if possible */
1027         tcp_xmit ( tcp, 0 );
1028 }
1029
1030 /**
1031  * Check flow control window
1032  *
1033  * @v xfer              Data transfer interface
1034  * @ret len             Length of window
1035  */
1036 static size_t tcp_xfer_window ( struct xfer_interface *xfer ) {
1037         struct tcp_connection *tcp =
1038                 container_of ( xfer, struct tcp_connection, xfer );
1039
1040         /* Not ready if data queue is non-empty.  This imposes a limit
1041          * of only one unACKed packet in the TX queue at any time; we
1042          * do this to conserve memory usage.
1043          */
1044         if ( ! list_empty ( &tcp->queue ) )
1045                 return 0;
1046
1047         /* Return TCP window length */
1048         return tcp_xmit_win ( tcp );
1049 }
1050
1051 /**
1052  * Deliver datagram as I/O buffer
1053  *
1054  * @v xfer              Data transfer interface
1055  * @v iobuf             Datagram I/O buffer
1056  * @v meta              Data transfer metadata
1057  * @ret rc              Return status code
1058  */
1059 static int tcp_xfer_deliver_iob ( struct xfer_interface *xfer,
1060                                   struct io_buffer *iobuf,
1061                                   struct xfer_metadata *meta __unused ) {
1062         struct tcp_connection *tcp =
1063                 container_of ( xfer, struct tcp_connection, xfer );
1064
1065         /* Enqueue packet */
1066         list_add_tail ( &iobuf->list, &tcp->queue );
1067
1068         /* Transmit data, if possible */
1069         tcp_xmit ( tcp, 0 );
1070
1071         return 0;
1072 }
1073
1074 /** TCP data transfer interface operations */
1075 static struct xfer_interface_operations tcp_xfer_operations = {
1076         .close          = tcp_xfer_close,
1077         .vredirect      = ignore_xfer_vredirect,
1078         .window         = tcp_xfer_window,
1079         .alloc_iob      = default_xfer_alloc_iob,
1080         .deliver_iob    = tcp_xfer_deliver_iob,
1081         .deliver_raw    = xfer_deliver_as_iob,
1082 };
1083
1084 /***************************************************************************
1085  *
1086  * Openers
1087  *
1088  ***************************************************************************
1089  */
1090
1091 /** TCP socket opener */
1092 struct socket_opener tcp_socket_opener __socket_opener = {
1093         .semantics      = TCP_SOCK_STREAM,
1094         .family         = AF_INET,
1095         .open           = tcp_open,
1096 };
1097
1098 /** Linkage hack */
1099 int tcp_sock_stream = TCP_SOCK_STREAM;
1100
1101 /**
1102  * Open TCP URI
1103  *
1104  * @v xfer              Data transfer interface
1105  * @v uri               URI
1106  * @ret rc              Return status code
1107  */
1108 static int tcp_open_uri ( struct xfer_interface *xfer, struct uri *uri ) {
1109         struct sockaddr_tcpip peer;
1110
1111         /* Sanity check */
1112         if ( ! uri->host )
1113                 return -EINVAL;
1114
1115         memset ( &peer, 0, sizeof ( peer ) );
1116         peer.st_port = htons ( uri_port ( uri, 0 ) );
1117         return xfer_open_named_socket ( xfer, SOCK_STREAM,
1118                                         ( struct sockaddr * ) &peer,
1119                                         uri->host, NULL );
1120 }
1121
1122 /** TCP URI opener */
1123 struct uri_opener tcp_uri_opener __uri_opener = {
1124         .scheme         = "tcp",
1125         .open           = tcp_open_uri,
1126 };
1127