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