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