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
 440 #define rst_state snd_wl1
 441 } tcp_connection_t;
 442
 443 /* *INDENT-OFF* */
 444 struct _tcp_cc_algorithm
 445 {
 446   const char *name;
 447   uword (*unformat_cfg) (unformat_input_t * input);
 448   void (*init) (tcp_connection_t * tc);
 449   void (*cleanup) (tcp_connection_t * tc);
 450   void (*rcv_ack) (tcp_connection_t * tc, tcp_rate_sample_t *rs);
 451   void (*rcv_cong_ack) (tcp_connection_t * tc, tcp_cc_ack_t ack,
 452                         tcp_rate_sample_t *rs);
 453   void (*congestion) (tcp_connection_t * tc);
 454   void (*loss) (tcp_connection_t * tc);
 455   void (*recovered) (tcp_connection_t * tc);
 456   void (*undo_recovery) (tcp_connection_t * tc);
 457   void (*event) (tcp_connection_t *tc, tcp_cc_event_t evt);
 458   u64 (*get_pacing_rate) (tcp_connection_t *tc);
 459 };
 460 /* *INDENT-ON* */
 461
 462 #define tcp_fastrecovery_on(tc) (tc)->flags |= TCP_CONN_FAST_RECOVERY
 463 #define tcp_fastrecovery_off(tc) (tc)->flags &= ~TCP_CONN_FAST_RECOVERY
 464 #define tcp_recovery_on(tc) (tc)->flags |= TCP_CONN_RECOVERY
 465 #define tcp_recovery_off(tc) (tc)->flags &= ~TCP_CONN_RECOVERY
 466 #define tcp_in_fastrecovery(tc) ((tc)->flags & TCP_CONN_FAST_RECOVERY)
 467 #define tcp_in_recovery(tc) ((tc)->flags & (TCP_CONN_RECOVERY))
 468 #define tcp_in_slowstart(tc) (tc->cwnd < tc->ssthresh)
 469 #define tcp_disconnect_pending(tc) ((tc)->flags & TCP_CONN_DCNT_PENDING)
 470 #define tcp_disconnect_pending_on(tc) ((tc)->flags |= TCP_CONN_DCNT_PENDING)
 471 #define tcp_disconnect_pending_off(tc) ((tc)->flags &= ~TCP_CONN_DCNT_PENDING)
 472 #define tcp_fastrecovery_first(tc) ((tc)->flags & TCP_CONN_FRXT_FIRST)
 473 #define tcp_fastrecovery_first_on(tc) ((tc)->flags |= TCP_CONN_FRXT_FIRST)
 474 #define tcp_fastrecovery_first_off(tc) ((tc)->flags &= ~TCP_CONN_FRXT_FIRST)
 475
 476 #define tcp_in_cong_recovery(tc) ((tc)->flags &                 \
 477           (TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
 478
 479 #define tcp_csum_offload(tc) (!((tc)->cfg_flags & TCP_CFG_F_NO_CSUM_OFFLOAD))
 480
 481 always_inline void
 482 tcp_cong_recovery_off (tcp_connection_t * tc)
 483 {
 484   tc->flags &= ~(TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY);
 485   tcp_fastrecovery_first_off (tc);
 486 }
 487
 488 #define tcp_zero_rwnd_sent(tc) ((tc)->flags & TCP_CONN_ZERO_RWND_SENT)
 489 #define tcp_zero_rwnd_sent_on(tc) (tc)->flags |= TCP_CONN_ZERO_RWND_SENT
 490 #define tcp_zero_rwnd_sent_off(tc) (tc)->flags &= ~TCP_CONN_ZERO_RWND_SENT
 491
 492 typedef enum _tcp_error
 493 {
 494 #define tcp_error(n,s) TCP_ERROR_##n,
 495 #include <vnet/tcp/tcp_error.def>
 496 #undef tcp_error
 497   TCP_N_ERROR,
 498 } tcp_error_t;
 499
 500 typedef struct _tcp_lookup_dispatch
 501 {
 502   u8 next, error;
 503 } tcp_lookup_dispatch_t;
 504
 505 #define foreach_tcp_wrk_stat                                    \
 506   _(timer_expirations, u64, "timer expirations")                \
 507   _(rxt_segs, u64, "segments retransmitted")                    \
 508   _(tr_events, u32, "timer retransmit events")                  \
 509   _(to_closewait, u32, "timeout close-wait")                    \
 510   _(to_finwait1, u32, "timeout fin-wait-1")                     \
 511   _(to_lastack, u32, "timeout last-ack")                        \
 512   _(to_closing, u32, "timeout closing")                         \
 513   _(tr_abort, u32, "timer retransmit abort")                    \
 514   _(rst_unread, u32, "reset on close due to unread data")       \
 515
 516 typedef struct tcp_wrk_stats_
 517 {
 518 #define _(name, type, str) type name;
 519   foreach_tcp_wrk_stat
 520 #undef _
 521 } tcp_wrk_stats_t;
 522
 523 typedef struct tcp_worker_ctx_
 524 {
 525   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 526
 527   /** worker's pool of connections */
 528   tcp_connection_t *connections;
 529
 530   /** vector of pending ack dequeues */
 531   u32 *pending_deq_acked;
 532
 533   /** vector of pending disconnect notifications */
 534   u32 *pending_disconnects;
 535
 536   /** vector of pending reset notifications */
 537   u32 *pending_resets;
 538
 539   /** convenience pointer to this thread's vlib main */
 540   vlib_main_t *vm;
 541
 542   /** worker time */
 543   u32 time_now;
 544
 545   /** tx frames for ip 4/6 lookup nodes */
 546   vlib_frame_t *ip_lookup_tx_frames[2];
 547
 548     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 549
 550   /** cached 'on the wire' options for bursts */
 551   u8 cached_opts[40];
 552
 553   /** tx buffer free list */
 554   u32 *tx_buffers;
 555
 556   /** worker timer wheel */
 557   tw_timer_wheel_16t_2w_512sl_t timer_wheel;
 558
 559     CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
 560
 561   tcp_wrk_stats_t stats;
 562 } tcp_worker_ctx_t;
 563
 564 #define tcp_worker_stats_inc(_ti,_stat,_val)            \
 565   tcp_main.wrk_ctx[_ti].stats._stat += _val
 566
 567 #define tcp_workerp_stats_inc(_wrk,_stat,_val)          \
 568   _wrk->stats._stat += _val
 569
 570 typedef struct tcp_iss_seed_
 571 {
 572   u64 first;
 573   u64 second;
 574 } tcp_iss_seed_t;
 575
 576 typedef struct tcp_configuration_
 577 {
 578   /** Max rx fifo size for a session (in bytes). It is used in to compute the
 579    *  rfc 7323 window scaling factor */
 580   u32 max_rx_fifo;
 581
 582   /** Min rx fifo for a session (in bytes) */
 583   u32 min_rx_fifo;
 584
 585   /** Default MTU to be used when establishing connections */
 586   u16 default_mtu;
 587
 588   /** Initial CWND multiplier, which multiplies MSS to determine initial CWND.
 589    *  Set 0 to determine the initial CWND by another way */
 590   u16 initial_cwnd_multiplier;
 591
 592   /** Enable tx pacing for new connections */
 593   u8 enable_tx_pacing;
 594
 595   /** Allow use of TSO whenever available */
 596   u8 allow_tso;
 597
 598   /** Set if csum offloading is enabled */
 599   u8 csum_offload;
 600
 601   /** Default congestion control algorithm type */
 602   tcp_cc_algorithm_type_e cc_algo;
 603
 604   /** Min rwnd, as number of snd_mss segments, for update ack to be sent after
 605    * a zero rwnd advertisement */
 606   u32 rwnd_min_update_ack;
 607
 608   /** Delayed ack time (disabled) */
 609   u16 delack_time;
 610
 611   /** Timer ticks to wait for close from app */
 612   u16 closewait_time;
 613
 614   /** Timer ticks to wait in time-wait. Also known as 2MSL */
 615   u16 timewait_time;
 616
 617   /** Timer ticks to wait in fin-wait1 to send fin and rcv fin-ack */
 618   u16 finwait1_time;
 619
 620   /** Timer ticks to wait in last ack for ack */
 621   u16 lastack_time;
 622
 623   /** Timer ticks to wait in fin-wait2 for fin */
 624   u16 finwait2_time;
 625
 626   /** Timer ticks to wait in closing for fin ack */
 627   u16 closing_time;
 628
 629   /** Timer ticks to wait before cleaning up the connection */
 630   u16 cleanup_time;
 631
 632   /** Number of preallocated connections */
 633   u32 preallocated_connections;
 634
 635   /** Number of preallocated half-open connections */
 636   u32 preallocated_half_open_connections;
 637
 638   /** Vectors of src addresses. Optional unless one needs > 63K active-opens */
 639   ip4_address_t *ip4_src_addrs;
 640   ip6_address_t *ip6_src_addrs;
 641
 642   /** Fault-injection. Debug only */
 643   f64 buffer_fail_fraction;
 644 } tcp_configuration_t;
 645
 646 typedef struct _tcp_main
 647 {
 648   /** per-worker context */
 649   tcp_worker_ctx_t *wrk_ctx;
 650
 651   /* Pool of listeners. */
 652   tcp_connection_t *listener_pool;
 653
 654   f64 tstamp_ticks_per_clock;
 655
 656   /** vlib buffer size */
 657   u32 bytes_per_buffer;
 658
 659   /** Dispatch table by state and flags */
 660   tcp_lookup_dispatch_t dispatch_table[TCP_N_STATES][64];
 661
 662   clib_spinlock_t half_open_lock;
 663
 664   /** Pool of half-open connections on which we've sent a SYN */
 665   tcp_connection_t *half_open_connections;
 666
 667   /** Seed used to generate random iss */
 668   tcp_iss_seed_t iss_seed;
 669
 670   /** Congestion control algorithms registered */
 671   tcp_cc_algorithm_t *cc_algos;
 672
 673   /** Hash table of cc algorithms by name */
 674   uword *cc_algo_by_name;
 675
 676   /** Last cc algo registered */
 677   tcp_cc_algorithm_type_e cc_last_type;
 678
 679   /** Flag that indicates if stack is on or off */
 680   u8 is_enabled;
 681
 682   /** Flag that indicates if v4 punting is enabled */
 683   u8 punt_unknown4;
 684
 685   /** Flag that indicates if v6 punting is enabled */
 686   u8 punt_unknown6;
 687
 688   /** Rotor for v4 source addresses */
 689   u32 last_v4_addr_rotor;
 690
 691   /** Rotor for v6 source addresses */
 692   u32 last_v6_addr_rotor;
 693
 694   /** Protocol configuration */
 695   tcp_configuration_t cfg;
 696 } tcp_main_t;
 697
 698 extern tcp_main_t tcp_main;
 699 extern vlib_node_registration_t tcp4_input_node;
 700 extern vlib_node_registration_t tcp6_input_node;
 701 extern vlib_node_registration_t tcp4_output_node;
 702 extern vlib_node_registration_t tcp6_output_node;
 703 extern vlib_node_registration_t tcp4_established_node;
 704 extern vlib_node_registration_t tcp6_established_node;
 705 extern vlib_node_registration_t tcp4_syn_sent_node;
 706 extern vlib_node_registration_t tcp6_syn_sent_node;
 707 extern vlib_node_registration_t tcp4_rcv_process_node;
 708 extern vlib_node_registration_t tcp6_rcv_process_node;
 709 extern vlib_node_registration_t tcp4_listen_node;
 710 extern vlib_node_registration_t tcp6_listen_node;
 711
 712 #define tcp_cfg tcp_main.cfg
 713 #define tcp_node_index(node_id, is_ip4)                                 \
 714   ((is_ip4) ? tcp4_##node_id##_node.index : tcp6_##node_id##_node.index)
 715
 716 always_inline tcp_main_t *
 717 vnet_get_tcp_main ()
 718 {
 719   return &tcp_main;
 720 }
 721
 722 always_inline tcp_worker_ctx_t *
 723 tcp_get_worker (u32 thread_index)
 724 {
 725   ASSERT (thread_index < vec_len (tcp_main.wrk_ctx));
 726   return &tcp_main.wrk_ctx[thread_index];
 727 }
 728
 729 always_inline tcp_header_t *
 730 tcp_buffer_hdr (vlib_buffer_t * b)
 731 {
 732   ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
 733   return (tcp_header_t *) (b->data + b->current_data
 734                            + vnet_buffer (b)->tcp.hdr_offset);
 735 }
 736
 737 #if (VLIB_BUFFER_TRACE_TRAJECTORY)
 738 #define tcp_trajectory_add_start(b, start)                      \
 739 {                                                               \
 740     (*vlib_buffer_trace_trajectory_cb) (b, start);              \
 741 }
 742 #else
 743 #define tcp_trajectory_add_start(b, start)
 744 #endif
 745
 746 clib_error_t *vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en);
 747
 748 void tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
 749
 750 always_inline tcp_connection_t *
 751 tcp_connection_get (u32 conn_index, u32 thread_index)
 752 {
 753   tcp_worker_ctx_t *wrk = tcp_get_worker (thread_index);
 754   if (PREDICT_FALSE (pool_is_free_index (wrk->connections, conn_index)))
 755     return 0;
 756   return pool_elt_at_index (wrk->connections, conn_index);
 757 }
 758
 759 always_inline tcp_connection_t *
 760 tcp_connection_get_if_valid (u32 conn_index, u32 thread_index)
 761 {
 762   tcp_worker_ctx_t *wrk;
 763   if (thread_index >= vec_len (tcp_main.wrk_ctx))
 764     return 0;
 765   wrk = tcp_get_worker (thread_index);
 766   if (pool_is_free_index (wrk->connections, conn_index))
 767     return 0;
 768   return pool_elt_at_index (wrk->connections, conn_index);
 769 }
 770
 771 always_inline tcp_connection_t *
 772 tcp_get_connection_from_transport (transport_connection_t * tconn)
 773 {
 774   return (tcp_connection_t *) tconn;
 775 }
 776
 777 always_inline void
 778 tcp_connection_set_state (tcp_connection_t * tc, tcp_state_t state)
 779 {
 780   tc->state = state;
 781   TCP_EVT (TCP_EVT_STATE_CHANGE, tc);
 782 }
 783
 784 void tcp_connection_close (tcp_connection_t * tc);
 785 void tcp_connection_cleanup (tcp_connection_t * tc);
 786 void tcp_connection_del (tcp_connection_t * tc);
 787 int tcp_half_open_connection_cleanup (tcp_connection_t * tc);
 788 tcp_connection_t *tcp_connection_alloc (u8 thread_index);
 789 tcp_connection_t *tcp_connection_alloc_w_base (u8 thread_index,
 790                                                tcp_connection_t * base);
 791 void tcp_connection_free (tcp_connection_t * tc);
 792 int tcp_configure_v4_source_address_range (vlib_main_t * vm,
 793                                            ip4_address_t * start,
 794                                            ip4_address_t * end, u32 table_id);
 795 int tcp_configure_v6_source_address_range (vlib_main_t * vm,
 796                                            ip6_address_t * start,
 797                                            ip6_address_t * end, u32 table_id);
 798 void tcp_api_reference (void);
 799 u8 *format_tcp_connection (u8 * s, va_list * args);
 800 u8 *format_tcp_connection_id (u8 * s, va_list * args);
 801
 802 always_inline tcp_connection_t *
 803 tcp_listener_get (u32 tli)
 804 {
 805   tcp_connection_t *tc = 0;
 806   if (!pool_is_free_index (tcp_main.listener_pool, tli))
 807     tc = pool_elt_at_index (tcp_main.listener_pool, tli);
 808   return tc;
 809 }
 810
 811 always_inline tcp_connection_t *
 812 tcp_half_open_connection_get (u32 conn_index)
 813 {
 814   tcp_connection_t *tc = 0;
 815   clib_spinlock_lock_if_init (&tcp_main.half_open_lock);
 816   if (!pool_is_free_index (tcp_main.half_open_connections, conn_index))
 817     tc = pool_elt_at_index (tcp_main.half_open_connections, conn_index);
 818   clib_spinlock_unlock_if_init (&tcp_main.half_open_lock);
 819   return tc;
 820 }
 821
 822 void tcp_make_fin (tcp_connection_t * tc, vlib_buffer_t * b);
 823 void tcp_make_synack (tcp_connection_t * ts, vlib_buffer_t * b);
 824 void tcp_send_reset_w_pkt (tcp_connection_t * tc, vlib_buffer_t * pkt,
 825                            u32 thread_index, u8 is_ip4);
 826 void tcp_send_reset (tcp_connection_t * tc);
 827 void tcp_send_syn (tcp_connection_t * tc);
 828 void tcp_send_synack (tcp_connection_t * tc);
 829 void tcp_send_fin (tcp_connection_t * tc);
 830 void tcp_send_ack (tcp_connection_t * tc);
 831 void tcp_update_burst_snd_vars (tcp_connection_t * tc);
 832 void tcp_update_rto (tcp_connection_t * tc);
 833 void tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk);
 834 void tcp_send_window_update_ack (tcp_connection_t * tc);
 835
 836 void tcp_program_ack (tcp_connection_t * tc);
 837 void tcp_program_dupack (tcp_connection_t * tc);
 838 void tcp_program_retransmit (tcp_connection_t * tc);
 839
 840 /*
 841  * Rate estimation
 842  */
 843
 844 /**
 845  * Byte tracker initialize
 846  *
 847  * @param tc    connection for which the byte tracker should be allocated and
 848  *              initialized
 849  */
 850 void tcp_bt_init (tcp_connection_t * tc);
 851 /**
 852  * Byte tracker cleanup
 853  *
 854  * @param tc    connection for which the byte tracker should be cleaned up
 855  */
 856 void tcp_bt_cleanup (tcp_connection_t * tc);
 857 /**
 858  * Flush byte tracker samples
 859  *
 860  * @param tc    tcp connection for which samples should be flushed
 861  */
 862 void tcp_bt_flush_samples (tcp_connection_t * tc);
 863 /**
 864  * Track a tcp tx burst
 865  *
 866  * @param tc    tcp connection
 867  */
 868 void tcp_bt_track_tx (tcp_connection_t * tc, u32 len);
 869 /**
 870  * Track a tcp retransmission
 871  *
 872  * @param tc    tcp connection
 873  * @param start start sequence number
 874  * @param end   end sequence number
 875  */
 876 void tcp_bt_track_rxt (tcp_connection_t * tc, u32 start, u32 end);
 877 /**
 878  * Generate a delivery rate sample from recently acked bytes
 879  *
 880  * @param tc    tcp connection
 881  * @param rs    resulting rate sample
 882  */
 883 void tcp_bt_sample_delivery_rate (tcp_connection_t * tc,
 884                                   tcp_rate_sample_t * rs);
 885 /**
 886  * Check if sample to be generated is app limited
 887  *
 888  * @param tc    tcp connection
 889  */
 890 void tcp_bt_check_app_limited (tcp_connection_t * tc);
 891 /**
 892  * Check if the byte tracker is in sane state
 893  *
 894  * Should be used only for testing
 895  *
 896  * @param bt    byte tracker
 897  */
 898 int tcp_bt_is_sane (tcp_byte_tracker_t * bt);
 899 u8 *format_tcp_bt (u8 * s, va_list * args);
 900
 901 always_inline u32
 902 tcp_end_seq (tcp_header_t * th, u32 len)
 903 {
 904   return th->seq_number + tcp_is_syn (th) + tcp_is_fin (th) + len;
 905 }
 906
 907 /* Modulo arithmetic for TCP sequence numbers */
 908 #define seq_lt(_s1, _s2) ((i32)((_s1)-(_s2)) < 0)
 909 #define seq_leq(_s1, _s2) ((i32)((_s1)-(_s2)) <= 0)
 910 #define seq_gt(_s1, _s2) ((i32)((_s1)-(_s2)) > 0)
 911 #define seq_geq(_s1, _s2) ((i32)((_s1)-(_s2)) >= 0)
 912 #define seq_max(_s1, _s2) (seq_gt((_s1), (_s2)) ? (_s1) : (_s2))
 913
 914 /* Modulo arithmetic for timestamps */
 915 #define timestamp_lt(_t1, _t2) ((i32)((_t1)-(_t2)) < 0)
 916 #define timestamp_leq(_t1, _t2) ((i32)((_t1)-(_t2)) <= 0)
 917
 918 /**
 919  * Our estimate of the number of bytes that have left the network
 920  */
 921 always_inline u32
 922 tcp_bytes_out (const tcp_connection_t * tc)
 923 {
 924   if (tcp_opts_sack_permitted (&tc->rcv_opts))
 925     return tc->sack_sb.sacked_bytes + tc->sack_sb.lost_bytes;
 926   else
 927     return clib_min (tc->rcv_dupacks * tc->snd_mss,
 928                      tc->snd_nxt - tc->snd_una);
 929 }
 930
 931 /**
 932  * Our estimate of the number of bytes in flight (pipe size)
 933  */
 934 always_inline u32
 935 tcp_flight_size (const tcp_connection_t * tc)
 936 {
 937   int flight_size;
 938
 939   flight_size = (int) (tc->snd_nxt - tc->snd_una) - tcp_bytes_out (tc)
 940     + tc->snd_rxt_bytes - tc->rxt_delivered;
 941
 942   ASSERT (flight_size >= 0);
 943
 944   return flight_size;
 945 }
 946
 947 /**
 948  * Initial cwnd as per RFC5681
 949  */
 950 always_inline u32
 951 tcp_initial_cwnd (const tcp_connection_t * tc)
 952 {
 953   if (tcp_cfg.initial_cwnd_multiplier > 0)
 954     return tcp_cfg.initial_cwnd_multiplier * tc->snd_mss;
 955
 956   if (tc->snd_mss > 2190)
 957     return 2 * tc->snd_mss;
 958   else if (tc->snd_mss > 1095)
 959     return 3 * tc->snd_mss;
 960   else
 961     return 4 * tc->snd_mss;
 962 }
 963
 964 /*
 965  * Accumulate acked bytes for cwnd increase
 966  *
 967  * Once threshold bytes are accumulated, snd_mss bytes are added
 968  * to the cwnd.
 969  */
 970 always_inline void
 971 tcp_cwnd_accumulate (tcp_connection_t * tc, u32 thresh, u32 bytes)
 972 {
 973   tc->cwnd_acc_bytes += bytes;
 974   if (tc->cwnd_acc_bytes >= thresh)
 975     {
 976       u32 inc = tc->cwnd_acc_bytes / thresh;
 977       tc->cwnd_acc_bytes -= inc * thresh;
 978       tc->cwnd += inc * tc->snd_mss;
 979       tc->cwnd = clib_min (tc->cwnd, tc->tx_fifo_size);
 980     }
 981 }
 982
 983 always_inline u32
 984 tcp_loss_wnd (const tcp_connection_t * tc)
 985 {
 986   /* Whatever we have in flight + the packet we're about to send */
 987   return tcp_flight_size (tc) + tc->snd_mss;
 988 }
 989
 990 always_inline u32
 991 tcp_available_snd_wnd (const tcp_connection_t * tc)
 992 {
 993   return clib_min (tc->cwnd, tc->snd_wnd);
 994 }
 995
 996 always_inline u32
 997 tcp_available_output_snd_space (const tcp_connection_t * tc)
 998 {
 999   u32 available_wnd = tcp_available_snd_wnd (tc);
1000   int flight_size = (int) (tc->snd_nxt - tc->snd_una);
1001
1002   if (available_wnd <= flight_size)
1003     return 0;
1004
1005   return available_wnd - flight_size;
1006 }
1007
1008 /**
1009  * Estimate of how many bytes we can still push into the network
1010  */
1011 always_inline u32
1012 tcp_available_cc_snd_space (const tcp_connection_t * tc)
1013 {
1014   u32 available_wnd = tcp_available_snd_wnd (tc);
1015   u32 flight_size = tcp_flight_size (tc);
1016
1017   if (available_wnd <= flight_size)
1018     return 0;
1019
1020   return available_wnd - flight_size;
1021 }
1022
1023 always_inline u8
1024 tcp_is_lost_fin (tcp_connection_t * tc)
1025 {
1026   if ((tc->flags & TCP_CONN_FINSNT) && (tc->snd_una_max - tc->snd_una == 1))
1027     return 1;
1028   return 0;
1029 }
1030
1031 u32 tcp_snd_space (tcp_connection_t * tc);
1032 int tcp_fastrecovery_prr_snd_space (tcp_connection_t * tc);
1033
1034 fib_node_index_t tcp_lookup_rmt_in_fib (tcp_connection_t * tc);
1035
1036 /* Made public for unit testing only */
1037 void tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end);
1038 u32 tcp_sack_list_bytes (tcp_connection_t * tc);
1039
1040 always_inline u32
1041 tcp_time_now (void)
1042 {
1043   return tcp_main.wrk_ctx[vlib_get_thread_index ()].time_now;
1044 }
1045
1046 always_inline u32
1047 tcp_time_now_w_thread (u32 thread_index)
1048 {
1049   return tcp_main.wrk_ctx[thread_index].time_now;
1050 }
1051
1052 /**
1053  * Generate timestamp for tcp connection
1054  */
1055 always_inline u32
1056 tcp_tstamp (tcp_connection_t * tc)
1057 {
1058   return (tcp_main.wrk_ctx[tc->c_thread_index].time_now -
1059           tc->timestamp_delta);
1060 }
1061
1062 always_inline f64
1063 tcp_time_now_us (u32 thread_index)
1064 {
1065   return transport_time_now (thread_index);
1066 }
1067
1068 always_inline u32
1069 tcp_set_time_now (tcp_worker_ctx_t * wrk)
1070 {
1071   wrk->time_now = clib_cpu_time_now () * tcp_main.tstamp_ticks_per_clock;
1072   return wrk->time_now;
1073 }
1074
1075 u32 tcp_session_push_header (transport_connection_t * tconn,
1076                              vlib_buffer_t * b);
1077 int tcp_session_custom_tx (void *conn, u32 max_burst_size);
1078
1079 void tcp_connection_timers_init (tcp_connection_t * tc);
1080 void tcp_connection_timers_reset (tcp_connection_t * tc);
1081 void tcp_init_snd_vars (tcp_connection_t * tc);
1082 void tcp_connection_init_vars (tcp_connection_t * tc);
1083 void tcp_connection_tx_pacer_update (tcp_connection_t * tc);
1084 void tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
1085                                     u32 start_bucket);
1086
1087 always_inline void
1088 tcp_cc_rcv_ack (tcp_connection_t * tc, tcp_rate_sample_t * rs)
1089 {
1090   tc->cc_algo->rcv_ack (tc, rs);
1091   tc->tsecr_last_ack = tc->rcv_opts.tsecr;
1092 }
1093
1094 static inline void
1095 tcp_cc_rcv_cong_ack (tcp_connection_t * tc, tcp_cc_ack_t ack_type,
1096                      tcp_rate_sample_t * rs)
1097 {
1098   tc->cc_algo->rcv_cong_ack (tc, ack_type, rs);
1099 }
1100
1101 static inline void
1102 tcp_cc_congestion (tcp_connection_t * tc)
1103 {
1104   tc->cc_algo->congestion (tc);
1105 }
1106
1107 static inline void
1108 tcp_cc_loss (tcp_connection_t * tc)
1109 {
1110   tc->cc_algo->loss (tc);
1111 }
1112
1113 static inline void
1114 tcp_cc_recovered (tcp_connection_t * tc)
1115 {
1116   tc->cc_algo->recovered (tc);
1117 }
1118
1119 static inline void
1120 tcp_cc_undo_recovery (tcp_connection_t * tc)
1121 {
1122   if (tc->cc_algo->undo_recovery)
1123     tc->cc_algo->undo_recovery (tc);
1124 }
1125
1126 static inline void
1127 tcp_cc_event (tcp_connection_t * tc, tcp_cc_event_t evt)
1128 {
1129   if (tc->cc_algo->event)
1130     tc->cc_algo->event (tc, evt);
1131 }
1132
1133 static inline u64
1134 tcp_cc_get_pacing_rate (tcp_connection_t * tc)
1135 {
1136   if (tc->cc_algo->get_pacing_rate)
1137     return tc->cc_algo->get_pacing_rate (tc);
1138
1139   f64 srtt = clib_min ((f64) tc->srtt * TCP_TICK, tc->mrtt_us);
1140
1141   /* TODO should constrain to interface's max throughput but
1142    * we don't have link speeds for sw ifs ..*/
1143   return ((f64) tc->cwnd / srtt);
1144 }
1145
1146 always_inline void
1147 tcp_timer_set (tcp_connection_t * tc, u8 timer_id, u32 interval)
1148 {
1149   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
1150   ASSERT (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID);
1151   tc->timers[timer_id] =
1152     tw_timer_start_16t_2w_512sl (&tcp_main.
1153                                  wrk_ctx[tc->c_thread_index].timer_wheel,
1154                                  tc->c_c_index, timer_id, interval);
1155 }
1156
1157 always_inline void
1158 tcp_timer_reset (tcp_connection_t * tc, u8 timer_id)
1159 {
1160   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
1161   if (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID)
1162     return;
1163
1164   tw_timer_stop_16t_2w_512sl (&tcp_main.
1165                               wrk_ctx[tc->c_thread_index].timer_wheel,
1166                               tc->timers[timer_id]);
1167   tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
1168 }
1169
1170 always_inline void
1171 tcp_timer_update (tcp_connection_t * tc, u8 timer_id, u32 interval)
1172 {
1173   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
1174   if (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID)
1175     tw_timer_update_16t_2w_512sl (&tcp_main.
1176                                   wrk_ctx[tc->c_thread_index].timer_wheel,
1177                                   tc->timers[timer_id], interval);
1178   else
1179     tc->timers[timer_id] =
1180       tw_timer_start_16t_2w_512sl (&tcp_main.
1181                                    wrk_ctx[tc->c_thread_index].timer_wheel,
1182                                    tc->c_c_index, timer_id, interval);
1183 }
1184
1185 always_inline void
1186 tcp_retransmit_timer_set (tcp_connection_t * tc)
1187 {
1188   ASSERT (tc->snd_una != tc->snd_una_max);
1189   tcp_timer_set (tc, TCP_TIMER_RETRANSMIT,
1190                  clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
1191 }
1192
1193 always_inline void
1194 tcp_retransmit_timer_reset (tcp_connection_t * tc)
1195 {
1196   tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT);
1197 }
1198
1199 always_inline void
1200 tcp_retransmit_timer_force_update (tcp_connection_t * tc)
1201 {
1202   tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
1203                     clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
1204 }
1205
1206 always_inline void
1207 tcp_persist_timer_set (tcp_connection_t * tc)
1208 {
1209   /* Reuse RTO. It's backed off in handler */
1210   tcp_timer_set (tc, TCP_TIMER_PERSIST,
1211                  clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
1212 }
1213
1214 always_inline void
1215 tcp_persist_timer_update (tcp_connection_t * tc)
1216 {
1217   u32 interval;
1218
1219   if (seq_leq (tc->snd_una, tc->snd_congestion + tc->burst_acked))
1220     interval = 1;
1221   else
1222     interval = clib_max (tc->rto * TCP_TO_TIMER_TICK, 1);
1223
1224   tcp_timer_update (tc, TCP_TIMER_PERSIST, interval);
1225 }
1226
1227 always_inline void
1228 tcp_persist_timer_reset (tcp_connection_t * tc)
1229 {
1230   tcp_timer_reset (tc, TCP_TIMER_PERSIST);
1231 }
1232
1233 always_inline void
1234 tcp_retransmit_timer_update (tcp_connection_t * tc)
1235 {
1236   if (tc->snd_una == tc->snd_nxt)
1237     {
1238       tcp_retransmit_timer_reset (tc);
1239       if (tc->snd_wnd < tc->snd_mss)
1240         tcp_persist_timer_update (tc);
1241     }
1242   else
1243     tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
1244                       clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
1245 }
1246
1247 always_inline u8
1248 tcp_timer_is_active (tcp_connection_t * tc, tcp_timers_e timer)
1249 {
1250   return tc->timers[timer] != TCP_TIMER_HANDLE_INVALID;
1251 }
1252
1253 #define tcp_validate_txf_size(_tc, _a)                                  \
1254   ASSERT(_tc->state != TCP_STATE_ESTABLISHED                            \
1255          || transport_max_tx_dequeue (&_tc->connection) >= _a)
1256
1257 void tcp_rcv_sacks (tcp_connection_t * tc, u32 ack);
1258 u8 *tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose);
1259
1260 /**
1261  * Register exiting cc algo type
1262  */
1263 void tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
1264                            const tcp_cc_algorithm_t * vft);
1265
1266 /**
1267  * Register new cc algo type
1268  */
1269 tcp_cc_algorithm_type_e tcp_cc_algo_new_type (const tcp_cc_algorithm_t * vft);
1270 tcp_cc_algorithm_t *tcp_cc_algo_get (tcp_cc_algorithm_type_e type);
1271
1272 static inline void *
1273 tcp_cc_data (tcp_connection_t * tc)
1274 {
1275   return (void *) tc->cc_data;
1276 }
1277
1278 void newreno_rcv_cong_ack (tcp_connection_t * tc, tcp_cc_ack_t ack_type,
1279                            tcp_rate_sample_t * rs);
1280
1281 /**
1282  * Push TCP header to buffer
1283  *
1284  * @param vm - vlib_main
1285  * @param b - buffer to write the header to
1286  * @param sp_net - source port net order
1287  * @param dp_net - destination port net order
1288  * @param seq - sequence number net order
1289  * @param ack - ack number net order
1290  * @param tcp_hdr_opts_len - header and options length in bytes
1291  * @param flags - header flags
1292  * @param wnd - window size
1293  *
1294  * @return - pointer to start of TCP header
1295  */
1296 always_inline void *
1297 vlib_buffer_push_tcp_net_order (vlib_buffer_t * b, u16 sp, u16 dp, u32 seq,
1298                                 u32 ack, u8 tcp_hdr_opts_len, u8 flags,
1299                                 u16 wnd)
1300 {
1301   tcp_header_t *th;
1302
1303   th = vlib_buffer_push_uninit (b, tcp_hdr_opts_len);
1304
1305   th->src_port = sp;
1306   th->dst_port = dp;
1307   th->seq_number = seq;
1308   th->ack_number = ack;
1309   th->data_offset_and_reserved = (tcp_hdr_opts_len >> 2) << 4;
1310   th->flags = flags;
1311   th->window = wnd;
1312   th->checksum = 0;
1313   th->urgent_pointer = 0;
1314   vnet_buffer (b)->l4_hdr_offset = (u8 *) th - b->data;
1315   b->flags |= VNET_BUFFER_F_L4_HDR_OFFSET_VALID;
1316   return th;
1317 }
1318
1319 /**
1320  * Push TCP header to buffer
1321  *
1322  * @param b - buffer to write the header to
1323  * @param sp_net - source port net order
1324  * @param dp_net - destination port net order
1325  * @param seq - sequence number host order
1326  * @param ack - ack number host order
1327  * @param tcp_hdr_opts_len - header and options length in bytes
1328  * @param flags - header flags
1329  * @param wnd - window size
1330  *
1331  * @return - pointer to start of TCP header
1332  */
1333 always_inline void *
1334 vlib_buffer_push_tcp (vlib_buffer_t * b, u16 sp_net, u16 dp_net, u32 seq,
1335                       u32 ack, u8 tcp_hdr_opts_len, u8 flags, u16 wnd)
1336 {
1337   return vlib_buffer_push_tcp_net_order (b, sp_net, dp_net,
1338                                          clib_host_to_net_u32 (seq),
1339                                          clib_host_to_net_u32 (ack),
1340                                          tcp_hdr_opts_len, flags,
1341                                          clib_host_to_net_u16 (wnd));
1342 }
1343
1344 #endif /* _vnet_tcp_h_ */
1345
1346 /*
1347  * fd.io coding-style-patch-verification: ON
1348  *
1349  * Local Variables:
1350  * eval: (c-set-style "gnu")
1351  * End:
1352  */