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