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