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