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