src/net/tcp.c

   1 #include <string.h>
   2 #include <stdlib.h>
   3 #include <assert.h>
   4 #include <byteswap.h>
   5 #include <latch.h>
   6 #include <errno.h>
   7 #include <gpxe/process.h>
   8 #include <gpxe/init.h>
   9 #include <gpxe/netdevice.h>
  10 #include <gpxe/pkbuff.h>
  11 #include <gpxe/ip.h>
  12 #include <gpxe/tcp.h>
  13 #include <gpxe/tcpip.h>
  14 #include <gpxe/retry.h>
  15 #include "uip/uip.h"
  16
  17 /** @file
  18  *
  19  * TCP protocol
  20  *
  21  * The gPXE TCP stack is currently implemented on top of the uIP
  22  * protocol stack.  This file provides wrappers around uIP so that
  23  * higher-level protocol implementations do not need to talk directly
  24  * to uIP (which has a somewhat baroque API).
  25  *
  26  * Basic operation is to create a #tcp_connection structure, call
  27  * tcp_connect() and then call run_tcpip() in a loop until the
  28  * operation has completed.  The TCP stack will call the various
  29  * methods defined in the #tcp_operations structure in order to send
  30  * and receive data.
  31  *
  32  * See hello.c for a trivial example of a TCP protocol using this
  33  * API.
  34  *
  35  */
  36
  37 #if USE_UIP
  38
  39 /**
  40  * TCP transmit buffer
  41  *
  42  * When a tcp_operations::senddata() method is called, it is
  43  * guaranteed to be able to use this buffer as temporary space for
  44  * constructing the data to be sent.  For example, code such as
  45  *
  46  * @code
  47  *
  48  *     static void my_senddata ( struct tcp_connection *conn, void *buf,
  49  *                               size_t len ) {
  50  *         len = snprintf ( buf, len, "FETCH %s\r\n", filename );
  51  *         tcp_send ( conn, buf + already_sent, len - already_sent );
  52  *     }
  53  *
  54  * @endcode
  55  *
  56  * is allowed, and is probably the best way to deal with
  57  * variably-sized data.
  58  *
  59  * Note that you cannot use this simple mechanism if you want to be
  60  * able to construct single data blocks of more than #len bytes.
  61  */
  62 static void *tcp_buffer = uip_buf + ( 40 + UIP_LLH_LEN );
  63
  64 /** Size of #tcp_buffer */
  65 static size_t tcp_buflen = UIP_BUFSIZE - ( 40 + UIP_LLH_LEN );
  66
  67 /**
  68  * Open a TCP connection
  69  *
  70  * @v conn      TCP connection
  71  *
  72  * This sets up a new TCP connection to the remote host specified in
  73  * tcp_connection::sin.
  74  */
  75 void tcp_connect ( struct tcp_connection *conn ) {
  76         struct uip_conn *uip_conn;
  77         u16_t ipaddr[2];
  78
  79         assert ( conn->sin.sin_addr.s_addr != 0 );
  80         assert ( conn->sin.sin_port != 0 );
  81         assert ( conn->tcp_op != NULL );
  82         assert ( sizeof ( uip_conn->appstate ) == sizeof ( conn ) );
  83
  84         * ( ( uint32_t * ) ipaddr ) = conn->sin.sin_addr.s_addr;
  85         uip_conn = uip_connect ( ipaddr, conn->sin.sin_port );
  86 #warning "Use linked lists so that uip_connect() cannot fail"
  87         assert ( uip_conn != NULL );
  88         *( ( void ** ) uip_conn->appstate ) = conn;
  89 }
  90
  91 /**
  92  * Send data via a TCP connection
  93  *
  94  * @v conn      TCP connection
  95  * @v data      Data to send
  96  * @v len       Length of data
  97  *
  98  * Data will be automatically limited to the current TCP window size.
  99  *
 100  * If retransmission is required, the connection's
 101  * tcp_operations::senddata() method will be called again in order to
 102  * regenerate the data.
 103  */
 104 void tcp_send ( struct tcp_connection *conn __unused,
 105                 const void *data, size_t len ) {
 106
 107         assert ( conn = *( ( void ** ) uip_conn->appstate ) );
 108
 109         if ( len > tcp_buflen )
 110                 len = tcp_buflen;
 111         memmove ( tcp_buffer, data, len );
 112
 113         uip_send ( tcp_buffer, len );
 114 }
 115
 116 /**
 117  * Close a TCP connection
 118  *
 119  * @v conn      TCP connection
 120  */
 121 void tcp_close ( struct tcp_connection *conn __unused ) {
 122         assert ( conn = *( ( void ** ) uip_conn->appstate ) );
 123         uip_close();
 124 }
 125
 126 /**
 127  * uIP TCP application call interface
 128  *
 129  * This is the entry point of gPXE from the point of view of the uIP
 130  * protocol stack.  This function calls the appropriate methods from
 131  * the connection's @tcp_operations table in order to process received
 132  * data, transmit new data etc.
 133  */
 134 void uip_tcp_appcall ( void ) {
 135         struct tcp_connection *conn = *( ( void ** ) uip_conn->appstate );
 136         struct tcp_operations *op = conn->tcp_op;
 137
 138         if ( op->closed ) {
 139                 if ( uip_aborted() )
 140                         op->closed ( conn, -ECONNABORTED );
 141                 if ( uip_timedout() )
 142                         op->closed ( conn, -ETIMEDOUT );
 143                 if ( uip_closed() )
 144                         op->closed ( conn, 0 );
 145         }
 146         if ( uip_connected() && op->connected )
 147                 op->connected ( conn );
 148         if ( uip_acked() && op->acked )
 149                 op->acked ( conn, uip_conn->len );
 150         if ( uip_newdata() && op->newdata )
 151                 op->newdata ( conn, ( void * ) uip_appdata, uip_len );
 152         if ( ( uip_rexmit() || uip_newdata() || uip_acked() ||
 153                uip_connected() || uip_poll() ) && op->senddata )
 154                 op->senddata ( conn, tcp_buffer, tcp_buflen );
 155 }
 156
 157 /* Present here to allow everything to link.  Will go into separate
 158  * udp.c file
 159  */
 160 void uip_udp_appcall ( void ) {
 161 }
 162
 163 /**
 164  * Perform periodic processing of all TCP connections
 165  *
 166  * This allows TCP connections to retransmit data if necessary.
 167  */
 168 static void tcp_periodic ( void ) {
 169         struct pk_buff *pkb;
 170         int i;
 171
 172         for ( i = 0 ; i < UIP_CONNS ; i++ ) {
 173                 uip_periodic ( i );
 174                 if ( uip_len > 0 ) {
 175                         pkb = alloc_pkb ( uip_len + MAX_LL_HEADER_LEN);
 176                         if ( ! pkb )
 177                                 continue;
 178
 179                         pkb_reserve ( pkb, MAX_LL_HEADER_LEN );
 180                         pkb_put ( pkb, uip_len );
 181                         memcpy ( pkb->data, uip_buf, uip_len );
 182
 183                         ipv4_uip_tx ( pkb );
 184                 }
 185         }
 186 }
 187
 188 /**
 189  * Kick a connection into life
 190  *
 191  * @v conn      TCP connection
 192  *
 193  * Call this function when you have new data to send and are not
 194  * already being called as part of TCP processing.
 195  */
 196 void tcp_kick ( struct tcp_connection *conn __unused ) {
 197         /* Just kick all the connections; this will work for now */
 198         tcp_periodic();
 199 }
 200
 201 /**
 202  * Single-step the TCP stack
 203  *
 204  * @v process   TCP process
 205  *
 206  * This calls tcp_periodic() at regular intervals.
 207  */
 208 static void tcp_step ( struct process *process ) {
 209         static unsigned long timeout = 0;
 210
 211         if ( currticks() > timeout ) {
 212                 timeout = currticks() + ( TICKS_PER_SEC / 10 );
 213                 tcp_periodic ();
 214         }
 215
 216         schedule ( process );
 217 }
 218
 219 /** TCP stack process */
 220 static struct process tcp_process = {
 221         .step = tcp_step,
 222 };
 223
 224 /** Initialise the TCP stack */
 225 static void init_tcp ( void ) {
 226         schedule ( &tcp_process );
 227 }
 228
 229 INIT_FN ( INIT_PROCESS, init_tcp, NULL, NULL );
 230
 231 #else
 232
 233 /**
 234  * List of registered TCP connections
 235  */
 236 static LIST_HEAD ( tcp_conns );
 237
 238 /**
 239  * List of TCP states
 240  */
 241 static const char *tcp_states[] = {
 242         "CLOSED",
 243         "LISTEN",
 244         "SYN_SENT",
 245         "SYN_RCVD",
 246         "ESTABLISHED",
 247         "FIN_WAIT_1",
 248         "FIN_WAIT_2",
 249         "CLOSING",
 250         "TIME_WAIT",
 251         "CLOSE_WAIT",
 252         "LAST_ACK",
 253         "INVALID" };
 254
 255 /**
 256  * TCP state transition function
 257  *
 258  * @v conn      TCP connection
 259  * @v nxt_state Next TCP state
 260  */
 261 void tcp_set_flags ( struct tcp_connection *conn ) {
 262
 263         /* Set the TCP flags */
 264         switch ( conn->tcp_state ) {
 265         case TCP_CLOSED:
 266                 if ( conn->tcp_lstate == TCP_SYN_RCVD ) {
 267                         conn->tcp_flags |= TCP_RST;
 268                 }
 269                 break;
 270         case TCP_LISTEN:
 271                 break;
 272         case TCP_SYN_SENT:
 273                 if ( conn->tcp_lstate == TCP_LISTEN ||
 274                      conn->tcp_lstate == TCP_CLOSED ) {
 275                         conn->tcp_flags |= TCP_SYN;
 276                 }
 277                 break;
 278         case TCP_SYN_RCVD:
 279                 if ( conn->tcp_lstate == TCP_LISTEN ||
 280                      conn->tcp_lstate == TCP_SYN_SENT ) {
 281                         conn->tcp_flags |= ( TCP_SYN | TCP_ACK );
 282                 }
 283                 break;
 284         case TCP_ESTABLISHED:
 285                 if ( conn->tcp_lstate == TCP_SYN_SENT ) {
 286                         conn->tcp_flags |= TCP_ACK;
 287                 }
 288                 break;
 289         case TCP_FIN_WAIT_1:
 290                 if ( conn->tcp_lstate == TCP_SYN_RCVD ||
 291                      conn->tcp_lstate == TCP_ESTABLISHED ) {
 292                         conn->tcp_flags |= TCP_FIN;
 293                 }
 294                 break;
 295         case TCP_FIN_WAIT_2:
 296                 break;
 297         case TCP_CLOSING:
 298                 if ( conn->tcp_lstate == TCP_FIN_WAIT_1 ) {
 299                         conn->tcp_flags |= TCP_ACK;
 300                 }
 301                 break;
 302         case TCP_TIME_WAIT:
 303                 if ( conn->tcp_lstate == TCP_FIN_WAIT_1 ||
 304                      conn->tcp_lstate == TCP_FIN_WAIT_2 ) {
 305                         conn->tcp_flags |= TCP_ACK;
 306                 }
 307                 break;
 308         case TCP_CLOSE_WAIT:
 309                 if ( conn->tcp_lstate == TCP_ESTABLISHED ) {
 310                         conn->tcp_flags |= TCP_ACK;
 311                 }
 312                 break;
 313         case TCP_LAST_ACK:
 314                 if ( conn->tcp_lstate == TCP_CLOSE_WAIT ) {
 315                         conn->tcp_flags |= TCP_FIN;
 316                 }
 317                 break;
 318         default:
 319                 DBG ( "TCP_INVALID state %d\n", conn->tcp_state );
 320                 return;
 321         }
 322 }
 323
 324 void tcp_trans ( struct tcp_connection *conn, int nxt_state ) {
 325         /* Remember the last state */
 326         conn->tcp_lstate = conn->tcp_state;
 327         conn->tcp_state = nxt_state;
 328
 329         /* TODO: Check if this check is required */
 330         if ( conn->tcp_lstate == conn->tcp_state ||
 331              conn->tcp_state == TCP_INVALID ) {
 332                 conn->tcp_flags = 0;
 333                 return;
 334         }
 335         tcp_set_flags ( conn );
 336 }
 337
 338 /**
 339  * Dump TCP header
 340  *
 341  * @v tcphdr    TCP header
 342  */
 343 void tcp_dump ( struct tcp_header *tcphdr ) {
 344         DBG ( "TCP %p src:%d dest:%d seq:%lld ack:%lld hlen:%hd flags:%#hx\n",
 345                 tcphdr, ntohs ( tcphdr->src ), ntohs ( tcphdr->dest ), ntohl ( tcphdr->seq ),
 346                 ntohl ( tcphdr->ack ), ( ( tcphdr->hlen & TCP_MASK_HLEN ) / 16 ), ( tcphdr->flags & TCP_MASK_FLAGS ) );
 347 }
 348
 349 /**
 350  * Initialize a TCP connection
 351  *
 352  * @v conn      TCP connection
 353  *
 354  * This function assigns initial values to some fields in the connection
 355  * structure. The application should call tcp_init_conn after creating a new
 356  * connection before calling any other "tcp_*" function.
 357  *
 358  * struct tcp_connection my_conn;
 359  * tcp_init_conn ( &my_conn );
 360  * ...
 361  */
 362 void tcp_init_conn ( struct tcp_connection *conn ) {
 363         conn->local_port = 0;
 364         conn->tcp_state = TCP_CLOSED;
 365         conn->tcp_lstate = TCP_INVALID;
 366         conn->tx_pkb = NULL;
 367         conn->tcp_op = NULL;
 368 }
 369
 370 /** Retry timer
 371  *
 372  * @v timer     Retry timer
 373  * @v over      Failure indicator
 374  */
 375 void tcp_expired ( struct retry_timer *timer, int over ) {
 376         struct tcp_connection *conn;
 377         conn = ( struct tcp_connection * ) container_of ( timer,
 378                                         struct tcp_connection, timer );
 379         DBG ( "Timer expired in %s\n", tcp_states[conn->tcp_state] );
 380         switch ( conn->tcp_state ) {
 381         case TCP_SYN_SENT:
 382                 if ( over ) {
 383                         tcp_trans ( conn, TCP_CLOSED );
 384                         stop_timer ( &conn->timer );
 385                         DBG ( "Timeout! Connection closed\n" );
 386                         return;
 387                 }
 388                 goto send_tcp_nomsg;
 389         case TCP_SYN_RCVD:
 390                 if ( over ) {
 391                         tcp_trans ( conn, TCP_CLOSED );
 392                         stop_timer ( &conn->timer );
 393                         goto send_tcp_nomsg;
 394                 }
 395                 goto send_tcp_nomsg;
 396         case TCP_ESTABLISHED:
 397                 if ( conn->tcp_lstate == TCP_SYN_SENT ) {
 398                         goto send_tcp_nomsg;
 399                 }
 400                 break;
 401         case TCP_CLOSE_WAIT:
 402                 if ( conn->tcp_lstate == TCP_ESTABLISHED ) {
 403                         goto send_tcp_nomsg;
 404                 }
 405                 break;
 406         case TCP_FIN_WAIT_1:
 407         case TCP_FIN_WAIT_2:
 408                 goto send_tcp_nomsg;
 409         case TCP_CLOSING:
 410         case TCP_LAST_ACK:
 411                 if ( conn->tcp_lstate == TCP_CLOSE_WAIT ) {
 412                         goto send_tcp_nomsg;
 413                 }
 414                 return;
 415         case TCP_TIME_WAIT:
 416                 tcp_trans ( conn, TCP_CLOSED );
 417                 stop_timer ( &conn->timer );
 418                 return;
 419         }
 420         /* Retransmit the data */
 421         tcp_set_flags ( conn );
 422         tcp_senddata ( conn );
 423         return;
 424
 425   send_tcp_nomsg:
 426         free_pkb ( conn->tx_pkb );
 427         conn->tx_pkb = alloc_pkb ( MIN_PKB_LEN );
 428         pkb_reserve ( conn->tx_pkb, MAX_HDR_LEN );
 429         tcp_set_flags ( conn );
 430         int rc;
 431         if ( ( rc = tcp_send ( conn, TCP_NOMSG, TCP_NOMSG_LEN ) ) != 0 ) {
 432                 DBG ( "Error sending TCP message (rc = %d)\n", rc );
 433         }
 434         return;
 435 }
 436
 437 /**
 438  * Connect to a remote server
 439  *
 440  * @v conn      TCP connection
 441  * @v peer      Remote socket address
 442  *
 443  * This function initiates a TCP connection to the socket address specified in
 444  * peer. It sends a SYN packet to peer. When the connection is established, the
 445  * TCP stack calls the connected() callback function.
 446  */
 447 int tcp_connectto ( struct tcp_connection *conn,
 448                     struct sockaddr_tcpip *peer ) {
 449         int rc;
 450
 451         /* A connection can only be established from the CLOSED state */
 452         if ( conn->tcp_state != TCP_CLOSED ) {
 453                 DBG ( "Error opening connection: Invalid state %s\n",
 454                                 tcp_states[conn->tcp_state] );
 455                 return -EISCONN;
 456         }
 457
 458         /* Add the connection to the set of listening connections */
 459         if ( ( rc = tcp_listen ( conn, conn->local_port ) ) != 0 ) {
 460                 return rc;
 461         }
 462         memcpy ( &conn->peer, peer, sizeof ( conn->peer ) );
 463
 464         /* Initialize the TCP timer */
 465         conn->timer.expired = tcp_expired;
 466
 467         /* Send a SYN packet and transition to TCP_SYN_SENT */
 468         conn->snd_una = ( ( ( uint32_t ) random() ) << 16 ) & random();
 469         tcp_trans ( conn, TCP_SYN_SENT );
 470         /* Allocate space for the packet */
 471         free_pkb ( conn->tx_pkb );
 472         conn->tx_pkb = alloc_pkb ( MIN_PKB_LEN );
 473         pkb_reserve ( conn->tx_pkb, MAX_HDR_LEN );
 474         conn->rcv_win = MAX_PKB_LEN - MAX_HDR_LEN; /* TODO: Is this OK? */
 475         return tcp_send ( conn, TCP_NOMSG, TCP_NOMSG_LEN );
 476 }
 477
 478 int tcp_connect ( struct tcp_connection *conn ) {
 479         return tcp_connectto ( conn, &conn->peer );
 480 }
 481
 482 /**
 483  * Close the connection
 484  *
 485  * @v conn
 486  *
 487  * This function sends a FIN packet to the remote end of the connection. When
 488  * the remote end of the connection ACKs the FIN (FIN consumes one byte on the
 489  * snd stream), the stack invokes the closed() callback function.
 490  */
 491 int tcp_close ( struct tcp_connection *conn ) {
 492         /* A connection can only be closed if it is a connected state */
 493         switch ( conn->tcp_state ) {
 494         case TCP_SYN_RCVD:
 495         case TCP_ESTABLISHED:
 496                 tcp_trans ( conn, TCP_FIN_WAIT_1 );
 497                 conn->tcp_op->closed ( conn, CONN_SNDCLOSE ); /* TODO: Check! */
 498                 /* FIN consumes one byte on the snd stream */
 499 //              conn->snd_una++;
 500                 goto send_tcp_nomsg;
 501         case TCP_SYN_SENT:
 502         case TCP_LISTEN:
 503                 /**
 504                  * Since the connection does not expect any packets from the
 505                  * remote end, it can be removed from the set of listening
 506                  * connections.
 507                  */
 508                 list_del ( &conn->list );
 509                 tcp_trans ( conn, TCP_CLOSED );
 510                 conn->tcp_op->closed ( conn, CONN_SNDCLOSE );
 511                 return 0;
 512         case TCP_CLOSE_WAIT:
 513                 tcp_trans ( conn, TCP_LAST_ACK );
 514                 conn->tcp_op->closed ( conn, CONN_SNDCLOSE ); /* TODO: Check! */
 515                 /* FIN consumes one byte on the snd stream */
 516 //              conn->snd_una++;
 517                 goto send_tcp_nomsg;
 518         default:
 519                 DBG ( "tcp_close(): Invalid state %s\n",
 520                                         tcp_states[conn->tcp_state] );
 521                 return -EPROTO;
 522         }
 523
 524   send_tcp_nomsg:
 525         free_pkb ( conn->tx_pkb );
 526         conn->tx_pkb = alloc_pkb ( MIN_PKB_LEN );
 527         conn->tcp_flags = TCP_FIN;
 528         pkb_reserve ( conn->tx_pkb, MAX_HDR_LEN );
 529         return tcp_send ( conn, TCP_NOMSG, TCP_NOMSG_LEN );
 530 }
 531
 532
 533 /**
 534  * Listen for a packet
 535  *
 536  * @v conn      TCP connection
 537  * @v port      Local port, in network byte order
 538  *
 539  * This function adds the connection to a list of registered tcp connections. If
 540  * the local port is 0, the connection is assigned the lowest available port
 541  * between MIN_TCP_PORT and 65535.
 542  */
 543 int tcp_listen ( struct tcp_connection *conn, uint16_t port ) {
 544         struct tcp_connection *cconn;
 545         if ( port != 0 ) {
 546                 list_for_each_entry ( cconn, &tcp_conns, list ) {
 547                         if ( cconn->local_port == port ) {
 548                                 DBG ( "Error listening to %d\n",
 549                                                         ntohs ( port ) );
 550                                 return -EISCONN;
 551                         }
 552                 }
 553                 /* Add the connection to the list of registered connections */
 554                 conn->local_port = port;
 555                 list_add ( &conn->list, &tcp_conns );
 556                 return 0;
 557         }
 558         /* Assigning lowest port not supported */
 559         DBG ( "Assigning lowest port not implemented\n");
 560         return -ENOSYS;
 561 }
 562
 563 /**
 564  * Send data
 565  *
 566  * @v conn      TCP connection
 567  *
 568  * This function allocates space to the transmit buffer and invokes the
 569  * senddata() callback function. It passes the allocated buffer to senddata().
 570  * The applicaion may use this space to write it's data.
 571  */
 572 int tcp_senddata ( struct tcp_connection *conn ) {
 573         /* The connection must be in a state in which the user can send data */
 574         switch ( conn->tcp_state ) {
 575         case TCP_LISTEN:
 576                 tcp_trans ( conn, TCP_SYN_SENT );
 577                 conn->snd_una = ( ( ( uint32_t ) random() ) << 16 ) & random();
 578                 break;
 579         case TCP_ESTABLISHED:
 580         case TCP_CLOSE_WAIT:
 581                 break;
 582         default:
 583                 DBG ( "tcp_senddata: Invalid state %s\n",
 584                                 tcp_states[conn->tcp_state] );
 585                 return -EPROTO;
 586         }
 587
 588         /* Allocate space to the TX buffer */
 589         free_pkb ( conn->tx_pkb );
 590         conn->tx_pkb = alloc_pkb ( MAX_PKB_LEN );
 591         if ( !conn->tx_pkb ) {
 592                 DBG ( "Insufficient memory\n" );
 593                 return -ENOMEM;
 594         }
 595         pkb_reserve ( conn->tx_pkb, MAX_HDR_LEN );
 596         /* Set the advertised window */
 597         conn->rcv_win = pkb_available ( conn->tx_pkb );
 598         /* Call the senddata() call back function */
 599         conn->tcp_op->senddata ( conn, conn->tx_pkb->data,
 600                                         pkb_available ( conn->tx_pkb ) );
 601         return 0;
 602 }
 603
 604 /**
 605  * Transmit data
 606  *
 607  * @v conn      TCP connection
 608  * @v data      Data to be sent
 609  * @v len       Length of the data
 610  *
 611  * This function sends data to the peer socket address
 612  */
 613 int tcp_send ( struct tcp_connection *conn, const void *data, size_t len ) {
 614         struct sockaddr_tcpip *peer = &conn->peer;
 615         struct pk_buff *pkb = conn->tx_pkb;
 616         int slen;
 617
 618         /* Determine the amount of data to be sent */
 619         slen = len < conn->snd_win ? len : conn->snd_win;
 620         /* Copy payload */
 621         memmove ( pkb_put ( pkb, slen ), data, slen );
 622
 623         /* Fill up the TCP header */
 624         struct tcp_header *tcphdr = pkb_push ( pkb, sizeof ( *tcphdr ) );
 625
 626         /* Source port, assumed to be in network byte order in conn */
 627         tcphdr->src = conn->local_port;
 628         /* Destination port, assumed to be in network byte order in peer */
 629         tcphdr->dest = peer->st_port;
 630         tcphdr->seq = htonl ( conn->snd_una );
 631         tcphdr->ack = htonl ( conn->rcv_nxt );
 632         /* Header length, = 0x50 (without TCP options) */
 633         tcphdr->hlen = ( uint8_t ) ( ( sizeof ( *tcphdr ) / 4 ) << 4 );
 634         /* Copy TCP flags, and then reset the variable */
 635         tcphdr->flags = conn->tcp_flags;
 636         conn->tcp_flags = 0;
 637         /* Advertised window, in network byte order */
 638         tcphdr->win = htons ( conn->rcv_win );
 639         /* Set urgent pointer to 0 */
 640         tcphdr->urg = 0;
 641         /* Calculate and store partial checksum, in host byte order */
 642         tcphdr->csum = 0;
 643         tcphdr->csum = tcpip_chksum ( pkb->data, pkb_len ( pkb ) );
 644
 645         /* Dump the TCP header */
 646
 647         /* Start the timer */
 648         if ( ( conn->tcp_state == TCP_ESTABLISHED && conn->tcp_lstate == TCP_SYN_SENT ) ||
 649              ( conn->tcp_state == TCP_LISTEN && conn->tcp_lstate == TCP_SYN_RCVD ) ||
 650              ( conn->tcp_state == TCP_CLOSED && conn->tcp_lstate == TCP_SYN_RCVD ) ) {
 651                 // Don't start the timer
 652         } else {
 653                 start_timer ( &conn->timer );
 654         }
 655
 656         /* Transmit packet */
 657         return tcpip_tx ( pkb, &tcp_protocol, peer );
 658 }
 659
 660 /**
 661  * Process received packet
 662  *
 663  * @v pkb       Packet buffer
 664  * @v partial   Partial checksum
 665  */
 666 static int tcp_rx ( struct pk_buff *pkb,
 667                     struct sockaddr_tcpip *st_src __unused,
 668                     struct sockaddr_tcpip *st_dest __unused ) {
 669         struct tcp_connection *conn;
 670         struct tcp_header *tcphdr;
 671         uint32_t acked, toack;
 672         int hlen;
 673         int add = 4;
 674
 675         /* Sanity check */
 676         if ( pkb_len ( pkb ) < sizeof ( *tcphdr ) ) {
 677                 DBG ( "Packet too short (%d bytes)\n", pkb_len ( pkb ) );
 678                 return -EINVAL;
 679         }
 680
 681
 682         /* Process TCP header */
 683         tcphdr = pkb->data;
 684         tcp_dump ( tcphdr );
 685
 686         /* Verify header length */
 687         hlen = ( ( tcphdr->hlen & TCP_MASK_HLEN ) / 16 ) * 4;
 688         if ( hlen != sizeof ( *tcphdr ) ) {
 689                 if ( hlen == sizeof ( *tcphdr ) + 4 ) {
 690                         DBG ( "TCP options sent\n" );
 691                         add = 4;
 692                 } else {
 693                         DBG ( "Bad header length (%d bytes)\n", hlen );
 694                         return -EINVAL;
 695                 }
 696         }
 697
 698
 699         /* TODO: Verify checksum */
 700
 701         /* Demux TCP connection */
 702         list_for_each_entry ( conn, &tcp_conns, list ) {
 703                 if ( tcphdr->dest == conn->local_port ) {
 704                         goto found_conn;
 705                 }
 706         }
 707
 708         DBG ( "No connection found on port %d\n", ntohs ( tcphdr->dest ) );
 709         return 0;
 710
 711   found_conn:
 712         /* Stop the timer */
 713         stop_timer ( &conn->timer );
 714
 715         /* Set the advertised window */
 716         conn->snd_win = tcphdr->win;
 717
 718         /* TCP State Machine */
 719         uint8_t out_flags = 0;
 720         conn->tcp_lstate = conn->tcp_state;
 721         switch ( conn->tcp_state ) {
 722         case TCP_CLOSED:
 723                 DBG ( "tcp_rx(): Invalid state %s\n",
 724                                 tcp_states[conn->tcp_state] );
 725                 return -EINVAL;
 726         case TCP_LISTEN:
 727                 if ( tcphdr->flags & TCP_SYN ) {
 728                         tcp_trans ( conn, TCP_SYN_RCVD );
 729                         /* Synchronize the sequence numbers */
 730                         conn->rcv_nxt = ntohl ( tcphdr->seq ) + 1;
 731                         out_flags |= TCP_ACK;
 732
 733                         /* Set the sequence number for the snd stream */
 734                         conn->snd_una = ( ( ( uint32_t ) random() ) << 16 );
 735                         conn->snd_una &= random();
 736                         out_flags |= TCP_SYN;
 737
 738                         /* Send a SYN,ACK packet */
 739                         goto send_tcp_nomsg;
 740                 }
 741                 /* Unexpected packet */
 742                 goto unexpected;
 743         case TCP_SYN_SENT:
 744                 if ( tcphdr->flags & TCP_SYN ) {
 745                         /* Synchronize the sequence number in rcv stream */
 746                         conn->rcv_nxt = ntohl ( tcphdr->seq ) + 1;
 747                         out_flags |= TCP_ACK;
 748
 749                         if ( tcphdr->flags & TCP_ACK ) {
 750                                 tcp_trans ( conn, TCP_ESTABLISHED );
 751                                 /**
 752                                  * Process ACK of SYN. This does not invoke the
 753                                  * acked() callback function.
 754                                  */
 755                                 conn->snd_una = ntohl ( tcphdr->ack );
 756                                 conn->tcp_op->connected ( conn );
 757                                 out_flags |= TCP_ACK;
 758                                 tcp_senddata ( conn );
 759                                 return;
 760                         } else {
 761                                 tcp_trans ( conn, TCP_SYN_RCVD );
 762                                 out_flags |= TCP_SYN;
 763                                 goto send_tcp_nomsg;
 764                         }
 765                 }
 766                 /* Unexpected packet */
 767                 goto unexpected;
 768         case TCP_SYN_RCVD:
 769                 if ( tcphdr->flags & TCP_RST ) {
 770                         tcp_trans ( conn, TCP_LISTEN );
 771                         conn->tcp_op->closed ( conn, CONN_RESTART );
 772                         return 0;
 773                 }
 774                 if ( tcphdr->flags & TCP_ACK ) {
 775                         tcp_trans ( conn, TCP_ESTABLISHED );
 776                         /**
 777                          * Process ACK of SYN. It neither invokes the callback
 778                          * function nor does it send an ACK.
 779                          */
 780                         conn->snd_una = tcphdr->ack - 1;
 781                         conn->tcp_op->connected ( conn );
 782                         return 0;
 783                 }
 784                 /* Unexpected packet */
 785                 goto unexpected;
 786         case TCP_ESTABLISHED:
 787 #if 0
 788                 if ( tcphdr->flags & TCP_FIN ) {
 789                         tcp_trans ( conn, TCP_CLOSE_WAIT );
 790                         /* FIN consumes one byte */
 791                         conn->rcv_nxt++;
 792                         out_flags |= TCP_ACK;
 793                         /* Send an acknowledgement */
 794                         goto send_tcp_nomsg;
 795                 }
 796 #endif
 797                 /* Packet might contain data */
 798                 break;
 799         case TCP_FIN_WAIT_1:
 800                 if ( tcphdr->flags & TCP_FIN ) {
 801                         conn->rcv_nxt++;
 802                         out_flags |= TCP_ACK;
 803                         conn->tcp_op->closed ( conn, CONN_SNDCLOSE );
 804
 805                         if ( tcphdr->flags & TCP_ACK ) {
 806                                 tcp_trans ( conn, TCP_TIME_WAIT );
 807                         } else {
 808                                 tcp_trans ( conn, TCP_CLOSING );
 809                         }
 810                         /* Send an acknowledgement */
 811                         goto send_tcp_nomsg;
 812                 }
 813                 if ( tcphdr->flags & TCP_ACK ) {
 814                         tcp_trans ( conn, TCP_FIN_WAIT_2 );
 815                 }
 816                 /* Packet might contain data */
 817                 break;
 818         case TCP_FIN_WAIT_2:
 819                 if ( tcphdr->flags & TCP_FIN ) {
 820                         tcp_trans ( conn, TCP_TIME_WAIT );
 821                         /* FIN consumes one byte */
 822                         conn->rcv_nxt++;
 823                         out_flags |= TCP_ACK;
 824                         goto send_tcp_nomsg;
 825                 }
 826                 /* Packet might contain data */
 827                 break;
 828         case TCP_CLOSING:
 829                 if ( tcphdr->flags & TCP_ACK ) {
 830                         tcp_trans ( conn, TCP_TIME_WAIT );
 831                         start_timer ( &conn->timer );
 832                         return 0;
 833                 }
 834                 /* Unexpected packet */
 835                 goto unexpected;
 836         case TCP_TIME_WAIT:
 837                 /* Unexpected packet */
 838                 goto unexpected;
 839         case TCP_CLOSE_WAIT:
 840                 /* Packet could acknowledge data */
 841                 break;
 842         case TCP_LAST_ACK:
 843                 if ( tcphdr->flags & TCP_ACK ) {
 844                         tcp_trans ( conn, TCP_CLOSED );
 845                         return 0;
 846                 }
 847                 /* Unexpected packet */
 848                 goto unexpected;
 849         }
 850
 851         /**
 852          * Any packet reaching this point either contains new data or
 853          * acknowledges previously transmitted data.
 854          */
 855         assert ( ( tcphdr->flags & TCP_ACK ) ||
 856                  pkb_len ( pkb ) > sizeof ( *tcphdr ) );
 857
 858         /* Check for new data */
 859         toack = pkb_len ( pkb ) - hlen;
 860         if ( toack > 0 ) {
 861                 /* Check if expected sequence number */
 862                 if ( conn->rcv_nxt == ntohl ( tcphdr->seq ) ) {
 863                         conn->rcv_nxt += toack;
 864                         conn->tcp_op->newdata ( conn, pkb->data + sizeof ( *tcphdr ) + add, toack );
 865                 } else {
 866                         printf ( "Unexpected sequence number %ld\n",
 867                                 ntohl ( tcphdr->seq ) );
 868                 }
 869
 870                 /* Acknowledge new data */
 871                 out_flags |= TCP_ACK;
 872                 if ( !( tcphdr->flags & TCP_ACK ) ) {
 873                         goto send_tcp_nomsg;
 874                 }
 875         }
 876
 877         /* Process ACK */
 878         if ( tcphdr->flags & TCP_ACK ) {
 879                 acked = ntohl ( tcphdr->ack ) - conn->snd_una;
 880                 if ( acked < 0 ) { /* TODO: Replace all uint32_t arith */
 881                         DBG ( "Previously ACKed (%d)\n", tcphdr->ack );
 882                         return 0;
 883                 }
 884                 /* Advance snd stream */
 885                 conn->snd_una += acked;
 886                 /* Invoke the acked() callback function */
 887                 conn->tcp_op->acked ( conn, acked );
 888                 /* Invoke the senddata() callback function */
 889                 tcp_senddata ( conn );
 890         }
 891
 892         /* If the connection is in ESTABLISHED and it receives a FIN */
 893         if ( conn->tcp_state == ESTABLISHED && ( tcphdr->flags & TCP_FIN ) ) {
 894                 tcp_trans ( conn, TCP_CLOSE_WAIT );
 895                 conn->tcp_op->closed ( conn, CONN_SNDCLOSE );
 896                 conn->rcv_nxt++;
 897                 if ( ! ( tcphdr->flags & TCP_ACK ) ) {
 898                         out_flags |= TCP_ACK;
 899                         /* Send an acknowledgement */
 900                         goto send_tcp_nomsg;
 901                 }
 902                 /* Otherwise, the packet has been ACKed already */
 903         }
 904         return 0;
 905
 906   send_tcp_nomsg:
 907         free_pkb ( conn->tx_pkb );
 908         conn->tx_pkb = alloc_pkb ( MIN_PKB_LEN );
 909         pkb_reserve ( conn->tx_pkb, MAX_HDR_LEN );
 910         int rc;
 911         if ( ( rc = tcp_send ( conn, TCP_NOMSG, TCP_NOMSG_LEN ) ) != 0 ) {
 912                 DBG ( "Error sending TCP message (rc = %d)\n", rc );
 913         }
 914         return 0;
 915
 916   unexpected:
 917         DBG ( "Unexpected packet received in %s with flags = %#hx\n",
 918                         tcp_states[conn->tcp_state], tcphdr->flags & TCP_MASK_FLAGS );
 919         tcp_close ( conn );
 920         free_pkb ( conn->tx_pkb );
 921         return -EINVAL;
 922 }
 923
 924 /** TCP protocol */
 925 struct tcpip_protocol tcp_protocol __tcpip_protocol = {
 926         .name = "TCP",
 927         .rx = tcp_rx,
 928         .tcpip_proto = IP_TCP,
 929         .csum_offset = 16,
 930 };
 931
 932 #endif /* USE_UIP */