src/vnet/tcp/tcp.h

   1 /*
   2  * Copyright (c) 2016 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
  34 #define TCP_DUPACK_THRESHOLD    3
  35 #define TCP_MAX_RX_FIFO_SIZE    4 << 20
  36 #define TCP_MIN_RX_FIFO_SIZE    4 << 10
  37 #define TCP_IW_N_SEGMENTS       10
  38 #define TCP_ALWAYS_ACK          1       /**< On/off delayed acks */
  39 #define TCP_USE_SACKS           1       /**< Disable only for testing */
  40
  41 /** TCP FSM state definitions as per RFC793. */
  42 #define foreach_tcp_fsm_state   \
  43   _(CLOSED, "CLOSED")           \
  44   _(LISTEN, "LISTEN")           \
  45   _(SYN_SENT, "SYN_SENT")       \
  46   _(SYN_RCVD, "SYN_RCVD")       \
  47   _(ESTABLISHED, "ESTABLISHED") \
  48   _(CLOSE_WAIT, "CLOSE_WAIT")   \
  49   _(FIN_WAIT_1, "FIN_WAIT_1")   \
  50   _(LAST_ACK, "LAST_ACK")       \
  51   _(CLOSING, "CLOSING")         \
  52   _(FIN_WAIT_2, "FIN_WAIT_2")   \
  53   _(TIME_WAIT, "TIME_WAIT")
  54
  55 typedef enum _tcp_state
  56 {
  57 #define _(sym, str) TCP_STATE_##sym,
  58   foreach_tcp_fsm_state
  59 #undef _
  60   TCP_N_STATES
  61 } tcp_state_t;
  62
  63 format_function_t format_tcp_state;
  64 format_function_t format_tcp_flags;
  65 format_function_t format_tcp_sacks;
  66 format_function_t format_tcp_rcv_sacks;
  67
  68 /** TCP timers */
  69 #define foreach_tcp_timer               \
  70   _(RETRANSMIT, "RETRANSMIT")           \
  71   _(DELACK, "DELAYED ACK")              \
  72   _(PERSIST, "PERSIST")                 \
  73   _(KEEP, "KEEP")                       \
  74   _(WAITCLOSE, "WAIT CLOSE")            \
  75   _(RETRANSMIT_SYN, "RETRANSMIT SYN")   \
  76   _(ESTABLISH, "ESTABLISH")
  77
  78 typedef enum _tcp_timers
  79 {
  80 #define _(sym, str) TCP_TIMER_##sym,
  81   foreach_tcp_timer
  82 #undef _
  83   TCP_N_TIMERS
  84 } tcp_timers_e;
  85
  86 typedef void (timer_expiration_handler) (u32 index);
  87
  88 extern timer_expiration_handler tcp_timer_delack_handler;
  89 extern timer_expiration_handler tcp_timer_retransmit_handler;
  90 extern timer_expiration_handler tcp_timer_persist_handler;
  91 extern timer_expiration_handler tcp_timer_retransmit_syn_handler;
  92
  93 #define TCP_TIMER_HANDLE_INVALID ((u32) ~0)
  94
  95 /* Timer delays as multiples of 100ms */
  96 #define TCP_TO_TIMER_TICK       TCP_TICK*10     /* Period for converting from TCP
  97                                                  * ticks to timer units */
  98 #define TCP_DELACK_TIME         1       /* 0.1s */
  99 #define TCP_ESTABLISH_TIME      750     /* 75s */
 100 #define TCP_2MSL_TIME           300     /* 30s */
 101 #define TCP_CLOSEWAIT_TIME      20      /* 0.1s */
 102 #define TCP_CLEANUP_TIME        5       /* 0.5s Time to wait before cleanup */
 103 #define TCP_TIMER_PERSIST_MIN   2       /* 0.2s */
 104
 105 #define TCP_RTO_MAX 60 * THZ    /* Min max RTO (60s) as per RFC6298 */
 106 #define TCP_RTO_MIN 0.2 * THZ   /* Min RTO (200ms) - lower than standard */
 107 #define TCP_RTT_MAX 30 * THZ    /* 30s (probably too much) */
 108 #define TCP_RTO_SYN_RETRIES 3   /* SYN retries without doubling RTO */
 109 #define TCP_RTO_INIT 1 * THZ    /* Initial retransmit timer */
 110
 111 /** TCP connection flags */
 112 #define foreach_tcp_connection_flag             \
 113   _(SNDACK, "Send ACK")                         \
 114   _(FINSNT, "FIN sent")                         \
 115   _(SENT_RCV_WND0, "Sent 0 receive window")     \
 116   _(RECOVERY, "Recovery on")                    \
 117   _(FAST_RECOVERY, "Fast Recovery on")          \
 118   _(FR_1_SMSS, "Sent 1 SMSS")                   \
 119   _(HALF_OPEN_DONE, "Half-open completed")
 120
 121 typedef enum _tcp_connection_flag_bits
 122 {
 123 #define _(sym, str) TCP_CONN_##sym##_BIT,
 124   foreach_tcp_connection_flag
 125 #undef _
 126   TCP_CONN_N_FLAG_BITS
 127 } tcp_connection_flag_bits_e;
 128
 129 typedef enum _tcp_connection_flag
 130 {
 131 #define _(sym, str) TCP_CONN_##sym = 1 << TCP_CONN_##sym##_BIT,
 132   foreach_tcp_connection_flag
 133 #undef _
 134   TCP_CONN_N_FLAGS
 135 } tcp_connection_flags_e;
 136
 137 /** TCP buffer flags */
 138 #define foreach_tcp_buf_flag                            \
 139   _ (ACK)       /**< Sending ACK. */                    \
 140   _ (DUPACK)    /**< Sending DUPACK. */                 \
 141
 142 enum
 143 {
 144 #define _(f) TCP_BUF_BIT_##f,
 145   foreach_tcp_buf_flag
 146 #undef _
 147     TCP_N_BUF_BITS,
 148 };
 149
 150 enum
 151 {
 152 #define _(f) TCP_BUF_FLAG_##f = 1 << TCP_BUF_BIT_##f,
 153   foreach_tcp_buf_flag
 154 #undef _
 155 };
 156
 157 #define TCP_SCOREBOARD_TRACE (0)
 158 #define TCP_MAX_SACK_BLOCKS 15  /**< Max number of SACK blocks stored */
 159 #define TCP_INVALID_SACK_HOLE_INDEX ((u32)~0)
 160
 161 typedef struct _scoreboard_trace_elt
 162 {
 163   u32 start;
 164   u32 end;
 165   u32 ack;
 166   u32 snd_una_max;
 167   u32 group;
 168 } scoreboard_trace_elt_t;
 169
 170 typedef struct _sack_scoreboard_hole
 171 {
 172   u32 next;             /**< Index for next entry in linked list */
 173   u32 prev;             /**< Index for previous entry in linked list */
 174   u32 start;            /**< Start sequence number */
 175   u32 end;              /**< End sequence number */
 176   u8 is_lost;           /**< Mark hole as lost */
 177 } sack_scoreboard_hole_t;
 178
 179 typedef struct _sack_scoreboard
 180 {
 181   sack_scoreboard_hole_t *holes;        /**< Pool of holes */
 182   u32 head;                             /**< Index of first entry */
 183   u32 tail;                             /**< Index of last entry */
 184   u32 sacked_bytes;                     /**< Number of bytes sacked in sb */
 185   u32 last_sacked_bytes;                /**< Number of bytes last sacked */
 186   u32 last_bytes_delivered;             /**< Number of sack bytes delivered */
 187   u32 snd_una_adv;                      /**< Bytes to add to snd_una */
 188   u32 high_sacked;                      /**< Highest byte sacked (fack) */
 189   u32 high_rxt;                         /**< Highest retransmitted sequence */
 190   u32 rescue_rxt;                       /**< Rescue sequence number */
 191   u32 lost_bytes;                       /**< Bytes lost as per RFC6675 */
 192   u32 cur_rxt_hole;                     /**< Retransmitting from this hole */
 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 typedef enum _tcp_cc_algorithm_type
 226 {
 227   TCP_CC_NEWRENO,
 228 } tcp_cc_algorithm_type_e;
 229
 230 typedef struct _tcp_cc_algorithm tcp_cc_algorithm_t;
 231
 232 typedef enum _tcp_cc_ack_t
 233 {
 234   TCP_CC_ACK,
 235   TCP_CC_DUPACK,
 236   TCP_CC_PARTIALACK
 237 } tcp_cc_ack_t;
 238
 239 typedef struct _tcp_connection
 240 {
 241   transport_connection_t connection;  /**< Common transport data. First! */
 242
 243   u8 state;                     /**< TCP state as per tcp_state_t */
 244   u16 flags;                    /**< Connection flags (see tcp_conn_flags_e) */
 245   u32 timers[TCP_N_TIMERS];     /**< Timer handles into timer wheel */
 246
 247   /* TODO RFC4898 */
 248
 249   /** Send sequence variables RFC793 */
 250   u32 snd_una;          /**< oldest unacknowledged sequence number */
 251   u32 snd_una_max;      /**< newest unacknowledged sequence number + 1*/
 252   u32 snd_wnd;          /**< send window */
 253   u32 snd_wl1;          /**< seq number used for last snd.wnd update */
 254   u32 snd_wl2;          /**< ack number used for last snd.wnd update */
 255   u32 snd_nxt;          /**< next seq number to be sent */
 256   u16 snd_mss;          /**< Effective send max seg (data) size */
 257
 258   /** Receive sequence variables RFC793 */
 259   u32 rcv_nxt;          /**< next sequence number expected */
 260   u32 rcv_wnd;          /**< receive window we expect */
 261
 262   u32 rcv_las;          /**< rcv_nxt at last ack sent/rcv_wnd update */
 263   u32 iss;              /**< initial sent sequence */
 264   u32 irs;              /**< initial remote sequence */
 265
 266   /* Options */
 267   tcp_options_t rcv_opts;       /**< Rx options for connection */
 268   tcp_options_t snd_opts;       /**< Tx options for connection */
 269   u8 snd_opts_len;              /**< Tx options len */
 270   u8 rcv_wscale;        /**< Window scale to advertise to peer */
 271   u8 snd_wscale;        /**< Window scale to use when sending */
 272   u32 tsval_recent;     /**< Last timestamp received */
 273   u32 tsval_recent_age; /**< When last updated tstamp_recent*/
 274
 275   sack_block_t *snd_sacks;      /**< Vector of SACKs to send. XXX Fixed size? */
 276   sack_scoreboard_t sack_sb;    /**< SACK "scoreboard" that tracks holes */
 277
 278   u16 rcv_dupacks;      /**< Number of DUPACKs received */
 279   u8 snt_dupacks;       /**< Number of DUPACKs sent in a burst */
 280
 281   /* Congestion control */
 282   u32 cwnd;             /**< Congestion window */
 283   u32 ssthresh;         /**< Slow-start threshold */
 284   u32 prev_ssthresh;    /**< ssthresh before congestion */
 285   u32 prev_cwnd;        /**< ssthresh before congestion */
 286   u32 bytes_acked;      /**< Bytes acknowledged by current segment */
 287   u32 snd_rxt_bytes;    /**< Retransmitted bytes */
 288   u32 snd_rxt_ts;       /**< Timestamp when first packet is retransmitted */
 289   u32 tsecr_last_ack;   /**< Timestamp echoed to us in last healthy ACK */
 290   u32 snd_congestion;   /**< snd_una_max when congestion is detected */
 291   tcp_cc_algorithm_t *cc_algo;  /**< Congestion control algorithm */
 292
 293   /* RTT and RTO */
 294   u32 rto;              /**< Retransmission timeout */
 295   u32 rto_boff;         /**< Index for RTO backoff */
 296   u32 srtt;             /**< Smoothed RTT */
 297   u32 rttvar;           /**< Smoothed mean RTT difference. Approximates variance */
 298   u32 rtt_ts;           /**< Timestamp for tracked ACK */
 299   u32 rtt_seq;          /**< Sequence number for tracked ACK */
 300
 301   u16 mss;              /**< Our max seg size that includes options */
 302   u32 limited_transmit; /**< snd_nxt when limited transmit starts */
 303   u32 last_fib_check;   /**< Last time we checked fib route for peer */
 304 } tcp_connection_t;
 305
 306 struct _tcp_cc_algorithm
 307 {
 308   void (*rcv_ack) (tcp_connection_t * tc);
 309   void (*rcv_cong_ack) (tcp_connection_t * tc, tcp_cc_ack_t ack);
 310   void (*congestion) (tcp_connection_t * tc);
 311   void (*recovered) (tcp_connection_t * tc);
 312   void (*init) (tcp_connection_t * tc);
 313 };
 314
 315 #define tcp_fastrecovery_on(tc) (tc)->flags |= TCP_CONN_FAST_RECOVERY
 316 #define tcp_fastrecovery_off(tc) (tc)->flags &= ~TCP_CONN_FAST_RECOVERY
 317 #define tcp_recovery_on(tc) (tc)->flags |= TCP_CONN_RECOVERY
 318 #define tcp_recovery_off(tc) (tc)->flags &= ~TCP_CONN_RECOVERY
 319 #define tcp_in_fastrecovery(tc) ((tc)->flags & TCP_CONN_FAST_RECOVERY)
 320 #define tcp_in_recovery(tc) ((tc)->flags & (TCP_CONN_RECOVERY))
 321 #define tcp_in_slowstart(tc) (tc->cwnd < tc->ssthresh)
 322 #define tcp_fastrecovery_sent_1_smss(tc) ((tc)->flags & TCP_CONN_FR_1_SMSS)
 323 #define tcp_fastrecovery_1_smss_on(tc) ((tc)->flags |= TCP_CONN_FR_1_SMSS)
 324 #define tcp_fastrecovery_1_smss_off(tc) ((tc)->flags &= ~TCP_CONN_FR_1_SMSS)
 325
 326 #define tcp_in_cong_recovery(tc) ((tc)->flags &                 \
 327           (TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
 328
 329 always_inline void
 330 tcp_cong_recovery_off (tcp_connection_t * tc)
 331 {
 332   tc->flags &= ~(TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY);
 333   tcp_fastrecovery_1_smss_off (tc);
 334 }
 335
 336 typedef enum
 337 {
 338   TCP_IP4,
 339   TCP_IP6,
 340   TCP_N_AF,
 341 } tcp_af_t;
 342
 343 typedef enum _tcp_error
 344 {
 345 #define tcp_error(n,s) TCP_ERROR_##n,
 346 #include <vnet/tcp/tcp_error.def>
 347 #undef tcp_error
 348   TCP_N_ERROR,
 349 } tcp_error_t;
 350
 351 typedef struct _tcp_lookup_dispatch
 352 {
 353   u8 next, error;
 354 } tcp_lookup_dispatch_t;
 355
 356 typedef struct _tcp_main
 357 {
 358   /* Per-worker thread tcp connection pools */
 359   tcp_connection_t **connections;
 360
 361   /* Pool of listeners. */
 362   tcp_connection_t *listener_pool;
 363
 364   /** Dispatch table by state and flags */
 365   tcp_lookup_dispatch_t dispatch_table[TCP_N_STATES][64];
 366
 367   u8 log2_tstamp_clocks_per_tick;
 368   f64 tstamp_ticks_per_clock;
 369
 370   /** per-worker tx buffer free lists */
 371   u32 **tx_buffers;
 372   /** per-worker tx frames to 4/6 output nodes */
 373   vlib_frame_t **tx_frames[2];
 374
 375   /* Per worker-thread timer wheel for connections timers */
 376   tw_timer_wheel_16t_2w_512sl_t *timer_wheels;
 377
 378   /* Pool of half-open connections on which we've sent a SYN */
 379   tcp_connection_t *half_open_connections;
 380   clib_spinlock_t half_open_lock;
 381
 382   /* Pool of local TCP endpoints */
 383   transport_endpoint_t *local_endpoints;
 384
 385   /* Local endpoints lookup table */
 386   transport_endpoint_table_t local_endpoints_table;
 387   clib_spinlock_t local_endpoints_lock;
 388
 389   /* Congestion control algorithms registered */
 390   tcp_cc_algorithm_t *cc_algos;
 391
 392   /* Flag that indicates if stack is on or off */
 393   u8 is_enabled;
 394
 395   /** Number of preallocated connections */
 396   u32 preallocated_connections;
 397   u32 preallocated_half_open_connections;
 398
 399   /** Vectors of src addresses. Optional unless one needs > 63K active-opens */
 400   ip4_address_t *ip4_src_addresses;
 401   u32 last_v4_address_rotor;
 402   u32 last_v6_address_rotor;
 403   ip6_address_t *ip6_src_addresses;
 404
 405   /** Port allocator random number generator seed */
 406   u32 port_allocator_seed;
 407 } tcp_main_t;
 408
 409 extern tcp_main_t tcp_main;
 410 extern vlib_node_registration_t tcp4_input_node;
 411 extern vlib_node_registration_t tcp6_input_node;
 412 extern vlib_node_registration_t tcp4_output_node;
 413 extern vlib_node_registration_t tcp6_output_node;
 414
 415 always_inline tcp_main_t *
 416 vnet_get_tcp_main ()
 417 {
 418   return &tcp_main;
 419 }
 420
 421 always_inline tcp_header_t *
 422 tcp_buffer_hdr (vlib_buffer_t * b)
 423 {
 424   ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
 425   return (tcp_header_t *) (b->data + b->current_data
 426                            + vnet_buffer (b)->tcp.hdr_offset);
 427 }
 428
 429 clib_error_t *vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en);
 430
 431 always_inline tcp_connection_t *
 432 tcp_connection_get (u32 conn_index, u32 thread_index)
 433 {
 434   if (PREDICT_FALSE
 435       (pool_is_free_index (tcp_main.connections[thread_index], conn_index)))
 436     return 0;
 437   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 438 }
 439
 440 always_inline tcp_connection_t *
 441 tcp_connection_get_if_valid (u32 conn_index, u32 thread_index)
 442 {
 443   if (tcp_main.connections[thread_index] == 0)
 444     return 0;
 445   if (pool_is_free_index (tcp_main.connections[thread_index], conn_index))
 446     return 0;
 447   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 448 }
 449
 450 always_inline tcp_connection_t *
 451 tcp_get_connection_from_transport (transport_connection_t * tconn)
 452 {
 453   return (tcp_connection_t *) tconn;
 454 }
 455
 456 void tcp_connection_close (tcp_connection_t * tc);
 457 void tcp_connection_cleanup (tcp_connection_t * tc);
 458 void tcp_connection_del (tcp_connection_t * tc);
 459 int tcp_half_open_connection_cleanup (tcp_connection_t * tc);
 460 tcp_connection_t *tcp_connection_new (u8 thread_index);
 461 void tcp_connection_reset (tcp_connection_t * tc);
 462
 463 u8 *format_tcp_connection_id (u8 * s, va_list * args);
 464 u8 *format_tcp_connection (u8 * s, va_list * args);
 465 u8 *format_tcp_scoreboard (u8 * s, va_list * args);
 466
 467 u8 *tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose);
 468
 469 always_inline tcp_connection_t *
 470 tcp_listener_get (u32 tli)
 471 {
 472   return pool_elt_at_index (tcp_main.listener_pool, tli);
 473 }
 474
 475 always_inline tcp_connection_t *
 476 tcp_half_open_connection_get (u32 conn_index)
 477 {
 478   tcp_connection_t *tc = 0;
 479   clib_spinlock_lock_if_init (&tcp_main.half_open_lock);
 480   if (!pool_is_free_index (tcp_main.half_open_connections, conn_index))
 481     tc = pool_elt_at_index (tcp_main.half_open_connections, conn_index);
 482   clib_spinlock_unlock_if_init (&tcp_main.half_open_lock);
 483   return tc;
 484 }
 485
 486 void tcp_make_ack (tcp_connection_t * ts, vlib_buffer_t * b);
 487 void tcp_make_fin (tcp_connection_t * tc, vlib_buffer_t * b);
 488 void tcp_make_synack (tcp_connection_t * ts, vlib_buffer_t * b);
 489 void tcp_send_reset (tcp_connection_t * tc, vlib_buffer_t * pkt, u8 is_ip4);
 490 void tcp_send_syn (tcp_connection_t * tc);
 491 void tcp_send_fin (tcp_connection_t * tc);
 492 void tcp_init_mss (tcp_connection_t * tc);
 493 void tcp_update_snd_mss (tcp_connection_t * tc);
 494 void tcp_update_rto (tcp_connection_t * tc);
 495 void tcp_flush_frame_to_output (vlib_main_t * vm, u8 thread_index, u8 is_ip4);
 496 void tcp_flush_frames_to_output (u8 thread_index);
 497
 498 always_inline u32
 499 tcp_end_seq (tcp_header_t * th, u32 len)
 500 {
 501   return th->seq_number + tcp_is_syn (th) + tcp_is_fin (th) + len;
 502 }
 503
 504 /* Modulo arithmetic for TCP sequence numbers */
 505 #define seq_lt(_s1, _s2) ((i32)((_s1)-(_s2)) < 0)
 506 #define seq_leq(_s1, _s2) ((i32)((_s1)-(_s2)) <= 0)
 507 #define seq_gt(_s1, _s2) ((i32)((_s1)-(_s2)) > 0)
 508 #define seq_geq(_s1, _s2) ((i32)((_s1)-(_s2)) >= 0)
 509 #define seq_max(_s1, _s2) (seq_gt((_s1), (_s2)) ? (_s1) : (_s2))
 510
 511 /* Modulo arithmetic for timestamps */
 512 #define timestamp_lt(_t1, _t2) ((i32)((_t1)-(_t2)) < 0)
 513 #define timestamp_leq(_t1, _t2) ((i32)((_t1)-(_t2)) <= 0)
 514
 515 /**
 516  * Our estimate of the number of bytes that have left the network
 517  */
 518 always_inline u32
 519 tcp_bytes_out (const tcp_connection_t * tc)
 520 {
 521   if (tcp_opts_sack_permitted (&tc->rcv_opts))
 522     return tc->sack_sb.sacked_bytes + tc->sack_sb.lost_bytes;
 523   else
 524     return tc->rcv_dupacks * tc->snd_mss;
 525 }
 526
 527 /**
 528  * Our estimate of the number of bytes in flight (pipe size)
 529  */
 530 always_inline u32
 531 tcp_flight_size (const tcp_connection_t * tc)
 532 {
 533   int flight_size;
 534
 535   flight_size = (int) (tc->snd_una_max - tc->snd_una) - tcp_bytes_out (tc)
 536     + tc->snd_rxt_bytes;
 537
 538   if (flight_size < 0)
 539     {
 540       if (0)
 541         clib_warning
 542           ("Negative: %u %u %u dupacks %u sacked bytes %u flags %d",
 543            tc->snd_una_max - tc->snd_una, tcp_bytes_out (tc),
 544            tc->snd_rxt_bytes, tc->rcv_dupacks, tc->sack_sb.sacked_bytes,
 545            tc->rcv_opts.flags);
 546       return 0;
 547     }
 548
 549   return flight_size;
 550 }
 551
 552 /**
 553  * Initial cwnd as per RFC5681
 554  */
 555 always_inline u32
 556 tcp_initial_cwnd (const tcp_connection_t * tc)
 557 {
 558   if (tc->snd_mss > 2190)
 559     return 2 * tc->snd_mss;
 560   else if (tc->snd_mss > 1095)
 561     return 3 * tc->snd_mss;
 562   else
 563     return 4 * tc->snd_mss;
 564 }
 565
 566 always_inline u32
 567 tcp_loss_wnd (const tcp_connection_t * tc)
 568 {
 569   return tc->snd_mss;
 570 }
 571
 572 always_inline u32
 573 tcp_available_wnd (const tcp_connection_t * tc)
 574 {
 575   return clib_min (tc->cwnd, tc->snd_wnd);
 576 }
 577
 578 always_inline u32
 579 tcp_available_snd_space (const tcp_connection_t * tc)
 580 {
 581   u32 available_wnd = tcp_available_wnd (tc);
 582   u32 flight_size = tcp_flight_size (tc);
 583
 584   if (available_wnd <= flight_size)
 585     return 0;
 586
 587   return available_wnd - flight_size;
 588 }
 589
 590 i32 tcp_rcv_wnd_available (tcp_connection_t * tc);
 591 u32 tcp_snd_space (tcp_connection_t * tc);
 592 void tcp_update_rcv_wnd (tcp_connection_t * tc);
 593
 594 void tcp_retransmit_first_unacked (tcp_connection_t * tc);
 595 void tcp_fast_retransmit_no_sack (tcp_connection_t * tc);
 596 void tcp_fast_retransmit_sack (tcp_connection_t * tc);
 597 void tcp_fast_retransmit (tcp_connection_t * tc);
 598 void tcp_cc_init_congestion (tcp_connection_t * tc);
 599 int tcp_cc_recover (tcp_connection_t * tc);
 600 void tcp_cc_fastrecovery_exit (tcp_connection_t * tc);
 601
 602 fib_node_index_t tcp_lookup_rmt_in_fib (tcp_connection_t * tc);
 603
 604 /* Made public for unit testing only */
 605 void tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end);
 606
 607 always_inline u32
 608 tcp_time_now (void)
 609 {
 610   return clib_cpu_time_now () * tcp_main.tstamp_ticks_per_clock;
 611 }
 612
 613 always_inline void
 614 tcp_update_time (f64 now, u32 thread_index)
 615 {
 616   tw_timer_expire_timers_16t_2w_512sl (&tcp_main.timer_wheels[thread_index],
 617                                        now);
 618   tcp_flush_frames_to_output (thread_index);
 619 }
 620
 621 u32 tcp_push_header (transport_connection_t * tconn, vlib_buffer_t * b);
 622
 623 u32
 624 tcp_prepare_retransmit_segment (tcp_connection_t * tc, vlib_buffer_t * b,
 625                                 u32 offset, u32 max_bytes);
 626
 627 void tcp_connection_timers_init (tcp_connection_t * tc);
 628 void tcp_connection_timers_reset (tcp_connection_t * tc);
 629 void tcp_connection_init_vars (tcp_connection_t * tc);
 630
 631 always_inline void
 632 tcp_connection_force_ack (tcp_connection_t * tc, vlib_buffer_t * b)
 633 {
 634   /* Reset flags, make sure ack is sent */
 635   tc->flags = TCP_CONN_SNDACK;
 636   vnet_buffer (b)->tcp.flags &= ~TCP_BUF_FLAG_DUPACK;
 637 }
 638
 639 always_inline void
 640 tcp_timer_set (tcp_connection_t * tc, u8 timer_id, u32 interval)
 641 {
 642   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
 643   tc->timers[timer_id]
 644     = tw_timer_start_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
 645                                    tc->c_c_index, timer_id, interval);
 646 }
 647
 648 always_inline void
 649 tcp_timer_reset (tcp_connection_t * tc, u8 timer_id)
 650 {
 651   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
 652   if (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID)
 653     return;
 654
 655   tw_timer_stop_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
 656                               tc->timers[timer_id]);
 657   tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
 658 }
 659
 660 always_inline void
 661 tcp_timer_update (tcp_connection_t * tc, u8 timer_id, u32 interval)
 662 {
 663   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
 664   if (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID)
 665     tw_timer_stop_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
 666                                 tc->timers[timer_id]);
 667   tc->timers[timer_id] =
 668     tw_timer_start_16t_2w_512sl (&tcp_main.timer_wheels[tc->c_thread_index],
 669                                  tc->c_c_index, timer_id, interval);
 670 }
 671
 672 always_inline void
 673 tcp_retransmit_timer_set (tcp_connection_t * tc)
 674 {
 675   tcp_timer_set (tc, TCP_TIMER_RETRANSMIT,
 676                  clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 677 }
 678
 679 always_inline void
 680 tcp_retransmit_timer_reset (tcp_connection_t * tc)
 681 {
 682   tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT);
 683 }
 684
 685 always_inline void
 686 tcp_retransmit_timer_force_update (tcp_connection_t * tc)
 687 {
 688   tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
 689                     clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 690 }
 691
 692 always_inline void
 693 tcp_persist_timer_set (tcp_connection_t * tc)
 694 {
 695   /* Reuse RTO. It's backed off in handler */
 696   tcp_timer_set (tc, TCP_TIMER_PERSIST,
 697                  clib_max (tc->rto * TCP_TO_TIMER_TICK,
 698                            TCP_TIMER_PERSIST_MIN));
 699 }
 700
 701 always_inline void
 702 tcp_persist_timer_update (tcp_connection_t * tc)
 703 {
 704   tcp_timer_update (tc, TCP_TIMER_PERSIST,
 705                     clib_max (tc->rto * TCP_TO_TIMER_TICK,
 706                               TCP_TIMER_PERSIST_MIN));
 707 }
 708
 709 always_inline void
 710 tcp_persist_timer_reset (tcp_connection_t * tc)
 711 {
 712   tcp_timer_reset (tc, TCP_TIMER_PERSIST);
 713 }
 714
 715 always_inline void
 716 tcp_retransmit_timer_update (tcp_connection_t * tc)
 717 {
 718   if (tc->snd_una == tc->snd_una_max)
 719     {
 720       tcp_retransmit_timer_reset (tc);
 721       if (tc->snd_wnd < tc->snd_mss)
 722         tcp_persist_timer_set (tc);
 723     }
 724   else
 725     tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
 726                       clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 727 }
 728
 729 always_inline u8
 730 tcp_timer_is_active (tcp_connection_t * tc, tcp_timers_e timer)
 731 {
 732   return tc->timers[timer] != TCP_TIMER_HANDLE_INVALID;
 733 }
 734
 735 #define tcp_validate_txf_size(_tc, _a)                                  \
 736   ASSERT(_tc->state != TCP_STATE_ESTABLISHED                            \
 737          || stream_session_tx_fifo_max_dequeue (&_tc->connection) >= _a)
 738
 739 void
 740 scoreboard_remove_hole (sack_scoreboard_t * sb,
 741                         sack_scoreboard_hole_t * hole);
 742 void scoreboard_update_lost (tcp_connection_t * tc, sack_scoreboard_t * sb);
 743 sack_scoreboard_hole_t *scoreboard_insert_hole (sack_scoreboard_t * sb,
 744                                                 u32 prev_index, u32 start,
 745                                                 u32 end);
 746 sack_scoreboard_hole_t *scoreboard_next_rxt_hole (sack_scoreboard_t * sb,
 747                                                   sack_scoreboard_hole_t *
 748                                                   start, u8 have_sent_1_smss,
 749                                                   u8 * can_rescue,
 750                                                   u8 * snd_limited);
 751 void scoreboard_init_high_rxt (sack_scoreboard_t * sb, u32 seq);
 752
 753 always_inline sack_scoreboard_hole_t *
 754 scoreboard_get_hole (sack_scoreboard_t * sb, u32 index)
 755 {
 756   if (index != TCP_INVALID_SACK_HOLE_INDEX)
 757     return pool_elt_at_index (sb->holes, index);
 758   return 0;
 759 }
 760
 761 always_inline sack_scoreboard_hole_t *
 762 scoreboard_next_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
 763 {
 764   if (hole->next != TCP_INVALID_SACK_HOLE_INDEX)
 765     return pool_elt_at_index (sb->holes, hole->next);
 766   return 0;
 767 }
 768
 769 always_inline sack_scoreboard_hole_t *
 770 scoreboard_prev_hole (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
 771 {
 772   if (hole->prev != TCP_INVALID_SACK_HOLE_INDEX)
 773     return pool_elt_at_index (sb->holes, hole->prev);
 774   return 0;
 775 }
 776
 777 always_inline sack_scoreboard_hole_t *
 778 scoreboard_first_hole (sack_scoreboard_t * sb)
 779 {
 780   if (sb->head != TCP_INVALID_SACK_HOLE_INDEX)
 781     return pool_elt_at_index (sb->holes, sb->head);
 782   return 0;
 783 }
 784
 785 always_inline sack_scoreboard_hole_t *
 786 scoreboard_last_hole (sack_scoreboard_t * sb)
 787 {
 788   if (sb->tail != TCP_INVALID_SACK_HOLE_INDEX)
 789     return pool_elt_at_index (sb->holes, sb->tail);
 790   return 0;
 791 }
 792
 793 always_inline void
 794 scoreboard_clear (sack_scoreboard_t * sb)
 795 {
 796   sack_scoreboard_hole_t *hole;
 797   while ((hole = scoreboard_first_hole (sb)))
 798     {
 799       scoreboard_remove_hole (sb, hole);
 800     }
 801   ASSERT (sb->head == sb->tail && sb->head == TCP_INVALID_SACK_HOLE_INDEX);
 802   ASSERT (pool_elts (sb->holes) == 0);
 803   sb->sacked_bytes = 0;
 804   sb->last_sacked_bytes = 0;
 805   sb->last_bytes_delivered = 0;
 806   sb->snd_una_adv = 0;
 807   sb->high_sacked = 0;
 808   sb->high_rxt = 0;
 809   sb->lost_bytes = 0;
 810   sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
 811 }
 812
 813 always_inline u32
 814 scoreboard_hole_bytes (sack_scoreboard_hole_t * hole)
 815 {
 816   return hole->end - hole->start;
 817 }
 818
 819 always_inline u32
 820 scoreboard_hole_index (sack_scoreboard_t * sb, sack_scoreboard_hole_t * hole)
 821 {
 822   ASSERT (!pool_is_free_index (sb->holes, hole - sb->holes));
 823   return hole - sb->holes;
 824 }
 825
 826 always_inline void
 827 scoreboard_init (sack_scoreboard_t * sb)
 828 {
 829   sb->head = TCP_INVALID_SACK_HOLE_INDEX;
 830   sb->tail = TCP_INVALID_SACK_HOLE_INDEX;
 831   sb->cur_rxt_hole = TCP_INVALID_SACK_HOLE_INDEX;
 832 }
 833
 834 void tcp_rcv_sacks (tcp_connection_t * tc, u32 ack);
 835
 836 always_inline void
 837 tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
 838                       const tcp_cc_algorithm_t * vft)
 839 {
 840   tcp_main_t *tm = vnet_get_tcp_main ();
 841   vec_validate (tm->cc_algos, type);
 842
 843   tm->cc_algos[type] = *vft;
 844 }
 845
 846 always_inline tcp_cc_algorithm_t *
 847 tcp_cc_algo_get (tcp_cc_algorithm_type_e type)
 848 {
 849   tcp_main_t *tm = vnet_get_tcp_main ();
 850   return &tm->cc_algos[type];
 851 }
 852
 853 void tcp_cc_init (tcp_connection_t * tc);
 854
 855 /**
 856  * Push TCP header to buffer
 857  *
 858  * @param vm - vlib_main
 859  * @param b - buffer to write the header to
 860  * @param sp_net - source port net order
 861  * @param dp_net - destination port net order
 862  * @param seq - sequence number net order
 863  * @param ack - ack number net order
 864  * @param tcp_hdr_opts_len - header and options length in bytes
 865  * @param flags - header flags
 866  * @param wnd - window size
 867  *
 868  * @return - pointer to start of TCP header
 869  */
 870 always_inline void *
 871 vlib_buffer_push_tcp_net_order (vlib_buffer_t * b, u16 sp, u16 dp, u32 seq,
 872                                 u32 ack, u8 tcp_hdr_opts_len, u8 flags,
 873                                 u16 wnd)
 874 {
 875   tcp_header_t *th;
 876
 877   th = vlib_buffer_push_uninit (b, tcp_hdr_opts_len);
 878
 879   th->src_port = sp;
 880   th->dst_port = dp;
 881   th->seq_number = seq;
 882   th->ack_number = ack;
 883   th->data_offset_and_reserved = (tcp_hdr_opts_len >> 2) << 4;
 884   th->flags = flags;
 885   th->window = wnd;
 886   th->checksum = 0;
 887   th->urgent_pointer = 0;
 888   return th;
 889 }
 890
 891 /**
 892  * Push TCP header to buffer
 893  *
 894  * @param b - buffer to write the header to
 895  * @param sp_net - source port net order
 896  * @param dp_net - destination port net order
 897  * @param seq - sequence number host order
 898  * @param ack - ack number host order
 899  * @param tcp_hdr_opts_len - header and options length in bytes
 900  * @param flags - header flags
 901  * @param wnd - window size
 902  *
 903  * @return - pointer to start of TCP header
 904  */
 905 always_inline void *
 906 vlib_buffer_push_tcp (vlib_buffer_t * b, u16 sp_net, u16 dp_net, u32 seq,
 907                       u32 ack, u8 tcp_hdr_opts_len, u8 flags, u16 wnd)
 908 {
 909   return vlib_buffer_push_tcp_net_order (b, sp_net, dp_net,
 910                                          clib_host_to_net_u32 (seq),
 911                                          clib_host_to_net_u32 (ack),
 912                                          tcp_hdr_opts_len, flags,
 913                                          clib_host_to_net_u16 (wnd));
 914 }
 915
 916 #endif /* _vnet_tcp_h_ */
 917
 918 /*
 919  * fd.io coding-style-patch-verification: ON
 920  *
 921  * Local Variables:
 922  * eval: (c-set-style "gnu")
 923  * End:
 924  */