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