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