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