src/vnet/tcp/tcp.h

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef _vnet_tcp_h_
  17 #define _vnet_tcp_h_
  18
  19 #include <vnet/vnet.h>
  20 #include <vnet/ip/ip.h>
  21 #include <vnet/tcp/tcp_packet.h>
  22 #include <vnet/tcp/tcp_timer.h>
  23 #include <vnet/session/transport.h>
  24 #include <vnet/session/session.h>
  25 #include <vnet/tcp/tcp_debug.h>
  26
  27 #define TCP_TICK 0.001                  /**< TCP tick period (s) */
  28 #define THZ (u32) (1/TCP_TICK)          /**< TCP tick frequency */
  29 #define TCP_TSTAMP_RESOLUTION TCP_TICK  /**< Time stamp resolution */
  30 #define TCP_PAWS_IDLE 24 * 24 * 60 * 60 * THZ /**< 24 days */
  31 #define TCP_MAX_OPTION_SPACE 40
  32
  33 #define TCP_DUPACK_THRESHOLD    3
  34 #define TCP_MAX_RX_FIFO_SIZE    2 << 20
  35 #define TCP_IW_N_SEGMENTS       10
  36 #define TCP_ALWAYS_ACK          0       /**< If on, we always ack */
  37 #define TCP_USE_SACKS           1       /**< Disable only for testing */
  38
  39 /** TCP FSM state definitions as per RFC793. */
  40 #define foreach_tcp_fsm_state   \
  41   _(CLOSED, "CLOSED")           \
  42   _(LISTEN, "LISTEN")           \
  43   _(SYN_SENT, "SYN_SENT")       \
  44   _(SYN_RCVD, "SYN_RCVD")       \
  45   _(ESTABLISHED, "ESTABLISHED") \
  46   _(CLOSE_WAIT, "CLOSE_WAIT")   \
  47   _(FIN_WAIT_1, "FIN_WAIT_1")   \
  48   _(LAST_ACK, "LAST_ACK")       \
  49   _(CLOSING, "CLOSING")         \
  50   _(FIN_WAIT_2, "FIN_WAIT_2")   \
  51   _(TIME_WAIT, "TIME_WAIT")
  52
  53 typedef enum _tcp_state
  54 {
  55 #define _(sym, str) TCP_STATE_##sym,
  56   foreach_tcp_fsm_state
  57 #undef _
  58   TCP_N_STATES
  59 } tcp_state_t;
  60
  61 format_function_t format_tcp_state;
  62 format_function_t format_tcp_flags;
  63 format_function_t format_tcp_sacks;
  64
  65 /** TCP timers */
  66 #define foreach_tcp_timer               \
  67   _(RETRANSMIT, "RETRANSMIT")           \
  68   _(DELACK, "DELAYED ACK")              \
  69   _(PERSIST, "PERSIST")                 \
  70   _(KEEP, "KEEP")                       \
  71   _(WAITCLOSE, "WAIT CLOSE")            \
  72   _(RETRANSMIT_SYN, "RETRANSMIT SYN")   \
  73   _(ESTABLISH, "ESTABLISH")
  74
  75 typedef enum _tcp_timers
  76 {
  77 #define _(sym, str) TCP_TIMER_##sym,
  78   foreach_tcp_timer
  79 #undef _
  80   TCP_N_TIMERS
  81 } tcp_timers_e;
  82
  83 typedef void (timer_expiration_handler) (u32 index);
  84
  85 extern timer_expiration_handler tcp_timer_delack_handler;
  86 extern timer_expiration_handler tcp_timer_retransmit_handler;
  87 extern timer_expiration_handler tcp_timer_persist_handler;
  88 extern timer_expiration_handler tcp_timer_retransmit_syn_handler;
  89
  90 #define TCP_TIMER_HANDLE_INVALID ((u32) ~0)
  91
  92 /* Timer delays as multiples of 100ms */
  93 #define TCP_TO_TIMER_TICK       TCP_TICK*10     /* Period for converting from TCP
  94                                                  * ticks to timer units */
  95 #define TCP_DELACK_TIME         1       /* 0.1s */
  96 #define TCP_ESTABLISH_TIME      750     /* 75s */
  97 #define TCP_2MSL_TIME           300     /* 30s */
  98 #define TCP_CLOSEWAIT_TIME      20      /* 0.1s */
  99 #define TCP_CLEANUP_TIME        5       /* 0.5s Time to wait before cleanup */
 100 #define TCP_TIMER_PERSIST_MIN   2       /* 0.2s */
 101
 102 #define TCP_RTO_MAX 60 * THZ    /* Min max RTO (60s) as per RFC6298 */
 103 #define TCP_RTT_MAX 30 * THZ    /* 30s (probably too much) */
 104 #define TCP_RTO_SYN_RETRIES 3   /* SYN retries without doubling RTO */
 105 #define TCP_RTO_INIT 1 * THZ    /* Initial retransmit timer */
 106
 107 /** TCP connection flags */
 108 #define foreach_tcp_connection_flag             \
 109   _(SNDACK, "Send ACK")                         \
 110   _(FINSNT, "FIN sent")                         \
 111   _(SENT_RCV_WND0, "Sent 0 receive window")     \
 112   _(RECOVERY, "Recovery on")                    \
 113   _(FAST_RECOVERY, "Fast Recovery on")          \
 114   _(FR_1_SMSS, "Sent 1 SMSS")
 115
 116 typedef enum _tcp_connection_flag_bits
 117 {
 118 #define _(sym, str) TCP_CONN_##sym##_BIT,
 119   foreach_tcp_connection_flag
 120 #undef _
 121   TCP_CONN_N_FLAG_BITS
 122 } tcp_connection_flag_bits_e;
 123
 124 typedef enum _tcp_connection_flag
 125 {
 126 #define _(sym, str) TCP_CONN_##sym = 1 << TCP_CONN_##sym##_BIT,
 127   foreach_tcp_connection_flag
 128 #undef _
 129   TCP_CONN_N_FLAGS
 130 } tcp_connection_flags_e;
 131
 132 /** TCP buffer flags */
 133 #define foreach_tcp_buf_flag                            \
 134   _ (ACK)       /**< Sending ACK. */                    \
 135   _ (DUPACK)    /**< Sending DUPACK. */                 \
 136
 137 enum
 138 {
 139 #define _(f) TCP_BUF_BIT_##f,
 140   foreach_tcp_buf_flag
 141 #undef _
 142     TCP_N_BUF_BITS,
 143 };
 144
 145 enum
 146 {
 147 #define _(f) TCP_BUF_FLAG_##f = 1 << TCP_BUF_BIT_##f,
 148   foreach_tcp_buf_flag
 149 #undef _
 150 };
 151
 152 #define TCP_MAX_SACK_BLOCKS 5   /**< Max number of SACK blocks stored */
 153 #define TCP_INVALID_SACK_HOLE_INDEX ((u32)~0)
 154
 155 typedef struct _sack_scoreboard_hole
 156 {
 157   u32 next;             /**< Index for next entry in linked list */
 158   u32 prev;             /**< Index for previous entry in linked list */
 159   u32 start;            /**< Start sequence number */
 160   u32 end;              /**< End sequence number */
 161   u8 is_lost;           /**< Mark hole as lost */
 162 } sack_scoreboard_hole_t;
 163
 164 typedef struct _sack_scoreboard
 165 {
 166   sack_scoreboard_hole_t *holes;        /**< Pool of holes */
 167   u32 head;                             /**< Index of first entry */
 168   u32 tail;                             /**< Index of last entry */
 169   u32 sacked_bytes;                     /**< Number of bytes sacked in sb */
 170   u32 last_sacked_bytes;                /**< Number of bytes last sacked */
 171   u32 last_bytes_delivered;             /**< Number of sack bytes delivered */
 172   u32 snd_una_adv;                      /**< Bytes to add to snd_una */
 173   u32 high_sacked;                      /**< Highest byte sacked (fack) */
 174   u32 high_rxt;                         /**< Highest retransmitted sequence */
 175   u32 rescue_rxt;                       /**< Rescue sequence number */
 176   u32 lost_bytes;                       /**< Bytes lost as per RFC6675 */
 177   u32 cur_rxt_hole;                     /**< Retransmitting from this hole */
 178 } sack_scoreboard_t;
 179
 180 typedef enum _tcp_cc_algorithm_type
 181 {
 182   TCP_CC_NEWRENO,
 183 } tcp_cc_algorithm_type_e;
 184
 185 typedef struct _tcp_cc_algorithm tcp_cc_algorithm_t;
 186
 187 typedef enum _tcp_cc_ack_t
 188 {
 189   TCP_CC_ACK,
 190   TCP_CC_DUPACK,
 191   TCP_CC_PARTIALACK
 192 } tcp_cc_ack_t;
 193
 194 typedef struct _tcp_connection
 195 {
 196   transport_connection_t connection;  /**< Common transport data. First! */
 197
 198   u8 state;                     /**< TCP state as per tcp_state_t */
 199   u16 flags;                    /**< Connection flags (see tcp_conn_flags_e) */
 200   u32 timers[TCP_N_TIMERS];     /**< Timer handles into timer wheel */
 201
 202   /* TODO RFC4898 */
 203
 204   /** Send sequence variables RFC793 */
 205   u32 snd_una;          /**< oldest unacknowledged sequence number */
 206   u32 snd_una_max;      /**< newest unacknowledged sequence number + 1*/
 207   u32 snd_wnd;          /**< send window */
 208   u32 snd_wl1;          /**< seq number used for last snd.wnd update */
 209   u32 snd_wl2;          /**< ack number used for last snd.wnd update */
 210   u32 snd_nxt;          /**< next seq number to be sent */
 211
 212   /** Receive sequence variables RFC793 */
 213   u32 rcv_nxt;          /**< next sequence number expected */
 214   u32 rcv_wnd;          /**< receive window we expect */
 215
 216   u32 rcv_las;          /**< rcv_nxt at last ack sent/rcv_wnd update */
 217   u32 iss;              /**< initial sent sequence */
 218   u32 irs;              /**< initial remote sequence */
 219
 220   /* Options */
 221   tcp_options_t rcv_opts;       /**< Rx options for connection */
 222   tcp_options_t snd_opts;       /**< Tx options for connection */
 223   u8 snd_opts_len;              /**< Tx options len */
 224   u8 rcv_wscale;        /**< Window scale to advertise to peer */
 225   u8 snd_wscale;        /**< Window scale to use when sending */
 226   u32 tsval_recent;     /**< Last timestamp received */
 227   u32 tsval_recent_age; /**< When last updated tstamp_recent*/
 228
 229   sack_block_t *snd_sacks;      /**< Vector of SACKs to send. XXX Fixed size? */
 230   sack_scoreboard_t sack_sb;    /**< SACK "scoreboard" that tracks holes */
 231
 232   u16 rcv_dupacks;      /**< Number of DUPACKs received */
 233   u8 snt_dupacks;       /**< Number of DUPACKs sent in a burst */
 234
 235   /* Congestion control */
 236   u32 cwnd;             /**< Congestion window */
 237   u32 ssthresh;         /**< Slow-start threshold */
 238   u32 prev_ssthresh;    /**< ssthresh before congestion */
 239   u32 prev_cwnd;        /**< ssthresh before congestion */
 240   u32 bytes_acked;      /**< Bytes acknowledged by current segment */
 241   u32 snd_rxt_bytes;    /**< Retransmitted bytes */
 242   u32 snd_rxt_ts;       /**< Timestamp when first packet is retransmitted */
 243   u32 tsecr_last_ack;   /**< Timestamp echoed to us in last healthy ACK */
 244   u32 snd_congestion;   /**< snd_una_max when congestion is detected */
 245   tcp_cc_algorithm_t *cc_algo;  /**< Congestion control algorithm */
 246
 247   /* RTT and RTO */
 248   u32 rto;              /**< Retransmission timeout */
 249   u32 rto_boff;         /**< Index for RTO backoff */
 250   u32 srtt;             /**< Smoothed RTT */
 251   u32 rttvar;           /**< Smoothed mean RTT difference. Approximates variance */
 252   u32 rtt_ts;           /**< Timestamp for tracked ACK */
 253   u32 rtt_seq;          /**< Sequence number for tracked ACK */
 254
 255   u16 snd_mss;          /**< Effective send max seg (data) size */
 256   u16 mss;              /**< Our max seg size that includes options */
 257 } tcp_connection_t;
 258
 259 struct _tcp_cc_algorithm
 260 {
 261   void (*rcv_ack) (tcp_connection_t * tc);
 262   void (*rcv_cong_ack) (tcp_connection_t * tc, tcp_cc_ack_t ack);
 263   void (*congestion) (tcp_connection_t * tc);
 264   void (*recovered) (tcp_connection_t * tc);
 265   void (*init) (tcp_connection_t * tc);
 266 };
 267
 268 #define tcp_fastrecovery_on(tc) (tc)->flags |= TCP_CONN_FAST_RECOVERY
 269 #define tcp_fastrecovery_off(tc) (tc)->flags &= ~TCP_CONN_FAST_RECOVERY
 270 #define tcp_recovery_on(tc) (tc)->flags |= TCP_CONN_RECOVERY
 271 #define tcp_recovery_off(tc) (tc)->flags &= ~TCP_CONN_RECOVERY
 272 #define tcp_in_fastrecovery(tc) ((tc)->flags & TCP_CONN_FAST_RECOVERY)
 273 #define tcp_in_recovery(tc) ((tc)->flags & (TCP_CONN_RECOVERY))
 274 #define tcp_in_slowstart(tc) (tc->cwnd < tc->ssthresh)
 275 #define tcp_fastrecovery_sent_1_smss(tc) ((tc)->flags & TCP_CONN_FR_1_SMSS)
 276 #define tcp_fastrecovery_1_smss_on(tc) ((tc)->flags |= TCP_CONN_FR_1_SMSS)
 277 #define tcp_fastrecovery_1_smss_off(tc) ((tc)->flags &= ~TCP_CONN_FR_1_SMSS)
 278
 279 #define tcp_in_cong_recovery(tc) ((tc)->flags &                 \
 280           (TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
 281
 282 always_inline void
 283 tcp_cong_recovery_off (tcp_connection_t * tc)
 284 {
 285   tc->flags &= ~(TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY);
 286   tcp_fastrecovery_1_smss_off (tc);
 287 }
 288
 289 typedef enum
 290 {
 291   TCP_IP4,
 292   TCP_IP6,
 293   TCP_N_AF,
 294 } tcp_af_t;
 295
 296 typedef enum _tcp_error
 297 {
 298 #define tcp_error(n,s) TCP_ERROR_##n,
 299 #include <vnet/tcp/tcp_error.def>
 300 #undef tcp_error
 301   TCP_N_ERROR,
 302 } tcp_error_t;
 303
 304 typedef struct _tcp_lookup_dispatch
 305 {
 306   u8 next, error;
 307 } tcp_lookup_dispatch_t;
 308
 309 typedef struct _tcp_main
 310 {
 311   /* Per-worker thread tcp connection pools */
 312   tcp_connection_t **connections;
 313
 314   /* Pool of listeners. */
 315   tcp_connection_t *listener_pool;
 316
 317   /** Dispatch table by state and flags */
 318   tcp_lookup_dispatch_t dispatch_table[TCP_N_STATES][64];
 319
 320   u8 log2_tstamp_clocks_per_tick;
 321   f64 tstamp_ticks_per_clock;
 322
 323   /** per-worker tx buffer free lists */
 324   u32 **tx_buffers;
 325
 326   /* Per worker-thread timer wheel for connections timers */
 327   tw_timer_wheel_16t_2w_512sl_t *timer_wheels;
 328
 329 //  /* Convenience per worker-thread vector of connections to DELACK */
 330 //  u32 **delack_connections;
 331
 332   /* Pool of half-open connections on which we've sent a SYN */
 333   tcp_connection_t *half_open_connections;
 334
 335   /* Pool of local TCP endpoints */
 336   transport_endpoint_t *local_endpoints;
 337
 338   /* Local endpoints lookup table */
 339   transport_endpoint_table_t local_endpoints_table;
 340
 341   /* Congestion control algorithms registered */
 342   tcp_cc_algorithm_t *cc_algos;
 343
 344   /* Flag that indicates if stack is on or off */
 345   u8 is_enabled;
 346
 347   /* convenience */
 348   vlib_main_t *vlib_main;
 349   vnet_main_t *vnet_main;
 350   ip4_main_t *ip4_main;
 351   ip6_main_t *ip6_main;
 352 } tcp_main_t;
 353
 354 extern tcp_main_t tcp_main;
 355 extern vlib_node_registration_t tcp4_input_node;
 356 extern vlib_node_registration_t tcp6_input_node;
 357 extern vlib_node_registration_t tcp4_output_node;
 358 extern vlib_node_registration_t tcp6_output_node;
 359
 360 always_inline tcp_main_t *
 361 vnet_get_tcp_main ()
 362 {
 363   return &tcp_main;
 364 }
 365
 366 always_inline tcp_header_t *
 367 tcp_buffer_hdr (vlib_buffer_t * b)
 368 {
 369   ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
 370   return (tcp_header_t *) (b->data + b->current_data
 371                            + vnet_buffer (b)->tcp.hdr_offset);
 372 }
 373
 374 clib_error_t *vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en);
 375
 376 always_inline tcp_connection_t *
 377 tcp_connection_get (u32 conn_index, u32 thread_index)
 378 {
 379   if (pool_is_free_index (tcp_main.connections[thread_index], conn_index))
 380     return 0;
 381   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 382 }
 383
 384 always_inline tcp_connection_t *
 385 tcp_connection_get_if_valid (u32 conn_index, u32 thread_index)
 386 {
 387   if (tcp_main.connections[thread_index] == 0)
 388     return 0;
 389   if (pool_is_free_index (tcp_main.connections[thread_index], conn_index))
 390     return 0;
 391   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 392 }
 393
 394 void tcp_connection_close (tcp_connection_t * tc);
 395 void tcp_connection_cleanup (tcp_connection_t * tc);
 396 void tcp_connection_del (tcp_connection_t * tc);
 397 void tcp_connection_reset (tcp_connection_t * tc);
 398
 399 u8 *format_tcp_connection_id (u8 * s, va_list * args);
 400 u8 *format_tcp_connection (u8 * s, va_list * args);
 401 u8 *format_tcp_scoreboard (u8 * s, va_list * args);
 402
 403 always_inline tcp_connection_t *
 404 tcp_listener_get (u32 tli)
 405 {
 406   return pool_elt_at_index (tcp_main.listener_pool, tli);
 407 }
 408
 409 always_inline tcp_connection_t *
 410 tcp_half_open_connection_get (u32 conn_index)
 411 {
 412   return pool_elt_at_index (tcp_main.half_open_connections, conn_index);
 413 }
 414
 415 void tcp_make_ack (tcp_connection_t * ts, vlib_buffer_t * b);
 416 void tcp_make_fin (tcp_connection_t * tc, vlib_buffer_t * b);
 417 void tcp_make_synack (tcp_connection_t * ts, vlib_buffer_t * b);
 418 void tcp_send_reset (vlib_buffer_t * pkt, u8 is_ip4);
 419 void tcp_send_syn (tcp_connection_t * tc);
 420 void tcp_send_fin (tcp_connection_t * tc);
 421 void tcp_init_mss (tcp_connection_t * tc);
 422 void tcp_update_snd_mss (tcp_connection_t * tc);
 423 void tcp_update_rto (tcp_connection_t * tc);
 424
 425 always_inline u32
 426 tcp_end_seq (tcp_header_t * th, u32 len)
 427 {
 428   return th->seq_number + tcp_is_syn (th) + tcp_is_fin (th) + len;
 429 }
 430
 431 /* Modulo arithmetic for TCP sequence numbers */
 432 #define seq_lt(_s1, _s2) ((i32)((_s1)-(_s2)) < 0)
 433 #define seq_leq(_s1, _s2) ((i32)((_s1)-(_s2)) <= 0)
 434 #define seq_gt(_s1, _s2) ((i32)((_s1)-(_s2)) > 0)
 435 #define seq_geq(_s1, _s2) ((i32)((_s1)-(_s2)) >= 0)
 436
 437 /* Modulo arithmetic for timestamps */
 438 #define timestamp_lt(_t1, _t2) ((i32)((_t1)-(_t2)) < 0)
 439 #define timestamp_leq(_t1, _t2) ((i32)((_t1)-(_t2)) <= 0)
 440
 441 /**
 442  * Our estimate of the number of bytes that have left the network
 443  */
 444 always_inline u32
 445 tcp_bytes_out (const tcp_connection_t * tc)
 446 {
 447   if (tcp_opts_sack_permitted (&tc->rcv_opts))
 448     return tc->sack_sb.sacked_bytes + tc->sack_sb.lost_bytes;
 449   else
 450     return tc->rcv_dupacks * tc->snd_mss;
 451 }
 452
 453 /**
 454  * Our estimate of the number of bytes in flight (pipe size)
 455  */
 456 always_inline u32
 457 tcp_flight_size (const tcp_connection_t * tc)
 458 {
 459   int flight_size;
 460
 461   flight_size = (int) (tc->snd_una_max - tc->snd_una) - tcp_bytes_out (tc)
 462     + tc->snd_rxt_bytes;
 463
 464   if (flight_size < 0)
 465     {
 466       if (0)
 467         clib_warning
 468           ("Negative: %u %u %u dupacks %u sacked bytes %u flags %d",
 469            tc->snd_una_max - tc->snd_una, tcp_bytes_out (tc),
 470            tc->snd_rxt_bytes, tc->rcv_dupacks, tc->sack_sb.sacked_bytes,
 471            tc->rcv_opts.flags);
 472       return 0;
 473     }
 474
 475   return flight_size;
 476 }
 477
 478 /**
 479  * Initial cwnd as per RFC5681
 480  */
 481 always_inline u32
 482 tcp_initial_cwnd (const tcp_connection_t * tc)
 483 {
 484   if (tc->snd_mss > 2190)
 485     return 2 * tc->snd_mss;
 486   else if (tc->snd_mss > 1095)
 487     return 3 * tc->snd_mss;
 488   else
 489     return 4 * tc->snd_mss;
 490 }
 491
 492 always_inline u32
 493 tcp_loss_wnd (const tcp_connection_t * tc)
 494 {
 495   return tc->snd_mss;
 496 }
 497
 498 always_inline u32
 499 tcp_available_wnd (const tcp_connection_t * tc)
 500 {
 501   return clib_min (tc->cwnd, tc->snd_wnd);
 502 }
 503
 504 always_inline u32
 505 tcp_available_snd_space (const tcp_connection_t * tc)
 506 {
 507   u32 available_wnd = tcp_available_wnd (tc);
 508   u32 flight_size = tcp_flight_size (tc);
 509
 510   if (available_wnd <= flight_size)
 511     return 0;
 512
 513   return available_wnd - flight_size;
 514 }
 515
 516 i32 tcp_rcv_wnd_available (tcp_connection_t * tc);
 517 u32 tcp_snd_space (tcp_connection_t * tc);
 518 void tcp_update_rcv_wnd (tcp_connection_t * tc);
 519
 520 void tcp_retransmit_first_unacked (tcp_connection_t * tc);
 521 void tcp_fast_retransmit_no_sack (tcp_connection_t * tc);
 522 void tcp_fast_retransmit_sack (tcp_connection_t * tc);
 523 void tcp_fast_retransmit (tcp_connection_t * tc);
 524 void tcp_cc_init_congestion (tcp_connection_t * tc);
 525 int tcp_cc_recover (tcp_connection_t * tc);
 526 void tcp_cc_fastrecovery_exit (tcp_connection_t * tc);
 527
 528 /* Made public for unit testing only */
 529 void tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end);
 530
 531 always_inline u32
 532 tcp_time_now (void)
 533 {
 534   return clib_cpu_time_now () * tcp_main.tstamp_ticks_per_clock;
 535 }
 536
 537 always_inline void
 538 tcp_update_time (f64 now, u32 thread_index)
 539 {
 540   tw_timer_expire_timers_16t_2w_512sl (&tcp_main.timer_wheels[thread_index],
 541                                        now);
 542 }
 543
 544 u32 tcp_push_header (transport_connection_t * tconn, vlib_buffer_t * b);
 545
 546 u32
 547 tcp_prepare_retransmit_segment (tcp_connection_t * tc, vlib_buffer_t * b,
 548                                 u32 offset, u32 max_bytes);
 549
 550 void tcp_connection_timers_init (tcp_connection_t * tc);
 551 void tcp_connection_timers_reset (tcp_connection_t * tc);
 552 void tcp_connection_init_vars (tcp_connection_t * tc);
 553
 554 always_inline void
 555 tcp_connection_force_ack (tcp_connection_t * tc, vlib_buffer_t * b)
 556 {
 557   /* Reset flags, make sure ack is sent */
 558   tc->flags = TCP_CONN_SNDACK;
 559   vnet_buffer (b)->tcp.flags &= ~TCP_BUF_FLAG_DUPACK;
 560 }
 561
 562 always_inline void
 563 tcp_timer_set (tcp_connection_t * tc, u8 timer_id, u32 interval)
 564 {
 565   tc->timers[timer_id]
 566     = tw_timer_start_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
 567                                    tc->c_c_index, timer_id, interval);
 568 }
 569
 570 always_inline void
 571 tcp_timer_reset (tcp_connection_t * tc, u8 timer_id)
 572 {
 573   if (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID)
 574     return;
 575
 576   tw_timer_stop_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
 577                               tc->timers[timer_id]);
 578   tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
 579 }
 580
 581 always_inline void
 582 tcp_timer_update (tcp_connection_t * tc, u8 timer_id, u32 interval)
 583 {
 584   if (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID)
 585     tw_timer_stop_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
 586                                 tc->timers[timer_id]);
 587   tc->timers[timer_id] =
 588     tw_timer_start_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
 589                                  tc->c_c_index, timer_id, interval);
 590 }
 591
 592 /* XXX Switch retransmit to faster TW */
 593 always_inline void
 594 tcp_retransmit_timer_set (tcp_connection_t * tc)
 595 {
 596   tcp_timer_set (tc, TCP_TIMER_RETRANSMIT,
 597                  clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 598 }
 599
 600 always_inline void
 601 tcp_retransmit_timer_reset (tcp_connection_t * tc)
 602 {
 603   tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT);
 604 }
 605
 606 always_inline void
 607 tcp_retransmit_timer_force_update (tcp_connection_t * tc)
 608 {
 609   tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
 610                     clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 611 }
 612
 613 always_inline void
 614 tcp_persist_timer_set (tcp_connection_t * tc)
 615 {
 616   /* Reuse RTO. It's backed off in handler */
 617   tcp_timer_set (tc, TCP_TIMER_PERSIST,
 618                  clib_max (tc->rto * TCP_TO_TIMER_TICK,
 619                            TCP_TIMER_PERSIST_MIN));
 620 }
 621
 622 always_inline void
 623 tcp_persist_timer_update (tcp_connection_t * tc)
 624 {
 625   tcp_timer_update (tc, TCP_TIMER_PERSIST,
 626                     clib_max (tc->rto * TCP_TO_TIMER_TICK,
 627                               TCP_TIMER_PERSIST_MIN));
 628 }
 629
 630 always_inline void
 631 tcp_persist_timer_reset (tcp_connection_t * tc)
 632 {
 633   tcp_timer_reset (tc, TCP_TIMER_PERSIST);
 634 }
 635
 636 always_inline void
 637 tcp_retransmit_timer_update (tcp_connection_t * tc)
 638 {
 639   if (tc->snd_una == tc->snd_una_max)
 640     {
 641       tcp_retransmit_timer_reset (tc);
 642       if (tc->snd_wnd < tc->snd_mss)
 643         tcp_persist_timer_set (tc);
 644     }
 645   else
 646     tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
 647                       clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 648 }
 649
 650 always_inline u8
 651 tcp_timer_is_active (tcp_connection_t * tc, tcp_timers_e timer)
 652 {
 653   return tc->timers[timer] != TCP_TIMER_HANDLE_INVALID;
 654 }
 655
 656 #define tcp_validate_txf_size(_tc, _a)                                  \
 657   ASSERT(_tc->state != TCP_STATE_ESTABLISHED                            \
 658          || stream_session_tx_fifo_max_dequeue (&_tc->connection) >= _a)
 659
 660 void
 661 scoreboard_remove_hole (sack_scoreboard_t * sb,
 662                         sack_scoreboard_hole_t * hole);
 663 void scoreboard_update_lost (tcp_connection_t * tc, sack_scoreboard_t * sb);
 664 sack_scoreboard_hole_t *scoreboard_insert_hole (sack_scoreboard_t * sb,
 665                                                 u32 prev_index, u32 start,
 666                                                 u32 end);
 667 sack_scoreboard_hole_t *scoreboard_next_rxt_hole (sack_scoreboard_t * sb,
 668                                                   sack_scoreboard_hole_t *
 669                                                   start, u8 have_sent_1_smss,
 670                                                   u8 * can_rescue,
 671                                                   u8 * snd_limited);
 672 void scoreboard_init_high_rxt (sack_scoreboard_t * sb);
 673
 674 always_inline sack_scoreboard_hole_t *
 675 scoreboard_get_hole (sack_scoreboard_t * sb, u32 index)
 676 {
 677   if (index != TCP_INVALID_SACK_HOLE_INDEX)
 678     return pool_elt_at_index (sb->holes, index);
 679   return 0;
 680 }
 681
 682 always_inline sack_scoreboard_hole_t *
 683 scoreboard_next_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
 684 {
 685   if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
 686     return pool_elt_at_index (sb->holes, hole->next);
 687   return 0;
 688 }
 689
 690 always_inline sack_scoreboard_hole_t *
 691 scoreboard_prev_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
 692 {
 693   if (hole->prev != TCP_INVALID_SACK_HOLE_INDEX)
 694     return pool_elt_at_index (sb->holes, hole->prev);
 695   return 0;
 696 }
 697
 698 always_inline sack_scoreboard_hole_t *
 699 scoreboard_first_hole (sack_scoreboard_t * sb)
 700 {
 701   if (sb->head != TCP_INVALID_SACK_HOLE_INDEX)
 702     return pool_elt_at_index (sb->holes, sb->head);
 703   return 0;
 704 }
 705
 706 always_inline sack_scoreboard_hole_t *
 707 scoreboard_last_hole (sack_scoreboard_t * sb)
 708 {
 709   if (sb->tail != TCP_INVALID_SACK_HOLE_INDEX)
 710     return pool_elt_at_index (sb->holes, sb->tail);
 711   return 0;
 712 }
 713
 714 always_inline void
 715 scoreboard_clear (sack_scoreboard_t * sb)
 716 {
 717   sack_scoreboard_hole_t *hole;
 718   while ((hole = scoreboard_first_hole (sb)))
 719     {
 720       scoreboard_remove_hole (sb, hole);
 721     }
 722   sb->sacked_bytes = 0;
 723   sb->last_sacked_bytes = 0;
 724   sb->last_bytes_delivered = 0;
 725   sb->snd_una_adv = 0;
 726   sb->high_sacked = 0;
 727   sb->high_rxt = 0;
 728   sb->lost_bytes = 0;
 729   sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
 730 }
 731
 732 always_inline u32
 733 scoreboard_hole_bytes (sack_scoreboard_hole_t * hole)
 734 {
 735   return hole->end - hole->start;
 736 }
 737
 738 always_inline u32
 739 scoreboard_hole_index (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
 740 {
 741   return hole - sb->holes;
 742 }
 743
 744 always_inline void
 745 scoreboard_init (sack_scoreboard_t * sb)
 746 {
 747   sb->head = TCP_INVALID_SACK_HOLE_INDEX;
 748   sb->tail = TCP_INVALID_SACK_HOLE_INDEX;
 749   sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
 750 }
 751
 752 void tcp_rcv_sacks (tcp_connection_t * tc, u32 ack);
 753
 754 always_inline void
 755 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
 756                       const tcp_cc_algorithm_t * vft)
 757 {
 758   tcp_main_t *tm = vnet_get_tcp_main ();
 759   vec_validate (tm->cc_algos, type);
 760
 761   tm->cc_algos[type] = *vft;
 762 }
 763
 764 always_inline tcp_cc_algorithm_t *
 765 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
 766 {
 767   tcp_main_t *tm = vnet_get_tcp_main ();
 768   return &tm->cc_algos[type];
 769 }
 770
 771 void tcp_cc_init (tcp_connection_t * tc);
 772
 773 /**
 774  * Push TCP header to buffer
 775  *
 776  * @param vm - vlib_main
 777  * @param b - buffer to write the header to
 778  * @param sp_net - source port net order
 779  * @param dp_net - destination port net order
 780  * @param seq - sequence number net order
 781  * @param ack - ack number net order
 782  * @param tcp_hdr_opts_len - header and options length in bytes
 783  * @param flags - header flags
 784  * @param wnd - window size
 785  *
 786  * @return - pointer to start of TCP header
 787  */
 788 always_inline void *
 789 vlib_buffer_push_tcp_net_order (vlib_buffer_t * b, u16 sp, u16 dp, u32 seq,
 790                                 u32 ack, u8 tcp_hdr_opts_len, u8 flags,
 791                                 u16 wnd)
 792 {
 793   tcp_header_t *th;
 794
 795   th = vlib_buffer_push_uninit (b, tcp_hdr_opts_len);
 796
 797   th->src_port = sp;
 798   th->dst_port = dp;
 799   th->seq_number = seq;
 800   th->ack_number = ack;
 801   th->data_offset_and_reserved = (tcp_hdr_opts_len >> 2) << 4;
 802   th->flags = flags;
 803   th->window = wnd;
 804   th->checksum = 0;
 805   th->urgent_pointer = 0;
 806   return th;
 807 }
 808
 809 /**
 810  * Push TCP header to buffer
 811  *
 812  * @param b - buffer to write the header to
 813  * @param sp_net - source port net order
 814  * @param dp_net - destination port net order
 815  * @param seq - sequence number host order
 816  * @param ack - ack number host order
 817  * @param tcp_hdr_opts_len - header and options length in bytes
 818  * @param flags - header flags
 819  * @param wnd - window size
 820  *
 821  * @return - pointer to start of TCP header
 822  */
 823 always_inline void *
 824 vlib_buffer_push_tcp (vlib_buffer_t * b, u16 sp_net, u16 dp_net, u32 seq,
 825                       u32 ack, u8 tcp_hdr_opts_len, u8 flags, u16 wnd)
 826 {
 827   return vlib_buffer_push_tcp_net_order (b, sp_net, dp_net,
 828                                          clib_host_to_net_u32 (seq),
 829                                          clib_host_to_net_u32 (ack),
 830                                          tcp_hdr_opts_len, flags,
 831                                          clib_host_to_net_u16 (wnd));
 832 }
 833
 834 #endif /* _vnet_tcp_h_ */
 835
 836 /*
 837  * fd.io coding-style-patch-verification: ON
 838  *
 839  * Local Variables:
 840  * eval: (c-set-style "gnu")
 841  * End:
 842  */