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