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