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