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