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