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