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