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