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