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