src/vnet/tcp/tcp.h

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