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