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