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