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