b1ed0c09a0f016f054bb815e45061ff03e05790f
[gpxe.git] / src / net / tcp.c
1 #include <string.h>
2 #include <stdlib.h>
3 #include <assert.h>
4 #include <errno.h>
5 #include <byteswap.h>
6 #include <timer.h>
7 #include <vsprintf.h>
8 #include <gpxe/pkbuff.h>
9 #include <gpxe/retry.h>
10 #include <gpxe/tcpip.h>
11 #include <gpxe/tcp.h>
12
13 /** @file
14  *
15  * TCP protocol
16  *
17  */
18
19 static void tcp_expired ( struct retry_timer *timer, int over );
20
21 /**
22  * A TCP connection
23  *
24  * This data structure represents the internal state of a TCP
25  * connection.  It is kept separate from @c struct @c tcp_application
26  * because the internal state is still required for some time after
27  * the application closes the connection.
28  */
29 struct tcp_connection {
30         /** List of TCP connections */
31         struct list_head list;
32         /** The associated TCP application, if any */
33         struct tcp_application *app;
34
35         /** Remote socket address */
36         struct sockaddr_tcpip peer;
37         /** Local port, in network byte order */
38         uint16_t 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 packet buffer
69          *
70          * This buffer is allocated prior to calling the application's
71          * senddata() method, to provide temporary storage space.
72          */
73         struct pk_buff *tx_pkb;
74         /** Retransmission timer */
75         struct retry_timer timer;
76 };
77
78 /**
79  * List of registered TCP connections
80  */
81 static LIST_HEAD ( tcp_conns );
82
83 /**
84  * Name TCP state
85  *
86  * @v state             TCP state
87  * @ret name            Name of TCP state
88  */
89 static inline __attribute__ (( always_inline )) const char *
90 tcp_state ( int state ) {
91         switch ( state ) {
92         case TCP_CLOSED:                return "CLOSED";
93         case TCP_LISTEN:                return "LISTEN";
94         case TCP_SYN_SENT:              return "SYN_SENT";
95         case TCP_SYN_RCVD:              return "SYN_RCVD";
96         case TCP_ESTABLISHED:           return "ESTABLISHED";
97         case TCP_FIN_WAIT_1:            return "FIN_WAIT_1";
98         case TCP_FIN_WAIT_2:            return "FIN_WAIT_2";
99         case TCP_CLOSING_OR_LAST_ACK:   return "CLOSING/LAST_ACK";
100         case TCP_TIME_WAIT:             return "TIME_WAIT";
101         case TCP_CLOSE_WAIT:            return "CLOSE_WAIT";
102         default:                        return "INVALID";
103         }
104 }
105
106 /**
107  * Dump TCP state transition
108  *
109  * @v conn              TCP connection
110  */
111 static inline __attribute__ (( always_inline )) void
112 tcp_dump_state ( struct tcp_connection *conn ) {
113
114         if ( conn->tcp_state != conn->prev_tcp_state ) {
115                 DBGC ( conn, "TCP %p transitioned from %s to %s\n", conn,
116                        tcp_state ( conn->prev_tcp_state ),
117                        tcp_state ( conn->tcp_state ) );
118         }
119         conn->prev_tcp_state = conn->tcp_state;
120 }
121
122 /**
123  * Dump TCP flags
124  *
125  * @v flags             TCP flags
126  */
127 static inline __attribute__ (( always_inline )) void
128 tcp_dump_flags ( struct tcp_connection *conn, unsigned int flags ) {
129         if ( flags & TCP_RST )
130                 DBGC ( conn, " RST" );
131         if ( flags & TCP_SYN )
132                 DBGC ( conn, " SYN" );
133         if ( flags & TCP_PSH )
134                 DBGC ( conn, " PSH" );
135         if ( flags & TCP_FIN )
136                 DBGC ( conn, " FIN" );
137         if ( flags & TCP_ACK )
138                 DBGC ( conn, " ACK" );
139 }
140
141 /**
142  * Allocate TCP connection
143  *
144  * @ret conn            TCP connection, or NULL
145  *
146  * Allocates TCP connection and adds it to the TCP connection list.
147  */
148 static struct tcp_connection * alloc_tcp ( void ) {
149         struct tcp_connection *conn;
150
151         conn = calloc ( 1, sizeof ( *conn ) );
152         if ( conn ) {
153                 DBGC ( conn, "TCP %p allocated\n", conn );
154                 conn->tcp_state = conn->prev_tcp_state = TCP_CLOSED;
155                 conn->snd_seq = random();
156                 conn->timer.expired = tcp_expired;
157                 list_add ( &conn->list, &tcp_conns );
158         }
159         return conn;
160 }
161
162 /**
163  * Free TCP connection
164  *
165  * @v conn              TCP connection
166  *
167  * Removes connection from TCP connection list and frees the data
168  * structure.
169  */
170 static void free_tcp ( struct tcp_connection *conn ) {
171
172         assert ( conn );
173         assert ( conn->tcp_state == TCP_CLOSED );
174         assert ( conn->app == NULL );
175
176         stop_timer ( &conn->timer );
177         list_del ( &conn->list );
178         free ( conn );
179         DBGC ( conn, "TCP %p freed\n", conn );
180 }
181
182 /**
183  * Associate TCP connection with application
184  *
185  * @v conn              TCP connection
186  * @v app               TCP application
187  */
188 static void tcp_associate ( struct tcp_connection *conn,
189                             struct tcp_application *app ) {
190         assert ( conn->app == NULL );
191         assert ( app->conn == NULL );
192         conn->app = app;
193         app->conn = conn;
194         DBGC ( conn, "TCP %p associated with application %p\n", conn, app );
195 }
196
197 /**
198  * Disassociate TCP connection from application
199  *
200  * @v conn              TCP connection
201  */
202 static void tcp_disassociate ( struct tcp_connection *conn ) {
203         struct tcp_application *app = conn->app;
204
205         if ( app ) {
206                 assert ( app->conn == conn );
207                 conn->app = NULL;
208                 app->conn = NULL;
209                 DBGC ( conn, "TCP %p disassociated from application %p\n",
210                        conn, app );
211         }
212 }
213
214 /**
215  * Transmit any outstanding data
216  *
217  * @v conn              TCP connection
218  * @v force_send        Force sending of packet
219  * 
220  * Transmits any outstanding data on the connection.  If the
221  * connection is in a connected state, the application's senddata()
222  * method will be called to generate the data payload, if any.
223  *
224  * Note that even if an error is returned, the retransmission timer
225  * will have been started if necessary, and so the stack will
226  * eventually attempt to retransmit the failed packet.
227  */
228 static int tcp_senddata_conn ( struct tcp_connection *conn, int force_send ) {
229         struct tcp_application *app = conn->app;
230         struct pk_buff *pkb;
231         struct tcp_header *tcphdr;
232         unsigned int flags;
233         size_t len;
234         size_t seq_len;
235
236         /* Allocate space to the TX buffer */
237         pkb = alloc_pkb ( MAX_PKB_LEN );
238         if ( ! pkb ) {
239                 DBGC ( conn, "TCP %p could not allocate data buffer\n", conn );
240                 /* Start the retry timer so that we attempt to
241                  * retransmit this packet later.  (Start it
242                  * unconditionally, since without a packet buffer we
243                  * can't call the senddata() callback, and so may not
244                  * be able to tell whether or not we have something
245                  * that actually needs to be retransmitted).
246                  */
247                 start_timer ( &conn->timer );
248                 return -ENOMEM;
249         }
250         pkb_reserve ( pkb, MAX_HDR_LEN );
251
252         /* If we are connected, call the senddata() method, which may
253          * call tcp_send() to queue up a data payload.
254          */
255         if ( TCP_CAN_SEND_DATA ( conn->tcp_state ) &&
256              app && app->tcp_op->senddata ) {
257                 conn->tx_pkb = pkb;
258                 app->tcp_op->senddata ( app, pkb->data, pkb_tailroom ( pkb ) );
259                 conn->tx_pkb = NULL;
260         }
261
262         /* Truncate payload length to fit transmit window */
263         len = pkb_len ( pkb );
264         if ( len > conn->snd_win )
265                 len = conn->snd_win;
266
267         /* Calculate amount of sequence space that this transmission
268          * consumes.  (SYN or FIN consume one byte, and we can never
269          * send both at once).
270          */
271         seq_len = len;
272         flags = TCP_FLAGS_SENDING ( conn->tcp_state );
273         assert ( ! ( ( flags & TCP_SYN ) && ( flags & TCP_FIN ) ) );
274         if ( flags & ( TCP_SYN | TCP_FIN ) )
275                 seq_len++;
276         conn->snd_sent = seq_len;
277
278         /* If we have nothing to transmit, drop the packet */
279         if ( ( seq_len == 0 ) && ! force_send ) {
280                 free_pkb ( pkb );
281                 return 0;
282         }
283
284         /* If we are transmitting anything that requires
285          * acknowledgement (i.e. consumes sequence space), start the
286          * retransmission timer.
287          */
288         if ( seq_len )
289                 start_timer ( &conn->timer );
290
291         /* Fill up the TCP header */
292         tcphdr = pkb_push ( pkb, sizeof ( *tcphdr ) );
293         memset ( tcphdr, 0, sizeof ( *tcphdr ) );
294         tcphdr->src = conn->local_port;
295         tcphdr->dest = conn->peer.st_port;
296         tcphdr->seq = htonl ( conn->snd_seq );
297         tcphdr->ack = htonl ( conn->rcv_ack );
298         tcphdr->hlen = ( ( sizeof ( *tcphdr ) / 4 ) << 4 );
299         tcphdr->flags = flags;
300         tcphdr->win = htons ( TCP_WINDOW_SIZE );
301         tcphdr->csum = tcpip_chksum ( pkb->data, pkb_len ( pkb ) );
302
303         /* Dump header */
304         DBGC ( conn, "TCP %p TX %d->%d %08lx..%08lx           %08lx %4zd",
305                conn, ntohs ( tcphdr->src ), ntohs ( tcphdr->dest ),
306                ntohl ( tcphdr->seq ), ( ntohl ( tcphdr->seq ) + seq_len ),
307                ntohl ( tcphdr->ack ), len );
308         tcp_dump_flags ( conn, tcphdr->flags );
309         DBGC ( conn, "\n" );
310
311         /* Transmit packet */
312         return tcpip_tx ( pkb, &tcp_protocol, &conn->peer, &tcphdr->csum );
313 }
314
315 /**
316  * Transmit any outstanding data
317  *
318  * @v conn      TCP connection
319  * 
320  * This function allocates space to the transmit buffer and invokes
321  * the senddata() callback function, to allow the application to
322  * transmit new data.
323  */
324 int tcp_senddata ( struct tcp_application *app ) {
325         struct tcp_connection *conn = app->conn;
326
327         /* Check connection actually exists */
328         if ( ! conn ) {
329                 DBG ( "TCP app %p has no connection\n", app );
330                 return -ENOTCONN;
331         }
332
333         return tcp_senddata_conn ( conn, 0 );
334 }
335
336 /**
337  * Transmit data
338  *
339  * @v app               TCP application
340  * @v data              Data to be sent
341  * @v len               Length of the data
342  * @ret rc              Return status code
343  *
344  * This function queues data to be sent via the TCP connection.  It
345  * can be called only in the context of an application's senddata()
346  * method.
347  */
348 int tcp_send ( struct tcp_application *app, const void *data, size_t len ) {
349         struct tcp_connection *conn = app->conn;
350         struct pk_buff *pkb;
351
352         /* Check connection actually exists */
353         if ( ! conn ) {
354                 DBG ( "TCP app %p has no connection\n", app );
355                 return -ENOTCONN;
356         }
357
358         /* Check that we have a packet buffer to fill */
359         pkb = conn->tx_pkb;
360         if ( ! pkb ) {
361                 DBG ( "TCP app %p tried to send data outside of the "
362                       "senddata() method\n", app );
363                 return -EINVAL;
364         }
365
366         /* Truncate length to fit packet buffer */
367         if ( len > pkb_tailroom ( pkb ) )
368                 len = pkb_tailroom ( pkb );
369
370         /* Copy payload */
371         memmove ( pkb_put ( pkb, len ), data, len );
372
373         return 0;
374 }
375
376 /**
377  * Retransmission timer expired
378  *
379  * @v timer     Retry timer
380  * @v over      Failure indicator
381  */
382 static void tcp_expired ( struct retry_timer *timer, int over ) {
383         struct tcp_connection *conn =
384                 container_of ( timer, struct tcp_connection, timer );
385         struct tcp_application *app = conn->app;
386         int graceful_close = TCP_CLOSED_GRACEFULLY ( conn->tcp_state );
387
388         DBGC ( conn, "TCP %p timer %s in %s\n", conn,
389                ( over ? "expired" : "fired" ), tcp_state ( conn->tcp_state ) );
390
391         assert ( ( conn->tcp_state == TCP_SYN_SENT ) ||
392                  ( conn->tcp_state == TCP_SYN_RCVD ) ||
393                  ( conn->tcp_state == TCP_ESTABLISHED ) ||
394                  ( conn->tcp_state == TCP_FIN_WAIT_1 ) ||
395                  ( conn->tcp_state == TCP_TIME_WAIT ) ||
396                  ( conn->tcp_state == TCP_CLOSE_WAIT ) ||
397                  ( conn->tcp_state == TCP_CLOSING_OR_LAST_ACK ) );
398
399         /* If we have finally timed out and given up, or if this is
400          * the result of a graceful close, terminate the connection
401          */
402         if ( over || graceful_close ) {
403
404                 /* Transition to CLOSED */
405                 conn->tcp_state = TCP_CLOSED;
406                 tcp_dump_state ( conn );
407
408                 /* If we haven't closed gracefully, send a RST */
409                 if ( ! graceful_close )
410                         tcp_senddata_conn ( conn, 1 );
411
412                 /* Break association between application and connection */
413                 tcp_disassociate ( conn );
414
415                 /* Free the connection */
416                 free_tcp ( conn );
417
418                 /* Notify application */
419                 if ( app && app->tcp_op->closed )
420                         app->tcp_op->closed ( app, -ETIMEDOUT );
421
422         } else {
423                 /* Otherwise, retransmit the packet */
424                 tcp_senddata_conn ( conn, 0 );
425         }
426 }
427
428 /**
429  * Send RST response to incoming packet
430  *
431  * @v in_tcphdr         TCP header of incoming packet
432  * @ret rc              Return status code
433  */
434 static int tcp_send_reset ( struct tcp_connection *conn,
435                             struct tcp_header *in_tcphdr ) {
436         struct pk_buff *pkb;
437         struct tcp_header *tcphdr;
438
439         /* Allocate space for dataless TX buffer */
440         pkb = alloc_pkb ( MAX_HDR_LEN );
441         if ( ! pkb ) {
442                 DBGC ( conn, "TCP %p could not allocate data buffer\n", conn );
443                 return -ENOMEM;
444         }
445         pkb_reserve ( pkb, MAX_HDR_LEN );
446
447         /* Construct RST response */
448         tcphdr = pkb_push ( pkb, sizeof ( *tcphdr ) );
449         memset ( tcphdr, 0, sizeof ( *tcphdr ) );
450         tcphdr->src = in_tcphdr->dest;
451         tcphdr->dest = in_tcphdr->src;
452         tcphdr->seq = in_tcphdr->ack;
453         tcphdr->ack = in_tcphdr->seq;
454         tcphdr->hlen = ( ( sizeof ( *tcphdr ) / 4 ) << 4 );
455         tcphdr->flags = ( TCP_RST | TCP_ACK );
456         tcphdr->win = htons ( TCP_WINDOW_SIZE );
457         tcphdr->csum = tcpip_chksum ( pkb->data, pkb_len ( pkb ) );
458
459         /* Dump header */
460         DBGC ( conn, "TCP %p TX %d->%d %08lx..%08lx           %08lx %4zd",
461                conn, ntohs ( tcphdr->src ), ntohs ( tcphdr->dest ),
462                ntohl ( tcphdr->seq ), ( ntohl ( tcphdr->seq ) ),
463                ntohl ( tcphdr->ack ), 0 );
464         tcp_dump_flags ( conn, tcphdr->flags );
465         DBGC ( conn, "\n" );
466
467         /* Transmit packet */
468         return tcpip_tx ( pkb, &tcp_protocol, &conn->peer, &tcphdr->csum );
469 }
470
471 /**
472  * Identify TCP connection by local port number
473  *
474  * @v local_port        Local port (in network-endian order)
475  * @ret conn            TCP connection, or NULL
476  */
477 static struct tcp_connection * tcp_demux ( uint16_t local_port ) {
478         struct tcp_connection *conn;
479
480         list_for_each_entry ( conn, &tcp_conns, list ) {
481                 if ( conn->local_port == local_port )
482                         return conn;
483         }
484         return NULL;
485 }
486
487 /**
488  * Handle TCP received SYN
489  *
490  * @v conn              TCP connection
491  * @v seq               SEQ value (in host-endian order)
492  * @ret rc              Return status code
493  */
494 static int tcp_rx_syn ( struct tcp_connection *conn, uint32_t seq ) {
495         struct tcp_application *app = conn->app;
496
497         /* Synchronise sequence numbers on first SYN */
498         if ( ! ( conn->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) )
499                 conn->rcv_ack = seq;
500
501         /* Ignore duplicate SYN */
502         if ( ( conn->rcv_ack - seq ) > 0 )
503                 return 0;
504
505         /* Mark SYN as received and start sending ACKs with each packet */
506         conn->tcp_state |= ( TCP_STATE_SENT ( TCP_ACK ) |
507                              TCP_STATE_RCVD ( TCP_SYN ) );
508
509         /* Acknowledge SYN */
510         conn->rcv_ack++;
511
512         /* Notify application of established connection, if applicable */
513         if ( ( conn->tcp_state & TCP_STATE_ACKED ( TCP_SYN ) ) &&
514              app && app->tcp_op->connected )
515                 app->tcp_op->connected ( app );
516
517         return 0;
518 }
519
520 /**
521  * Handle TCP received ACK
522  *
523  * @v conn              TCP connection
524  * @v ack               ACK value (in host-endian order)
525  * @v win               WIN value (in host-endian order)
526  * @ret rc              Return status code
527  */
528 static int tcp_rx_ack ( struct tcp_connection *conn, uint32_t ack,
529                         uint32_t win ) {
530         struct tcp_application *app = conn->app;
531         size_t ack_len = ( ack - conn->snd_seq );
532         size_t len;
533         unsigned int acked_flags = 0;
534
535         /* Ignore duplicate or out-of-range ACK */
536         if ( ack_len > conn->snd_sent ) {
537                 DBGC ( conn, "TCP %p received ACK for [%08lx,%08lx), "
538                        "sent only [%08lx,%08lx)\n", conn, conn->snd_seq,
539                        ( conn->snd_seq + ack_len ), conn->snd_seq,
540                        ( conn->snd_seq + conn->snd_sent ) );
541                 return -EINVAL;
542         }
543
544         /* If we are sending flags and this ACK acknowledges all
545          * outstanding sequence points, then it acknowledges the
546          * flags.  (This works since both SYN and FIN will always be
547          * the last outstanding sequence point.)
548          */
549         len = ack_len;
550         if ( ack_len == conn->snd_sent ) {
551                 acked_flags = ( TCP_FLAGS_SENDING ( conn->tcp_state ) &
552                                 ( TCP_SYN | TCP_FIN ) );
553                 if ( acked_flags )
554                         len--;
555         }
556
557         /* Update SEQ and sent counters, and window size */
558         conn->snd_seq = ack;
559         conn->snd_sent = 0;
560         conn->snd_win = win;
561
562         /* Stop the retransmission timer */
563         stop_timer ( &conn->timer );
564
565         /* Notify application of acknowledged data, if any */
566         if ( len && app && app->tcp_op->acked )
567                 app->tcp_op->acked ( app, len );
568
569         /* Mark SYN/FIN as acknowledged if applicable. */
570         if ( acked_flags )
571                 conn->tcp_state |= TCP_STATE_ACKED ( acked_flags );
572
573         /* Notify application of established connection, if applicable */
574         if ( ( acked_flags & TCP_SYN ) &&
575              ( conn->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) &&
576              app && app->tcp_op->connected )
577                 app->tcp_op->connected ( app );
578
579         return 0;
580 }
581
582 /**
583  * Handle TCP received data
584  *
585  * @v conn              TCP connection
586  * @v seq               SEQ value (in host-endian order)
587  * @v data              Data buffer
588  * @v len               Length of data buffer
589  * @ret rc              Return status code
590  */
591 static int tcp_rx_data ( struct tcp_connection *conn, uint32_t seq,
592                          void *data, size_t len ) {
593         struct tcp_application *app = conn->app;
594         size_t already_rcvd;
595
596         /* Ignore duplicate data */
597         already_rcvd = ( conn->rcv_ack - seq );
598         if ( already_rcvd >= len )
599                 return 0;
600         data += already_rcvd;
601         len -= already_rcvd;
602
603         /* Acknowledge new data */
604         conn->rcv_ack += len;
605
606         /* Notify application */
607         if ( app && app->tcp_op->newdata )
608                 app->tcp_op->newdata ( app, data, len );
609
610         return 0;
611 }
612
613 /**
614  * Handle TCP received FIN
615  *
616  * @v conn              TCP connection
617  * @v seq               SEQ value (in host-endian order)
618  * @ret rc              Return status code
619  */
620 static int tcp_rx_fin ( struct tcp_connection *conn, uint32_t seq ) {
621         struct tcp_application *app = conn->app;
622
623         /* Ignore duplicate FIN */
624         if ( ( conn->rcv_ack - seq ) > 0 )
625                 return 0;
626
627         /* Mark FIN as received, acknowledge it, and send our own FIN */
628         conn->tcp_state |= ( TCP_STATE_RCVD ( TCP_FIN ) |
629                              TCP_STATE_SENT ( TCP_FIN ) );
630         conn->rcv_ack++;
631
632         /* Break association with application */
633         tcp_disassociate ( conn );
634
635         /* Notify application */
636         if ( app && app->tcp_op->closed )
637                 app->tcp_op->closed ( app, 0 );
638
639         return 0;
640 }
641
642 /**
643  * Handle TCP received RST
644  *
645  * @v conn              TCP connection
646  * @v seq               SEQ value (in host-endian order)
647  * @ret rc              Return status code
648  */
649 static int tcp_rx_rst ( struct tcp_connection *conn, uint32_t seq ) {
650         struct tcp_application *app = conn->app;
651
652         /* Accept RST only if it falls within the window.  If we have
653          * not yet received a SYN, then we have no window to test
654          * against, so fall back to checking that our SYN has been
655          * ACKed.
656          */
657         if ( conn->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) {
658                 if ( ( conn->rcv_ack - seq ) > 0 )
659                         return 0;
660         } else {
661                 if ( ! ( conn->tcp_state & TCP_STATE_ACKED ( TCP_SYN ) ) )
662                         return 0;
663         }
664
665         /* Transition to CLOSED */
666         conn->tcp_state = TCP_CLOSED;
667         tcp_dump_state ( conn );
668
669         /* Break association between application and connection */
670         tcp_disassociate ( conn );
671         
672         /* Free the connection */
673         free_tcp ( conn );
674         
675         /* Notify application */
676         if ( app && app->tcp_op->closed )
677                 app->tcp_op->closed ( app, -ECONNRESET );
678
679         return -ECONNRESET;
680 }
681
682 /**
683  * Process received packet
684  *
685  * @v pkb               Packet buffer
686  * @v st_src            Partially-filled source address
687  * @v st_dest           Partially-filled destination address
688  * @v pshdr_csum        Pseudo-header checksum
689  * @ret rc              Return status code
690   */
691 static int tcp_rx ( struct pk_buff *pkb,
692                     struct sockaddr_tcpip *st_src __unused,
693                     struct sockaddr_tcpip *st_dest __unused,
694                     uint16_t pshdr_csum ) {
695         struct tcp_header *tcphdr = pkb->data;
696         struct tcp_connection *conn;
697         unsigned int hlen;
698         uint16_t csum;
699         uint32_t start_seq;
700         uint32_t seq;
701         uint32_t ack;
702         uint32_t win;
703         unsigned int flags;
704         void *data;
705         size_t len;
706         int rc;
707
708         /* Sanity check packet */
709         if ( pkb_len ( pkb ) < sizeof ( *tcphdr ) ) {
710                 DBG ( "TCP packet too short at %d bytes (min %d bytes)\n",
711                       pkb_len ( pkb ), sizeof ( *tcphdr ) );
712                 rc = -EINVAL;
713                 goto done;
714         }
715         hlen = ( ( tcphdr->hlen & TCP_MASK_HLEN ) / 16 ) * 4;
716         if ( hlen < sizeof ( *tcphdr ) ) {
717                 DBG ( "TCP header too short at %d bytes (min %d bytes)\n",
718                       hlen, sizeof ( *tcphdr ) );
719                 rc = -EINVAL;
720                 goto done;
721         }
722         if ( hlen > pkb_len ( pkb ) ) {
723                 DBG ( "TCP header too long at %d bytes (max %d bytes)\n",
724                       hlen, pkb_len ( pkb ) );
725                 rc = -EINVAL;
726                 goto done;
727         }
728         csum = tcpip_continue_chksum ( pshdr_csum, pkb->data, pkb_len ( pkb ));
729         if ( csum != 0 ) {
730                 DBG ( "TCP checksum incorrect (is %04x including checksum "
731                       "field, should be 0000)\n", csum );
732                 rc = -EINVAL;
733                 goto done;
734         }
735         
736         /* Parse parameters from header and strip header */
737         conn = tcp_demux ( tcphdr->dest );
738         start_seq = seq = ntohl ( tcphdr->seq );
739         ack = ntohl ( tcphdr->ack );
740         win = ntohs ( tcphdr->win );
741         flags = tcphdr->flags;
742         data = pkb_pull ( pkb, hlen );
743         len = pkb_len ( pkb );
744
745         /* Dump header */
746         DBGC ( conn, "TCP %p RX %d<-%d           %08lx %08lx..%08lx %4zd",
747                conn, ntohs ( tcphdr->dest ), ntohs ( tcphdr->src ),
748                ntohl ( tcphdr->ack ), ntohl ( tcphdr->seq ),
749                ( ntohl ( tcphdr->seq ) + len +
750                  ( ( tcphdr->flags & ( TCP_SYN | TCP_FIN ) ) ? 1 : 0 ) ), len);
751         tcp_dump_flags ( conn, tcphdr->flags );
752         DBGC ( conn, "\n" );
753
754         /* If no connection was found, send RST */
755         if ( ! conn ) {
756                 tcp_send_reset ( conn, tcphdr );
757                 rc = -ENOTCONN;
758                 goto done;
759         }
760
761         /* Handle ACK, if present */
762         if ( flags & TCP_ACK ) {
763                 if ( ( rc = tcp_rx_ack ( conn, ack, win ) ) != 0 ) {
764                         tcp_send_reset ( conn, tcphdr );
765                         goto done;
766                 }
767         }
768
769         /* Handle SYN, if present */
770         if ( flags & TCP_SYN ) {
771                 tcp_rx_syn ( conn, seq );
772                 seq++;
773         }
774
775         /* Handle RST, if present */
776         if ( flags & TCP_RST ) {
777                 if ( ( rc = tcp_rx_rst ( conn, seq ) ) != 0 )
778                         goto done;
779         }
780
781         /* Handle new data, if any */
782         tcp_rx_data ( conn, seq, data, len );
783         seq += len;
784
785         /* Handle FIN, if present */
786         if ( flags & TCP_FIN ) {
787                 tcp_rx_fin ( conn, seq );
788                 seq++;
789         }
790
791         /* Dump out any state change as a result of the received packet */
792         tcp_dump_state ( conn );
793
794         /* Send out any pending data.  If peer is expecting an ACK for
795          * this packet then force sending a reply.
796          */
797         tcp_senddata_conn ( conn, ( start_seq != seq ) );
798
799         /* If this packet was the last we expect to receive, set up
800          * timer to expire and cause the connection to be freed.
801          */
802         if ( TCP_CLOSED_GRACEFULLY ( conn->tcp_state ) ) {
803                 conn->timer.timeout = ( 2 * TCP_MSL );
804                 start_timer ( &conn->timer );
805         }
806
807         rc = 0;
808  done:
809         /* Free received packet */
810         free_pkb ( pkb );
811         return rc;
812 }
813
814 /**
815  * Bind TCP connection to local port
816  *
817  * @v conn              TCP connection
818  * @v local_port        Local port (in network byte order), or 0
819  * @ret rc              Return status code
820  *
821  * This function adds the connection to the list of registered TCP
822  * connections.  If the local port is 0, the connection is assigned an
823  * available port between 1024 and 65535.
824  */
825 static int tcp_bind ( struct tcp_connection *conn, uint16_t local_port ) {
826         struct tcp_connection *existing;
827         static uint16_t try_port = 1024;
828
829         /* If no port specified, find the first available port */
830         if ( ! local_port ) {
831                 for ( ; try_port ; try_port++ ) {
832                         if ( try_port < 1024 )
833                                 continue;
834                         if ( tcp_bind ( conn, htons ( try_port ) ) == 0 )
835                                 return 0;
836                 }
837                 DBGC ( conn, "TCP %p could not bind: no free ports\n", conn );
838                 return -EADDRINUSE;
839         }
840
841         /* Attempt bind to local port */
842         list_for_each_entry ( existing, &tcp_conns, list ) {
843                 if ( existing->local_port == local_port ) {
844                         DBGC ( conn, "TCP %p could not bind: port %d in use\n",
845                                conn, ntohs ( local_port ) );
846                         return -EADDRINUSE;
847                 }
848         }
849         conn->local_port = local_port;
850
851         DBGC ( conn, "TCP %p bound to port %d\n", conn, ntohs ( local_port ) );
852         return 0;
853 }
854
855 /**
856  * Connect to a remote server
857  *
858  * @v app               TCP application
859  * @v peer              Remote socket address
860  * @v local_port        Local port number (in network byte order), or 0
861  * @ret rc              Return status code
862  *
863  * This function initiates a TCP connection to the socket address specified in
864  * peer. It sends a SYN packet to peer. When the connection is established, the
865  * TCP stack calls the connected() callback function.
866  */
867 int tcp_connect ( struct tcp_application *app, struct sockaddr_tcpip *peer,
868                   uint16_t local_port ) {
869         struct tcp_connection *conn;
870         int rc;
871
872         /* Application must not already have an open connection */
873         if ( app->conn ) {
874                 DBG ( "TCP app %p already open on %p\n", app, app->conn );
875                 return -EISCONN;
876         }
877
878         /* Allocate connection state storage and add to connection list */
879         conn = alloc_tcp();
880         if ( ! conn ) {
881                 DBG ( "TCP app %p could not allocate connection\n", app );
882                 return -ENOMEM;
883         }
884
885         /* Bind to peer and to local port */
886         memcpy ( &conn->peer, peer, sizeof ( conn->peer ) );
887         if ( ( rc = tcp_bind ( conn, local_port ) ) != 0 ) {
888                 free_tcp ( conn );
889                 return rc;
890         }
891
892         /* Associate with application */
893         tcp_associate ( conn, app );
894
895         /* Transition to TCP_SYN_SENT and send the SYN */
896         conn->tcp_state = TCP_SYN_SENT;
897         tcp_dump_state ( conn );
898         tcp_senddata_conn ( conn, 0 );
899
900         return 0;
901 }
902
903 /**
904  * Close the connection
905  *
906  * @v app               TCP application
907  *
908  * The association between the application and the TCP connection is
909  * immediately severed, and the TCP application data structure can be
910  * reused or freed immediately.  The TCP connection will persist until
911  * the state machine has returned to the TCP_CLOSED state.
912  */
913 void tcp_close ( struct tcp_application *app ) {
914         struct tcp_connection *conn = app->conn;
915
916         /* If no connection exists, do nothing */
917         if ( ! conn )
918                 return;
919
920         /* Break association between application and connection */
921         tcp_disassociate ( conn );
922
923         /* If we have not yet received a SYN (i.e. we are in CLOSED,
924          * LISTEN or SYN_SENT), just delete the connection
925          */
926         if ( ! ( conn->tcp_state & TCP_STATE_RCVD ( TCP_SYN ) ) ) {
927                 conn->tcp_state = TCP_CLOSED;
928                 tcp_dump_state ( conn );
929                 free_tcp ( conn );
930                 return;
931         }
932
933         /* If we have not had our SYN acknowledged (i.e. we are in
934          * SYN_RCVD), pretend that it has been acknowledged so that we
935          * can send a FIN without breaking things.
936          */
937         if ( ! ( conn->tcp_state & TCP_STATE_ACKED ( TCP_SYN ) ) )
938                 tcp_rx_ack ( conn, ( conn->snd_seq + 1 ), 0 );
939
940         /* Send a FIN to initiate the close */
941         conn->tcp_state |= TCP_STATE_SENT ( TCP_FIN );
942         tcp_dump_state ( conn );
943         tcp_senddata_conn ( conn, 0 );
944 }
945
946 /** TCP protocol */
947 struct tcpip_protocol tcp_protocol __tcpip_protocol = {
948         .name = "TCP",
949         .rx = tcp_rx,
950         .tcpip_proto = IP_TCP,
951 };