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