src/vnet/tcp/tcp.h

   1 /*
   2  * Copyright (c) 2016-2019 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_FIB_RECHECK_PERIOD  1 * THZ /**< Recheck every 1s */
  32 #define TCP_MAX_OPTION_SPACE 40
  33 #define TCP_CC_DATA_SZ 24
  34
  35 #define TCP_DUPACK_THRESHOLD    3
  36 #define TCP_MAX_RX_FIFO_SIZE    32 << 20
  37 #define TCP_MIN_RX_FIFO_SIZE    4 << 10
  38 #define TCP_IW_N_SEGMENTS       10
  39 #define TCP_ALWAYS_ACK          1       /**< On/off delayed acks */
  40 #define TCP_USE_SACKS           1       /**< Disable only for testing */
  41
  42 /** TCP FSM state definitions as per RFC793. */
  43 #define foreach_tcp_fsm_state   \
  44   _(CLOSED, "CLOSED")           \
  45   _(LISTEN, "LISTEN")           \
  46   _(SYN_SENT, "SYN_SENT")       \
  47   _(SYN_RCVD, "SYN_RCVD")       \
  48   _(ESTABLISHED, "ESTABLISHED") \
  49   _(CLOSE_WAIT, "CLOSE_WAIT")   \
  50   _(FIN_WAIT_1, "FIN_WAIT_1")   \
  51   _(LAST_ACK, "LAST_ACK")       \
  52   _(CLOSING, "CLOSING")         \
  53   _(FIN_WAIT_2, "FIN_WAIT_2")   \
  54   _(TIME_WAIT, "TIME_WAIT")
  55
  56 typedef enum _tcp_state
  57 {
  58 #define _(sym, str) TCP_STATE_##sym,
  59   foreach_tcp_fsm_state
  60 #undef _
  61   TCP_N_STATES
  62 } tcp_state_t;
  63
  64 format_function_t format_tcp_state;
  65 format_function_t format_tcp_flags;
  66 format_function_t format_tcp_sacks;
  67 format_function_t format_tcp_rcv_sacks;
  68
  69 /** TCP timers */
  70 #define foreach_tcp_timer               \
  71   _(RETRANSMIT, "RETRANSMIT")           \
  72   _(DELACK, "DELAYED ACK")              \
  73   _(PERSIST, "PERSIST")                 \
  74   _(KEEP, "KEEP")                       \
  75   _(WAITCLOSE, "WAIT CLOSE")            \
  76   _(RETRANSMIT_SYN, "RETRANSMIT SYN")   \
  77   _(ESTABLISH, "ESTABLISH")             \
  78   _(ESTABLISH_AO, "ESTABLISH_AO")       \
  79
  80 typedef enum _tcp_timers
  81 {
  82 #define _(sym, str) TCP_TIMER_##sym,
  83   foreach_tcp_timer
  84 #undef _
  85   TCP_N_TIMERS
  86 } tcp_timers_e;
  87
  88 typedef void (timer_expiration_handler) (u32 index);
  89
  90 extern timer_expiration_handler tcp_timer_delack_handler;
  91 extern timer_expiration_handler tcp_timer_retransmit_handler;
  92 extern timer_expiration_handler tcp_timer_persist_handler;
  93 extern timer_expiration_handler tcp_timer_retransmit_syn_handler;
  94
  95 #define TCP_TIMER_HANDLE_INVALID ((u32) ~0)
  96
  97 /* Timer delays as multiples of 100ms */
  98 #define TCP_TO_TIMER_TICK       TCP_TICK*10     /* Period for converting from TCP
  99                                                  * ticks to timer units */
 100 #define TCP_DELACK_TIME         1       /* 0.1s */
 101 #define TCP_ESTABLISH_TIME      750     /* 75s */
 102 #define TCP_SYN_RCVD_TIME       600     /* 60s */
 103 #define TCP_2MSL_TIME           300     /* 30s */
 104 #define TCP_CLOSEWAIT_TIME      20      /* 2s */
 105 #define TCP_TIMEWAIT_TIME       100     /* 10s */
 106 #define TCP_FINWAIT1_TIME       600     /* 60s */
 107 #define TCP_CLEANUP_TIME        1       /* 0.1s */
 108 #define TCP_TIMER_PERSIST_MIN   2       /* 0.2s */
 109
 110 #define TCP_RTO_MAX 60 * THZ    /* Min max RTO (60s) as per RFC6298 */
 111 #define TCP_RTO_MIN 0.2 * THZ   /* Min RTO (200ms) - lower than standard */
 112 #define TCP_RTT_MAX 30 * THZ    /* 30s (probably too much) */
 113 #define TCP_RTO_SYN_RETRIES 3   /* SYN retries without doubling RTO */
 114 #define TCP_RTO_INIT 1 * THZ    /* Initial retransmit timer */
 115 #define TCP_RTO_BOFF_MAX 8      /* Max number of retries before reset */
 116
 117 /** TCP connection flags */
 118 #define foreach_tcp_connection_flag             \
 119   _(SNDACK, "Send ACK")                         \
 120   _(FINSNT, "FIN sent")                         \
 121   _(RECOVERY, "Recovery")                       \
 122   _(FAST_RECOVERY, "Fast Recovery")             \
 123   _(DCNT_PENDING, "Disconnect pending")         \
 124   _(HALF_OPEN_DONE, "Half-open completed")      \
 125   _(FINPNDG, "FIN pending")                     \
 126   _(FRXT_PENDING, "Fast-retransmit pending")    \
 127   _(FRXT_FIRST, "Fast-retransmit first again")  \
 128   _(DEQ_PENDING, "Pending dequeue acked")       \
 129   _(PSH_PENDING, "PSH pending")                 \
 130   _(FINRCVD, "FIN received")                    \
 131   _(RATE_SAMPLE, "Conn does rate sampling")     \
 132   _(TRACK_BURST, "Track burst")                 \
 133   _(ZERO_RWND_SENT, "Zero RWND sent")           \
 134
 135 typedef enum _tcp_connection_flag_bits
 136 {
 137 #define _(sym, str) TCP_CONN_##sym##_BIT,
 138   foreach_tcp_connection_flag
 139 #undef _
 140   TCP_CONN_N_FLAG_BITS
 141 } tcp_connection_flag_bits_e;
 142
 143 typedef enum _tcp_connection_flag
 144 {
 145 #define _(sym, str) TCP_CONN_##sym = 1 << TCP_CONN_##sym##_BIT,
 146   foreach_tcp_connection_flag
 147 #undef _
 148   TCP_CONN_N_FLAGS
 149 } tcp_connection_flags_e;
 150
 151 #define TCP_SCOREBOARD_TRACE (0)
 152 #define TCP_MAX_SACK_BLOCKS 256 /**< Max number of SACK blocks stored */
 153 #define TCP_INVALID_SACK_HOLE_INDEX ((u32)~0)
 154
 155 typedef struct _scoreboard_trace_elt
 156 {
 157   u32 start;
 158   u32 end;
 159   u32 ack;
 160   u32 snd_una_max;
 161   u32 group;
 162 } scoreboard_trace_elt_t;
 163
 164 typedef struct _sack_scoreboard_hole
 165 {
 166   u32 next;             /**< Index for next entry in linked list */
 167   u32 prev;             /**< Index for previous entry in linked list */
 168   u32 start;            /**< Start sequence number */
 169   u32 end;              /**< End sequence number */
 170   u8 is_lost;           /**< Mark hole as lost */
 171 } sack_scoreboard_hole_t;
 172
 173 typedef struct _sack_scoreboard
 174 {
 175   sack_scoreboard_hole_t *holes;        /**< Pool of holes */
 176   u32 head;                             /**< Index of first entry */
 177   u32 tail;                             /**< Index of last entry */
 178   u32 sacked_bytes;                     /**< Number of bytes sacked in sb */
 179   u32 last_sacked_bytes;                /**< Number of bytes last sacked */
 180   u32 last_bytes_delivered;             /**< Sack bytes delivered to app */
 181   u32 snd_una_adv;                      /**< Bytes to add to snd_una */
 182   u32 high_sacked;                      /**< Highest byte sacked (fack) */
 183   u32 high_rxt;                         /**< Highest retransmitted sequence */
 184   u32 rescue_rxt;                       /**< Rescue sequence number */
 185   u32 lost_bytes;                       /**< Bytes lost as per RFC6675 */
 186   u32 last_lost_bytes;                  /**< Number of bytes last lost */
 187   u32 cur_rxt_hole;                     /**< Retransmitting from this hole */
 188
 189 #if TCP_SCOREBOARD_TRACE
 190   scoreboard_trace_elt_t *trace;
 191 #endif
 192
 193 } sack_scoreboard_t;
 194
 195 #if TCP_SCOREBOARD_TRACE
 196 #define tcp_scoreboard_trace_add(_tc, _ack)                             \
 197 {                                                                       \
 198     static u64 _group = 0;                                              \
 199     sack_scoreboard_t *_sb = &_tc->sack_sb;                             \
 200     sack_block_t *_sack, *_sacks;                                       \
 201     scoreboard_trace_elt_t *_elt;                                       \
 202     int i;                                                              \
 203     _group++;                                                           \
 204     _sacks = _tc->rcv_opts.sacks;                                       \
 205     for (i = 0; i < vec_len (_sacks); i++)                              \
 206       {                                                                 \
 207         _sack = &_sacks[i];                                             \
 208         vec_add2 (_sb->trace, _elt, 1);                                 \
 209         _elt->start = _sack->start;                                     \
 210         _elt->end = _sack->end;                                         \
 211         _elt->ack = _elt->end == _ack ? _ack : 0;                       \
 212         _elt->snd_una_max = _elt->end == _ack ? _tc->snd_una_max : 0;   \
 213         _elt->group = _group;                                           \
 214       }                                                                 \
 215 }
 216 #else
 217 #define tcp_scoreboard_trace_add(_tc, _ack)
 218 #endif
 219
 220 sack_scoreboard_hole_t *scoreboard_next_rxt_hole (sack_scoreboard_t * sb,
 221                                                   sack_scoreboard_hole_t *
 222                                                   start, u8 have_sent_1_smss,
 223                                                   u8 * can_rescue,
 224                                                   u8 * snd_limited);
 225 sack_scoreboard_hole_t *scoreboard_get_hole (sack_scoreboard_t * sb,
 226                                              u32 index);
 227
 228 sack_scoreboard_hole_t *scoreboard_next_hole (sack_scoreboard_t * sb,
 229                                               sack_scoreboard_hole_t * hole);
 230 sack_scoreboard_hole_t *scoreboard_prev_hole (sack_scoreboard_t * sb,
 231                                               sack_scoreboard_hole_t * hole);
 232 sack_scoreboard_hole_t *scoreboard_first_hole (sack_scoreboard_t * sb);
 233 sack_scoreboard_hole_t *scoreboard_last_hole (sack_scoreboard_t * sb);
 234 void scoreboard_clear (sack_scoreboard_t * sb);
 235 void scoreboard_init (sack_scoreboard_t * sb);
 236 u8 *format_tcp_scoreboard (u8 * s, va_list * args);
 237
 238 #define TCP_BTS_INVALID_INDEX   ((u32)~0)
 239
 240 typedef enum tcp_bts_flags_
 241 {
 242   TCP_BTS_IS_RXT = 1,
 243   TCP_BTS_IS_APP_LIMITED = 1 << 1,
 244 } __clib_packed tcp_bts_flags_t;
 245
 246 typedef struct tcp_bt_sample_
 247 {
 248   u32 next;                     /**< Next sample index in list */
 249   u32 prev;                     /**< Previous sample index in list */
 250   u32 min_seq;                  /**< Min seq number in sample */
 251   u32 max_seq;                  /**< Max seq number. Set for rxt samples */
 252   u64 delivered;                /**< Total delivered bytes for sample */
 253   f64 delivered_time;           /**< Delivered time when sample taken */
 254   f64 tx_time;                  /**< Transmit time for the burst */
 255   u64 tx_rate;                  /**< Tx pacing rate */
 256   tcp_bts_flags_t flags;        /**< Sample flag */
 257 } tcp_bt_sample_t;
 258
 259 typedef struct tcp_rate_sample_
 260 {
 261   u64 prior_delivered;          /**< Delivered of sample used for rate, i.e.,
 262                                      total bytes delivered at prior_time */
 263   f64 prior_time;               /**< Delivered time of sample used for rate */
 264   f64 interval_time;            /**< Time to ack the bytes delivered */
 265   f64 rtt_time;                 /**< RTT for sample */
 266   u64 tx_rate;                  /**< Tx pacing rate */
 267   u32 delivered;                /**< Bytes delivered in interval_time */
 268   u32 acked_and_sacked;         /**< Bytes acked + sacked now */
 269   u32 lost;                     /**< Bytes lost now */
 270   tcp_bts_flags_t flags;        /**< Rate sample flags from bt sample */
 271 } tcp_rate_sample_t;
 272
 273 typedef struct tcp_byte_tracker_
 274 {
 275   tcp_bt_sample_t *samples;     /**< Pool of samples */
 276   rb_tree_t sample_lookup;      /**< Rbtree for sample lookup by min_seq */
 277   u32 head;                     /**< Head of samples linked list */
 278   u32 tail;                     /**< Tail of samples linked list */
 279   u32 last_ooo;                 /**< Cached last ooo sample */
 280 } tcp_byte_tracker_t;
 281
 282 typedef enum _tcp_cc_algorithm_type
 283 {
 284   TCP_CC_NEWRENO,
 285   TCP_CC_CUBIC,
 286   TCP_CC_LAST = TCP_CC_CUBIC
 287 } tcp_cc_algorithm_type_e;
 288
 289 typedef struct _tcp_cc_algorithm tcp_cc_algorithm_t;
 290
 291 typedef enum _tcp_cc_ack_t
 292 {
 293   TCP_CC_ACK,
 294   TCP_CC_DUPACK,
 295   TCP_CC_PARTIALACK
 296 } tcp_cc_ack_t;
 297
 298 typedef enum tcp_cc_event_
 299 {
 300   TCP_CC_EVT_START_TX,
 301 } tcp_cc_event_t;
 302
 303 typedef struct _tcp_connection
 304 {
 305   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 306   transport_connection_t connection;  /**< Common transport data. First! */
 307
 308   u8 state;                     /**< TCP state as per tcp_state_t */
 309   u16 flags;                    /**< Connection flags (see tcp_conn_flags_e) */
 310   u32 timers[TCP_N_TIMERS];     /**< Timer handles into timer wheel */
 311
 312   /* TODO RFC4898 */
 313
 314   /** Send sequence variables RFC793 */
 315   u32 snd_una;          /**< oldest unacknowledged sequence number */
 316   u32 snd_una_max;      /**< newest unacknowledged sequence number + 1*/
 317   u32 snd_wnd;          /**< send window */
 318   u32 snd_wl1;          /**< seq number used for last snd.wnd update */
 319   u32 snd_wl2;          /**< ack number used for last snd.wnd update */
 320   u32 snd_nxt;          /**< next seq number to be sent */
 321   u16 snd_mss;          /**< Effective send max seg (data) size */
 322
 323   /** Receive sequence variables RFC793 */
 324   u32 rcv_nxt;          /**< next sequence number expected */
 325   u32 rcv_wnd;          /**< receive window we expect */
 326
 327   u32 rcv_las;          /**< rcv_nxt at last ack sent/rcv_wnd update */
 328   u32 iss;              /**< initial sent sequence */
 329   u32 irs;              /**< initial remote sequence */
 330
 331   /* Options */
 332   u8 snd_opts_len;              /**< Tx options len */
 333   u8 rcv_wscale;                /**< Window scale to advertise to peer */
 334   u8 snd_wscale;                /**< Window scale to use when sending */
 335   u32 tsval_recent;             /**< Last timestamp received */
 336   u32 tsval_recent_age;         /**< When last updated tstamp_recent*/
 337   tcp_options_t snd_opts;       /**< Tx options for connection */
 338   tcp_options_t rcv_opts;       /**< Rx options for connection */
 339
 340   sack_block_t *snd_sacks;      /**< Vector of SACKs to send. XXX Fixed size? */
 341   u8 snd_sack_pos;              /**< Position in vec of first block to send */
 342   sack_block_t *snd_sacks_fl;   /**< Vector for building new list */
 343   sack_scoreboard_t sack_sb;    /**< SACK "scoreboard" that tracks holes */
 344
 345   u16 rcv_dupacks;      /**< Number of DUPACKs received */
 346   u8 pending_dupacks;   /**< Number of DUPACKs to be sent */
 347
 348   /* Congestion control */
 349   u32 cwnd;             /**< Congestion window */
 350   u32 cwnd_acc_bytes;   /**< Bytes accumulated for cwnd increment */
 351   u32 ssthresh;         /**< Slow-start threshold */
 352   u32 prev_ssthresh;    /**< ssthresh before congestion */
 353   u32 prev_cwnd;        /**< ssthresh before congestion */
 354   u32 bytes_acked;      /**< Bytes acknowledged by current segment */
 355   u32 burst_acked;      /**< Bytes acknowledged in current burst */
 356   u32 snd_rxt_bytes;    /**< Retransmitted bytes */
 357   u32 snd_rxt_ts;       /**< Timestamp when first packet is retransmitted */
 358   u32 tsecr_last_ack;   /**< Timestamp echoed to us in last healthy ACK */
 359   u32 snd_congestion;   /**< snd_una_max when congestion is detected */
 360   u32 tx_fifo_size;     /**< Tx fifo size. Used to constrain cwnd */
 361   tcp_cc_algorithm_t *cc_algo;  /**< Congestion control algorithm */
 362   u8 cc_data[TCP_CC_DATA_SZ];   /**< Congestion control algo private data */
 363
 364   /* RTT and RTO */
 365   u32 rto;              /**< Retransmission timeout */
 366   u32 rto_boff;         /**< Index for RTO backoff */
 367   u32 srtt;             /**< Smoothed RTT */
 368   u32 rttvar;           /**< Smoothed mean RTT difference. Approximates variance */
 369   u32 rtt_seq;          /**< Sequence number for tracked ACK */
 370   f64 rtt_ts;           /**< Timestamp for tracked ACK */
 371   f64 mrtt_us;          /**< High precision mrtt from tracked acks */
 372
 373   u32 psh_seq;          /**< Add psh header for seg that includes this */
 374   u32 next_node_index;  /**< Can be used to control next node in output */
 375   u32 next_node_opaque; /**< Opaque to pass to next node */
 376   u32 limited_transmit; /**< snd_nxt when limited transmit starts */
 377   u32 sw_if_index;      /**< Interface for the connection */
 378
 379   /* Delivery rate estimation */
 380   u64 delivered;                /**< Total bytes delivered to peer */
 381   u64 app_limited;              /**< Delivered when app-limited detected */
 382   f64 delivered_time;           /**< Time last bytes were acked */
 383   tcp_byte_tracker_t *bt;       /**< Tx byte tracker */
 384
 385   u32 last_fib_check;   /**< Last time we checked fib route for peer */
 386   u16 mss;              /**< Our max seg size that includes options */
 387   u32 timestamp_delta;
 388 } tcp_connection_t;
 389
 390 /* *INDENT-OFF* */
 391 struct _tcp_cc_algorithm
 392 {
 393   const char *name;
 394   uword (*unformat_cfg) (unformat_input_t * input);
 395   void (*init) (tcp_connection_t * tc);
 396   void (*cleanup) (tcp_connection_t * tc);
 397   void (*rcv_ack) (tcp_connection_t * tc, tcp_rate_sample_t *rs);
 398   void (*rcv_cong_ack) (tcp_connection_t * tc, tcp_cc_ack_t ack,
 399                         tcp_rate_sample_t *rs);
 400   void (*congestion) (tcp_connection_t * tc);
 401   void (*loss) (tcp_connection_t * tc);
 402   void (*recovered) (tcp_connection_t * tc);
 403   void (*undo_recovery) (tcp_connection_t * tc);
 404   void (*event) (tcp_connection_t *tc, tcp_cc_event_t evt);
 405 };
 406 /* *INDENT-ON* */
 407
 408 #define tcp_fastrecovery_on(tc) (tc)->flags |= TCP_CONN_FAST_RECOVERY
 409 #define tcp_fastrecovery_off(tc) (tc)->flags &= ~TCP_CONN_FAST_RECOVERY
 410 #define tcp_recovery_on(tc) (tc)->flags |= TCP_CONN_RECOVERY
 411 #define tcp_recovery_off(tc) (tc)->flags &= ~TCP_CONN_RECOVERY
 412 #define tcp_in_fastrecovery(tc) ((tc)->flags & TCP_CONN_FAST_RECOVERY)
 413 #define tcp_in_recovery(tc) ((tc)->flags & (TCP_CONN_RECOVERY))
 414 #define tcp_in_slowstart(tc) (tc->cwnd < tc->ssthresh)
 415 #define tcp_disconnect_pending(tc) ((tc)->flags & TCP_CONN_DCNT_PENDING)
 416 #define tcp_disconnect_pending_on(tc) ((tc)->flags |= TCP_CONN_DCNT_PENDING)
 417 #define tcp_disconnect_pending_off(tc) ((tc)->flags &= ~TCP_CONN_DCNT_PENDING)
 418 #define tcp_fastrecovery_first(tc) ((tc)->flags & TCP_CONN_FRXT_FIRST)
 419 #define tcp_fastrecovery_first_on(tc) ((tc)->flags |= TCP_CONN_FRXT_FIRST)
 420 #define tcp_fastrecovery_first_off(tc) ((tc)->flags &= ~TCP_CONN_FRXT_FIRST)
 421
 422 #define tcp_in_cong_recovery(tc) ((tc)->flags &                 \
 423           (TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
 424
 425 always_inline void
 426 tcp_cong_recovery_off (tcp_connection_t * tc)
 427 {
 428   tc->flags &= ~(TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY);
 429   tcp_fastrecovery_first_off (tc);
 430 }
 431
 432 #define tcp_zero_rwnd_sent(tc) (tc)->flags &= TCP_CONN_ZERO_RWND_SENT
 433 #define tcp_zero_rwnd_sent_on(tc) (tc)->flags |= TCP_CONN_ZERO_RWND_SENT
 434 #define tcp_zero_rwnd_sent_off(tc) (tc)->flags &= ~TCP_CONN_ZERO_RWND_SENT
 435
 436 typedef enum _tcp_error
 437 {
 438 #define tcp_error(n,s) TCP_ERROR_##n,
 439 #include <vnet/tcp/tcp_error.def>
 440 #undef tcp_error
 441   TCP_N_ERROR,
 442 } tcp_error_t;
 443
 444 typedef struct _tcp_lookup_dispatch
 445 {
 446   u8 next, error;
 447 } tcp_lookup_dispatch_t;
 448
 449 typedef struct tcp_worker_ctx_
 450 {
 451   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 452   /** worker time */
 453   u32 time_now;
 454
 455   /** worker timer wheel */
 456   tw_timer_wheel_16t_2w_512sl_t timer_wheel;
 457
 458   /** tx buffer free list */
 459   u32 *tx_buffers;
 460
 461   /** tx frames for tcp 4/6 output nodes */
 462   vlib_frame_t *tx_frames[2];
 463
 464   /** tx frames for ip 4/6 lookup nodes */
 465   vlib_frame_t *ip_lookup_tx_frames[2];
 466
 467   /** vector of connections needing fast rxt */
 468   u32 *pending_fast_rxt;
 469
 470   /** vector of connections now doing fast rxt */
 471   u32 *ongoing_fast_rxt;
 472
 473   /** vector of connections that will do fast rxt */
 474   u32 *postponed_fast_rxt;
 475
 476   /** vector of pending ack dequeues */
 477   u32 *pending_deq_acked;
 478
 479   /** vector of pending acks */
 480   u32 *pending_acks;
 481
 482   /** vector of pending disconnect notifications */
 483   u32 *pending_disconnects;
 484
 485   /** convenience pointer to this thread's vlib main */
 486   vlib_main_t *vm;
 487
 488     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 489
 490   /** cached 'on the wire' options for bursts */
 491   u8 cached_opts[40];
 492
 493 } tcp_worker_ctx_t;
 494
 495 typedef struct tcp_iss_seed_
 496 {
 497   u64 first;
 498   u64 second;
 499 } tcp_iss_seed_t;
 500
 501 typedef struct _tcp_main
 502 {
 503   /* Per-worker thread tcp connection pools */
 504   tcp_connection_t **connections;
 505
 506   /* Pool of listeners. */
 507   tcp_connection_t *listener_pool;
 508
 509   /** Dispatch table by state and flags */
 510   tcp_lookup_dispatch_t dispatch_table[TCP_N_STATES][64];
 511
 512   u8 log2_tstamp_clocks_per_tick;
 513   f64 tstamp_ticks_per_clock;
 514
 515   /** per-worker context */
 516   tcp_worker_ctx_t *wrk_ctx;
 517
 518   /* Pool of half-open connections on which we've sent a SYN */
 519   tcp_connection_t *half_open_connections;
 520   clib_spinlock_t half_open_lock;
 521
 522   /** vlib buffer size */
 523   u32 bytes_per_buffer;
 524
 525   /* Seed used to generate random iss */
 526   tcp_iss_seed_t iss_seed;
 527
 528   /* Congestion control algorithms registered */
 529   tcp_cc_algorithm_t *cc_algos;
 530
 531   /** Hash table of cc algorithms by name */
 532   uword *cc_algo_by_name;
 533
 534   /** Last cc algo registered */
 535   tcp_cc_algorithm_type_e cc_last_type;
 536
 537   /*
 538    * Configuration
 539    */
 540
 541   /* Flag that indicates if stack is on or off */
 542   u8 is_enabled;
 543
 544   /** Max rx fifo size for a session. It is used in to compute the
 545    *  rfc 7323 window scaling factor */
 546   u32 max_rx_fifo;
 547
 548   /** Default MTU to be used when establishing connections */
 549   u16 default_mtu;
 550
 551   /** Initial CWND multiplier, which multiplies MSS to determine initial CWND.
 552    *  Set 0 to determine the initial CWND by another way */
 553   u16 initial_cwnd_multiplier;
 554
 555   /** Number of preallocated connections */
 556   u32 preallocated_connections;
 557   u32 preallocated_half_open_connections;
 558
 559   /** Vectors of src addresses. Optional unless one needs > 63K active-opens */
 560   ip4_address_t *ip4_src_addresses;
 561   u32 last_v4_address_rotor;
 562   u32 last_v6_address_rotor;
 563   ip6_address_t *ip6_src_addresses;
 564
 565   /** Enable tx pacing for new connections */
 566   u8 tx_pacing;
 567
 568   u8 punt_unknown4;
 569   u8 punt_unknown6;
 570
 571   /** fault-injection */
 572   f64 buffer_fail_fraction;
 573
 574   /** Default congestion control algorithm type */
 575   tcp_cc_algorithm_type_e cc_algo;
 576 } tcp_main_t;
 577
 578 extern tcp_main_t tcp_main;
 579 extern vlib_node_registration_t tcp4_input_node;
 580 extern vlib_node_registration_t tcp6_input_node;
 581 extern vlib_node_registration_t tcp4_output_node;
 582 extern vlib_node_registration_t tcp6_output_node;
 583 extern vlib_node_registration_t tcp4_established_node;
 584 extern vlib_node_registration_t tcp6_established_node;
 585 extern vlib_node_registration_t tcp4_syn_sent_node;
 586 extern vlib_node_registration_t tcp6_syn_sent_node;
 587 extern vlib_node_registration_t tcp4_rcv_process_node;
 588 extern vlib_node_registration_t tcp6_rcv_process_node;
 589 extern vlib_node_registration_t tcp4_listen_node;
 590 extern vlib_node_registration_t tcp6_listen_node;
 591
 592 always_inline tcp_main_t *
 593 vnet_get_tcp_main ()
 594 {
 595   return &tcp_main;
 596 }
 597
 598 always_inline tcp_worker_ctx_t *
 599 tcp_get_worker (u32 thread_index)
 600 {
 601   return &tcp_main.wrk_ctx[thread_index];
 602 }
 603
 604 always_inline tcp_header_t *
 605 tcp_buffer_hdr (vlib_buffer_t * b)
 606 {
 607   ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
 608   return (tcp_header_t *) (b->data + b->current_data
 609                            + vnet_buffer (b)->tcp.hdr_offset);
 610 }
 611
 612 #if (VLIB_BUFFER_TRACE_TRAJECTORY)
 613 #define tcp_trajectory_add_start(b, start)                      \
 614 {                                                               \
 615     (*vlib_buffer_trace_trajectory_cb) (b, start);              \
 616 }
 617 #else
 618 #define tcp_trajectory_add_start(b, start)
 619 #endif
 620
 621 clib_error_t *vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en);
 622
 623 void tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
 624
 625 always_inline tcp_connection_t *
 626 tcp_connection_get (u32 conn_index, u32 thread_index)
 627 {
 628   if (PREDICT_FALSE
 629       (pool_is_free_index (tcp_main.connections[thread_index], conn_index)))
 630     return 0;
 631   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 632 }
 633
 634 always_inline tcp_connection_t *
 635 tcp_connection_get_if_valid (u32 conn_index, u32 thread_index)
 636 {
 637   if (tcp_main.connections[thread_index] == 0)
 638     return 0;
 639   if (pool_is_free_index (tcp_main.connections[thread_index], conn_index))
 640     return 0;
 641   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 642 }
 643
 644 always_inline tcp_connection_t *
 645 tcp_get_connection_from_transport (transport_connection_t * tconn)
 646 {
 647   return (tcp_connection_t *) tconn;
 648 }
 649
 650 always_inline void
 651 tcp_connection_set_state (tcp_connection_t * tc, tcp_state_t state)
 652 {
 653   tc->state = state;
 654   TCP_EVT_DBG (TCP_EVT_STATE_CHANGE, tc);
 655 }
 656
 657 void tcp_connection_close (tcp_connection_t * tc);
 658 void tcp_connection_cleanup (tcp_connection_t * tc);
 659 void tcp_connection_del (tcp_connection_t * tc);
 660 int tcp_half_open_connection_cleanup (tcp_connection_t * tc);
 661 tcp_connection_t *tcp_connection_alloc (u8 thread_index);
 662 void tcp_connection_free (tcp_connection_t * tc);
 663 void tcp_connection_reset (tcp_connection_t * tc);
 664 int tcp_configure_v4_source_address_range (vlib_main_t * vm,
 665                                            ip4_address_t * start,
 666                                            ip4_address_t * end, u32 table_id);
 667 int tcp_configure_v6_source_address_range (vlib_main_t * vm,
 668                                            ip6_address_t * start,
 669                                            ip6_address_t * end, u32 table_id);
 670 void tcp_api_reference (void);
 671 u8 *format_tcp_connection (u8 * s, va_list * args);
 672
 673 always_inline tcp_connection_t *
 674 tcp_listener_get (u32 tli)
 675 {
 676   return pool_elt_at_index (tcp_main.listener_pool, tli);
 677 }
 678
 679 always_inline tcp_connection_t *
 680 tcp_half_open_connection_get (u32 conn_index)
 681 {
 682   tcp_connection_t *tc = 0;
 683   clib_spinlock_lock_if_init (&tcp_main.half_open_lock);
 684   if (!pool_is_free_index (tcp_main.half_open_connections, conn_index))
 685     tc = pool_elt_at_index (tcp_main.half_open_connections, conn_index);
 686   clib_spinlock_unlock_if_init (&tcp_main.half_open_lock);
 687   return tc;
 688 }
 689
 690 void tcp_make_fin (tcp_connection_t * tc, vlib_buffer_t * b);
 691 void tcp_make_synack (tcp_connection_t * ts, vlib_buffer_t * b);
 692 void tcp_send_reset_w_pkt (tcp_connection_t * tc, vlib_buffer_t * pkt,
 693                            u32 thread_index, u8 is_ip4);
 694 void tcp_send_reset (tcp_connection_t * tc);
 695 void tcp_send_syn (tcp_connection_t * tc);
 696 void tcp_send_synack (tcp_connection_t * tc);
 697 void tcp_send_fin (tcp_connection_t * tc);
 698 void tcp_init_mss (tcp_connection_t * tc);
 699 void tcp_update_burst_snd_vars (tcp_connection_t * tc);
 700 void tcp_update_rto (tcp_connection_t * tc);
 701 void tcp_flush_frame_to_output (tcp_worker_ctx_t * wrk, u8 is_ip4);
 702 void tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk);
 703 void tcp_program_fastretransmit (tcp_worker_ctx_t * wrk,
 704                                  tcp_connection_t * tc);
 705 void tcp_do_fastretransmits (tcp_worker_ctx_t * wrk);
 706
 707 void tcp_program_ack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc);
 708 void tcp_program_dupack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc);
 709 void tcp_send_acks (tcp_worker_ctx_t * wrk);
 710 void tcp_send_window_update_ack (tcp_connection_t * tc);
 711
 712 /*
 713  * Rate estimation
 714  */
 715
 716 /**
 717  * Byte tracker initialize
 718  *
 719  * @param tc    connection for which the byte tracker should be allocated and
 720  *              initialized
 721  */
 722 void tcp_bt_init (tcp_connection_t * tc);
 723 /**
 724  * Byte tracker cleanup
 725  *
 726  * @param tc    connection for which the byte tracker should be cleaned up
 727  */
 728 void tcp_bt_cleanup (tcp_connection_t * tc);
 729 /**
 730  * Flush byte tracker samples
 731  *
 732  * @param tc    tcp connection for which samples should be flushed
 733  */
 734 void tcp_bt_flush_samples (tcp_connection_t * tc);
 735 /**
 736  * Track a tcp tx burst
 737  *
 738  * @param tc    tcp connection
 739  */
 740 void tcp_bt_track_tx (tcp_connection_t * tc);
 741 /**
 742  * Track a tcp retransmission
 743  *
 744  * @param tc    tcp connection
 745  * @param start start sequence number
 746  * @param end   end sequence number
 747  */
 748 void tcp_bt_track_rxt (tcp_connection_t * tc, u32 start, u32 end);
 749 /**
 750  * Generate a delivery rate sample from recently acked bytes
 751  *
 752  * @param tc    tcp connection
 753  * @param rs    resulting rate sample
 754  */
 755 void tcp_bt_sample_delivery_rate (tcp_connection_t * tc,
 756                                   tcp_rate_sample_t * rs);
 757 /**
 758  * Check if sample to be generated is app limited
 759  *
 760  * @param tc    tcp connection
 761  */
 762 void tcp_bt_check_app_limited (tcp_connection_t * tc);
 763 /**
 764  * Check if the byte tracker is in sane state
 765  *
 766  * Should be used only for testing
 767  *
 768  * @param bt    byte tracker
 769  */
 770 int tcp_bt_is_sane (tcp_byte_tracker_t * bt);
 771
 772 always_inline u32
 773 tcp_end_seq (tcp_header_t * th, u32 len)
 774 {
 775   return th->seq_number + tcp_is_syn (th) + tcp_is_fin (th) + len;
 776 }
 777
 778 /* Modulo arithmetic for TCP sequence numbers */
 779 #define seq_lt(_s1, _s2) ((i32)((_s1)-(_s2)) < 0)
 780 #define seq_leq(_s1, _s2) ((i32)((_s1)-(_s2)) <= 0)
 781 #define seq_gt(_s1, _s2) ((i32)((_s1)-(_s2)) > 0)
 782 #define seq_geq(_s1, _s2) ((i32)((_s1)-(_s2)) >= 0)
 783 #define seq_max(_s1, _s2) (seq_gt((_s1), (_s2)) ? (_s1) : (_s2))
 784
 785 /* Modulo arithmetic for timestamps */
 786 #define timestamp_lt(_t1, _t2) ((i32)((_t1)-(_t2)) < 0)
 787 #define timestamp_leq(_t1, _t2) ((i32)((_t1)-(_t2)) <= 0)
 788
 789 /**
 790  * Our estimate of the number of bytes that have left the network
 791  */
 792 always_inline u32
 793 tcp_bytes_out (const tcp_connection_t * tc)
 794 {
 795   if (tcp_opts_sack_permitted (&tc->rcv_opts))
 796     return tc->sack_sb.sacked_bytes + tc->sack_sb.lost_bytes;
 797   else
 798     return tc->rcv_dupacks * tc->snd_mss;
 799 }
 800
 801 /**
 802  * Our estimate of the number of bytes in flight (pipe size)
 803  */
 804 always_inline u32
 805 tcp_flight_size (const tcp_connection_t * tc)
 806 {
 807   int flight_size;
 808
 809   flight_size = (int) (tc->snd_nxt - tc->snd_una) - tcp_bytes_out (tc)
 810     + tc->snd_rxt_bytes;
 811
 812   if (flight_size < 0)
 813     {
 814       if (0)
 815         clib_warning
 816           ("Negative: %u %u %u dupacks %u sacked bytes %u flags %d",
 817            tc->snd_una_max - tc->snd_una, tcp_bytes_out (tc),
 818            tc->snd_rxt_bytes, tc->rcv_dupacks, tc->sack_sb.sacked_bytes,
 819            tc->rcv_opts.flags);
 820       return 0;
 821     }
 822
 823   return flight_size;
 824 }
 825
 826 /**
 827  * Initial cwnd as per RFC5681
 828  */
 829 always_inline u32
 830 tcp_initial_cwnd (const tcp_connection_t * tc)
 831 {
 832   if (tcp_main.initial_cwnd_multiplier > 0)
 833     return tcp_main.initial_cwnd_multiplier * tc->snd_mss;
 834
 835   if (tc->snd_mss > 2190)
 836     return 2 * tc->snd_mss;
 837   else if (tc->snd_mss > 1095)
 838     return 3 * tc->snd_mss;
 839   else
 840     return 4 * tc->snd_mss;
 841 }
 842
 843 /*
 844  * Accumulate acked bytes for cwnd increase
 845  *
 846  * Once threshold bytes are accumulated, snd_mss bytes are added
 847  * to the cwnd.
 848  */
 849 always_inline void
 850 tcp_cwnd_accumulate (tcp_connection_t * tc, u32 thresh, u32 bytes)
 851 {
 852   tc->cwnd_acc_bytes += bytes;
 853   if (tc->cwnd_acc_bytes >= thresh)
 854     {
 855       u32 inc = tc->cwnd_acc_bytes / thresh;
 856       tc->cwnd_acc_bytes -= inc * thresh;
 857       tc->cwnd += inc * tc->snd_mss;
 858       tc->cwnd = clib_min (tc->cwnd, tc->tx_fifo_size);
 859     }
 860 }
 861
 862 always_inline u32
 863 tcp_loss_wnd (const tcp_connection_t * tc)
 864 {
 865   return tc->snd_mss;
 866 }
 867
 868 always_inline u32
 869 tcp_available_snd_wnd (const tcp_connection_t * tc)
 870 {
 871   return clib_min (tc->cwnd, tc->snd_wnd);
 872 }
 873
 874 always_inline u32
 875 tcp_available_output_snd_space (const tcp_connection_t * tc)
 876 {
 877   u32 available_wnd = tcp_available_snd_wnd (tc);
 878   int flight_size = (int) (tc->snd_nxt - tc->snd_una);
 879
 880   if (available_wnd <= flight_size)
 881     return 0;
 882
 883   return available_wnd - flight_size;
 884 }
 885
 886 /**
 887  * Estimate of how many bytes we can still push into the network
 888  */
 889 always_inline u32
 890 tcp_available_cc_snd_space (const tcp_connection_t * tc)
 891 {
 892   u32 available_wnd = tcp_available_snd_wnd (tc);
 893   u32 flight_size = tcp_flight_size (tc);
 894
 895   if (available_wnd <= flight_size)
 896     return 0;
 897
 898   return available_wnd - flight_size;
 899 }
 900
 901 always_inline u8
 902 tcp_is_lost_fin (tcp_connection_t * tc)
 903 {
 904   if ((tc->flags & TCP_CONN_FINSNT) && tc->snd_una_max - tc->snd_una == 1)
 905     return 1;
 906   return 0;
 907 }
 908
 909 u32 tcp_snd_space (tcp_connection_t * tc);
 910 int tcp_retransmit_first_unacked (tcp_worker_ctx_t * wrk,
 911                                   tcp_connection_t * tc);
 912 int tcp_fast_retransmit_no_sack (tcp_worker_ctx_t * wrk,
 913                                  tcp_connection_t * tc, u32 burst_size);
 914 int tcp_fast_retransmit_sack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
 915                               u32 burst_size);
 916 int tcp_fast_retransmit (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
 917                          u32 burst_size);
 918 void tcp_cc_init_congestion (tcp_connection_t * tc);
 919 void tcp_cc_fastrecovery_clear (tcp_connection_t * tc);
 920
 921 fib_node_index_t tcp_lookup_rmt_in_fib (tcp_connection_t * tc);
 922
 923 /* Made public for unit testing only */
 924 void tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end);
 925 u32 tcp_sack_list_bytes (tcp_connection_t * tc);
 926
 927 always_inline u32
 928 tcp_time_now (void)
 929 {
 930   return tcp_main.wrk_ctx[vlib_get_thread_index ()].time_now;
 931 }
 932
 933 always_inline u32
 934 tcp_time_now_w_thread (u32 thread_index)
 935 {
 936   return tcp_main.wrk_ctx[thread_index].time_now;
 937 }
 938
 939 /**
 940  * Generate timestamp for tcp connection
 941  */
 942 always_inline u32
 943 tcp_tstamp (tcp_connection_t * tc)
 944 {
 945   return (tcp_main.wrk_ctx[tc->c_thread_index].time_now -
 946           tc->timestamp_delta);
 947 }
 948
 949 always_inline f64
 950 tcp_time_now_us (u32 thread_index)
 951 {
 952   return transport_time_now (thread_index);
 953 }
 954
 955 always_inline u32
 956 tcp_set_time_now (tcp_worker_ctx_t * wrk)
 957 {
 958   wrk->time_now = clib_cpu_time_now () * tcp_main.tstamp_ticks_per_clock;
 959   return wrk->time_now;
 960 }
 961
 962 u32 tcp_session_push_header (transport_connection_t * tconn,
 963                              vlib_buffer_t * b);
 964
 965 void tcp_connection_timers_init (tcp_connection_t * tc);
 966 void tcp_connection_timers_reset (tcp_connection_t * tc);
 967 void tcp_init_snd_vars (tcp_connection_t * tc);
 968 void tcp_connection_init_vars (tcp_connection_t * tc);
 969 void tcp_connection_tx_pacer_update (tcp_connection_t * tc);
 970 void tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
 971                                     u32 start_bucket);
 972
 973 always_inline void
 974 tcp_cc_rcv_ack (tcp_connection_t * tc, tcp_rate_sample_t * rs)
 975 {
 976   tc->cc_algo->rcv_ack (tc, rs);
 977   tc->tsecr_last_ack = tc->rcv_opts.tsecr;
 978 }
 979
 980 static inline void
 981 tcp_cc_rcv_cong_ack (tcp_connection_t * tc, tcp_cc_ack_t ack_type,
 982                      tcp_rate_sample_t * rs)
 983 {
 984   tc->cc_algo->rcv_cong_ack (tc, ack_type, rs);
 985 }
 986
 987 static inline void
 988 tcp_cc_loss (tcp_connection_t * tc)
 989 {
 990   tc->cc_algo->loss (tc);
 991 }
 992
 993 static inline void
 994 tcp_cc_recovered (tcp_connection_t * tc)
 995 {
 996   tc->cc_algo->recovered (tc);
 997 }
 998
 999 static inline void
1000 tcp_cc_undo_recovery (tcp_connection_t * tc)
1001 {
1002   if (tc->cc_algo->undo_recovery)
1003     tc->cc_algo->undo_recovery (tc);
1004 }
1005
1006 static inline void
1007 tcp_cc_event (tcp_connection_t * tc, tcp_cc_event_t evt)
1008 {
1009   if (tc->cc_algo->event)
1010     tc->cc_algo->event (tc, evt);
1011 }
1012
1013 always_inline void
1014 tcp_timer_set (tcp_connection_t * tc, u8 timer_id, u32 interval)
1015 {
1016   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
1017   ASSERT (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID);
1018   tc->timers[timer_id] =
1019     tw_timer_start_16t_2w_512sl (&tcp_main.
1020                                  wrk_ctx[tc->c_thread_index].timer_wheel,
1021                                  tc->c_c_index, timer_id, interval);
1022 }
1023
1024 always_inline void
1025 tcp_timer_reset (tcp_connection_t * tc, u8 timer_id)
1026 {
1027   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
1028   if (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID)
1029     return;
1030
1031   tw_timer_stop_16t_2w_512sl (&tcp_main.
1032                               wrk_ctx[tc->c_thread_index].timer_wheel,
1033                               tc->timers[timer_id]);
1034   tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1035 }
1036
1037 always_inline void
1038 tcp_timer_update (tcp_connection_t * tc, u8 timer_id, u32 interval)
1039 {
1040   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
1041   if (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID)
1042     tw_timer_update_16t_2w_512sl (&tcp_main.
1043                                   wrk_ctx[tc->c_thread_index].timer_wheel,
1044                                   tc->timers[timer_id], interval);
1045   else
1046     tc->timers[timer_id] =
1047       tw_timer_start_16t_2w_512sl (&tcp_main.
1048                                    wrk_ctx[tc->c_thread_index].timer_wheel,
1049                                    tc->c_c_index, timer_id, interval);
1050 }
1051
1052 always_inline void
1053 tcp_retransmit_timer_set (tcp_connection_t * tc)
1054 {
1055   ASSERT (tc->snd_una != tc->snd_una_max);
1056   tcp_timer_set (tc, TCP_TIMER_RETRANSMIT,
1057                  clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
1058 }
1059
1060 always_inline void
1061 tcp_retransmit_timer_reset (tcp_connection_t * tc)
1062 {
1063   tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT);
1064 }
1065
1066 always_inline void
1067 tcp_retransmit_timer_force_update (tcp_connection_t * tc)
1068 {
1069   tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
1070                     clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
1071 }
1072
1073 always_inline void
1074 tcp_persist_timer_set (tcp_connection_t * tc)
1075 {
1076   /* Reuse RTO. It's backed off in handler */
1077   tcp_timer_set (tc, TCP_TIMER_PERSIST,
1078                  clib_max (tc->rto * TCP_TO_TIMER_TICK,
1079                            TCP_TIMER_PERSIST_MIN));
1080 }
1081
1082 always_inline void
1083 tcp_persist_timer_update (tcp_connection_t * tc)
1084 {
1085   tcp_timer_update (tc, TCP_TIMER_PERSIST,
1086                     clib_max (tc->rto * TCP_TO_TIMER_TICK,
1087                               TCP_TIMER_PERSIST_MIN));
1088 }
1089
1090 always_inline void
1091 tcp_persist_timer_reset (tcp_connection_t * tc)
1092 {
1093   tcp_timer_reset (tc, TCP_TIMER_PERSIST);
1094 }
1095
1096 always_inline void
1097 tcp_retransmit_timer_update (tcp_connection_t * tc)
1098 {
1099   if (tc->snd_una == tc->snd_nxt)
1100     {
1101       tcp_retransmit_timer_reset (tc);
1102       if (tc->snd_wnd < tc->snd_mss)
1103         tcp_persist_timer_update (tc);
1104     }
1105   else
1106     tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
1107                       clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
1108 }
1109
1110 always_inline u8
1111 tcp_timer_is_active (tcp_connection_t * tc, tcp_timers_e timer)
1112 {
1113   return tc->timers[timer] != TCP_TIMER_HANDLE_INVALID;
1114 }
1115
1116 #define tcp_validate_txf_size(_tc, _a)                                  \
1117   ASSERT(_tc->state != TCP_STATE_ESTABLISHED                            \
1118          || transport_max_tx_dequeue (&_tc->connection) >= _a)
1119
1120 void tcp_rcv_sacks (tcp_connection_t * tc, u32 ack);
1121 u8 *tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose);
1122
1123 /**
1124  * Register exiting cc algo type
1125  */
1126 void tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
1127                            const tcp_cc_algorithm_t * vft);
1128
1129 /**
1130  * Register new cc algo type
1131  */
1132 tcp_cc_algorithm_type_e tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft);
1133 tcp_cc_algorithm_t *tcp_cc_algo_get (tcp_cc_algorithm_type_e type);
1134
1135 static inline void *
1136 tcp_cc_data (tcp_connection_t * tc)
1137 {
1138   return (void *) tc->cc_data;
1139 }
1140
1141 void newreno_rcv_cong_ack (tcp_connection_t * tc, tcp_cc_ack_t ack_type,
1142                            tcp_rate_sample_t * rs);
1143
1144 /**
1145  * Push TCP header to buffer
1146  *
1147  * @param vm - vlib_main
1148  * @param b - buffer to write the header to
1149  * @param sp_net - source port net order
1150  * @param dp_net - destination port net order
1151  * @param seq - sequence number net order
1152  * @param ack - ack number net order
1153  * @param tcp_hdr_opts_len - header and options length in bytes
1154  * @param flags - header flags
1155  * @param wnd - window size
1156  *
1157  * @return - pointer to start of TCP header
1158  */
1159 always_inline void *
1160 vlib_buffer_push_tcp_net_order (vlib_buffer_t * b, u16 sp, u16 dp, u32 seq,
1161                                 u32 ack, u8 tcp_hdr_opts_len, u8 flags,
1162                                 u16 wnd)
1163 {
1164   tcp_header_t *th;
1165
1166   th = vlib_buffer_push_uninit (b, tcp_hdr_opts_len);
1167
1168   th->src_port = sp;
1169   th->dst_port = dp;
1170   th->seq_number = seq;
1171   th->ack_number = ack;
1172   th->data_offset_and_reserved = (tcp_hdr_opts_len >> 2) << 4;
1173   th->flags = flags;
1174   th->window = wnd;
1175   th->checksum = 0;
1176   th->urgent_pointer = 0;
1177   return th;
1178 }
1179
1180 /**
1181  * Push TCP header to buffer
1182  *
1183  * @param b - buffer to write the header to
1184  * @param sp_net - source port net order
1185  * @param dp_net - destination port net order
1186  * @param seq - sequence number host order
1187  * @param ack - ack number host order
1188  * @param tcp_hdr_opts_len - header and options length in bytes
1189  * @param flags - header flags
1190  * @param wnd - window size
1191  *
1192  * @return - pointer to start of TCP header
1193  */
1194 always_inline void *
1195 vlib_buffer_push_tcp (vlib_buffer_t * b, u16 sp_net, u16 dp_net, u32 seq,
1196                       u32 ack, u8 tcp_hdr_opts_len, u8 flags, u16 wnd)
1197 {
1198   return vlib_buffer_push_tcp_net_order (b, sp_net, dp_net,
1199                                          clib_host_to_net_u32 (seq),
1200                                          clib_host_to_net_u32 (ack),
1201                                          tcp_hdr_opts_len, flags,
1202                                          clib_host_to_net_u16 (wnd));
1203 }
1204
1205 #endif /* _vnet_tcp_h_ */
1206
1207 /*
1208  * fd.io coding-style-patch-verification: ON
1209  *
1210  * Local Variables:
1211  * eval: (c-set-style "gnu")
1212  * End:
1213  */