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    32 << 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 sack_scoreboard_hole_t *scoreboard_next_rxt_hole (sack_scoreboard_t * sb,
 229                                                   sack_scoreboard_hole_t *
 230                                                   start, u8 have_sent_1_smss,
 231                                                   u8 * can_rescue,
 232                                                   u8 * snd_limited);
 233 sack_scoreboard_hole_t *scoreboard_get_hole (sack_scoreboard_t * sb,
 234                                              u32 index);
 235
 236 sack_scoreboard_hole_t *scoreboard_next_hole (sack_scoreboard_t * sb,
 237                                               sack_scoreboard_hole_t * hole);
 238 sack_scoreboard_hole_t *scoreboard_prev_hole (sack_scoreboard_t * sb,
 239                                               sack_scoreboard_hole_t * hole);
 240 sack_scoreboard_hole_t *scoreboard_first_hole (sack_scoreboard_t * sb);
 241 sack_scoreboard_hole_t *scoreboard_last_hole (sack_scoreboard_t * sb);
 242 void scoreboard_clear (sack_scoreboard_t * sb);
 243 void scoreboard_init (sack_scoreboard_t * sb);
 244 u8 *format_tcp_scoreboard (u8 * s, va_list * args);
 245
 246 typedef enum _tcp_cc_algorithm_type
 247 {
 248   TCP_CC_NEWRENO,
 249 } tcp_cc_algorithm_type_e;
 250
 251 typedef struct _tcp_cc_algorithm tcp_cc_algorithm_t;
 252
 253 typedef enum _tcp_cc_ack_t
 254 {
 255   TCP_CC_ACK,
 256   TCP_CC_DUPACK,
 257   TCP_CC_PARTIALACK
 258 } tcp_cc_ack_t;
 259
 260 typedef struct _tcp_connection
 261 {
 262   transport_connection_t connection;  /**< Common transport data. First! */
 263
 264   u8 state;                     /**< TCP state as per tcp_state_t */
 265   u16 flags;                    /**< Connection flags (see tcp_conn_flags_e) */
 266   u32 timers[TCP_N_TIMERS];     /**< Timer handles into timer wheel */
 267
 268   /* TODO RFC4898 */
 269
 270   /** Send sequence variables RFC793 */
 271   u32 snd_una;          /**< oldest unacknowledged sequence number */
 272   u32 snd_una_max;      /**< newest unacknowledged sequence number + 1*/
 273   u32 snd_wnd;          /**< send window */
 274   u32 snd_wl1;          /**< seq number used for last snd.wnd update */
 275   u32 snd_wl2;          /**< ack number used for last snd.wnd update */
 276   u32 snd_nxt;          /**< next seq number to be sent */
 277   u16 snd_mss;          /**< Effective send max seg (data) size */
 278
 279   /** Receive sequence variables RFC793 */
 280   u32 rcv_nxt;          /**< next sequence number expected */
 281   u32 rcv_wnd;          /**< receive window we expect */
 282
 283   u32 rcv_las;          /**< rcv_nxt at last ack sent/rcv_wnd update */
 284   u32 iss;              /**< initial sent sequence */
 285   u32 irs;              /**< initial remote sequence */
 286
 287   /* Options */
 288   u8 snd_opts_len;              /**< Tx options len */
 289   u8 rcv_wscale;                /**< Window scale to advertise to peer */
 290   u8 snd_wscale;                /**< Window scale to use when sending */
 291   u32 tsval_recent;             /**< Last timestamp received */
 292   u32 tsval_recent_age;         /**< When last updated tstamp_recent*/
 293   tcp_options_t snd_opts;       /**< Tx options for connection */
 294   tcp_options_t rcv_opts;       /**< Rx options for connection */
 295
 296   sack_block_t *snd_sacks;      /**< Vector of SACKs to send. XXX Fixed size? */
 297   sack_scoreboard_t sack_sb;    /**< SACK "scoreboard" that tracks holes */
 298
 299   u16 rcv_dupacks;      /**< Number of DUPACKs received */
 300   u8 snt_dupacks;       /**< Number of DUPACKs sent in a burst */
 301
 302   /* Congestion control */
 303   u32 cwnd;             /**< Congestion window */
 304   u32 cwnd_acc_bytes;   /**< Bytes accumulated for cwnd increment */
 305   u32 ssthresh;         /**< Slow-start threshold */
 306   u32 prev_ssthresh;    /**< ssthresh before congestion */
 307   u32 prev_cwnd;        /**< ssthresh before congestion */
 308   u32 bytes_acked;      /**< Bytes acknowledged by current segment */
 309   u32 snd_rxt_bytes;    /**< Retransmitted bytes */
 310   u32 snd_rxt_ts;       /**< Timestamp when first packet is retransmitted */
 311   u32 tsecr_last_ack;   /**< Timestamp echoed to us in last healthy ACK */
 312   u32 snd_congestion;   /**< snd_una_max when congestion is detected */
 313   tcp_cc_algorithm_t *cc_algo;  /**< Congestion control algorithm */
 314
 315   /* RTT and RTO */
 316   u32 rto;              /**< Retransmission timeout */
 317   u32 rto_boff;         /**< Index for RTO backoff */
 318   u32 srtt;             /**< Smoothed RTT */
 319   u32 rttvar;           /**< Smoothed mean RTT difference. Approximates variance */
 320   u32 rtt_ts;           /**< Timestamp for tracked ACK */
 321   u32 rtt_seq;          /**< Sequence number for tracked ACK */
 322
 323   u16 mss;              /**< Our max seg size that includes options */
 324   u32 limited_transmit; /**< snd_nxt when limited transmit starts */
 325   u32 last_fib_check;   /**< Last time we checked fib route for peer */
 326   u32 sw_if_index;      /**< Interface for the connection */
 327 } tcp_connection_t;
 328
 329 struct _tcp_cc_algorithm
 330 {
 331   void (*rcv_ack) (tcp_connection_t * tc);
 332   void (*rcv_cong_ack) (tcp_connection_t * tc, tcp_cc_ack_t ack);
 333   void (*congestion) (tcp_connection_t * tc);
 334   void (*recovered) (tcp_connection_t * tc);
 335   void (*init) (tcp_connection_t * tc);
 336 };
 337
 338 #define tcp_fastrecovery_on(tc) (tc)->flags |= TCP_CONN_FAST_RECOVERY
 339 #define tcp_fastrecovery_off(tc) (tc)->flags &= ~TCP_CONN_FAST_RECOVERY
 340 #define tcp_recovery_on(tc) (tc)->flags |= TCP_CONN_RECOVERY
 341 #define tcp_recovery_off(tc) (tc)->flags &= ~TCP_CONN_RECOVERY
 342 #define tcp_in_fastrecovery(tc) ((tc)->flags & TCP_CONN_FAST_RECOVERY)
 343 #define tcp_in_recovery(tc) ((tc)->flags & (TCP_CONN_RECOVERY))
 344 #define tcp_in_slowstart(tc) (tc->cwnd < tc->ssthresh)
 345 #define tcp_fastrecovery_sent_1_smss(tc) ((tc)->flags & TCP_CONN_FR_1_SMSS)
 346 #define tcp_fastrecovery_1_smss_on(tc) ((tc)->flags |= TCP_CONN_FR_1_SMSS)
 347 #define tcp_fastrecovery_1_smss_off(tc) ((tc)->flags &= ~TCP_CONN_FR_1_SMSS)
 348
 349 #define tcp_in_cong_recovery(tc) ((tc)->flags &                 \
 350           (TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
 351
 352 always_inline void
 353 tcp_cong_recovery_off (tcp_connection_t * tc)
 354 {
 355   tc->flags &= ~(TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY);
 356   tcp_fastrecovery_1_smss_off (tc);
 357 }
 358
 359 typedef enum _tcp_error
 360 {
 361 #define tcp_error(n,s) TCP_ERROR_##n,
 362 #include <vnet/tcp/tcp_error.def>
 363 #undef tcp_error
 364   TCP_N_ERROR,
 365 } tcp_error_t;
 366
 367 typedef struct _tcp_lookup_dispatch
 368 {
 369   u8 next, error;
 370 } tcp_lookup_dispatch_t;
 371
 372 typedef struct tcp_worker_ctx_
 373 {
 374   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 375   u32 time_now;                                 /**< worker time */
 376   tw_timer_wheel_16t_2w_512sl_t timer_wheel;    /**< worker timer wheel */
 377   u32 *tx_buffers;                              /**< tx buffer free list */
 378   vlib_frame_t *tx_frames[2];                   /**< tx frames for tcp 4/6
 379                                                      output nodes */
 380   vlib_frame_t *ip_lookup_tx_frames[2];         /**< tx frames for ip 4/6
 381                                                      lookup nodes */
 382     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 383   u8 cached_opts[40];                           /**< cached 'on the wire'
 384                                                      options for bursts */
 385 } tcp_worker_ctx_t;
 386
 387 typedef struct _tcp_main
 388 {
 389   /* Per-worker thread tcp connection pools */
 390   tcp_connection_t **connections;
 391
 392   /* Pool of listeners. */
 393   tcp_connection_t *listener_pool;
 394
 395   /** Dispatch table by state and flags */
 396   tcp_lookup_dispatch_t dispatch_table[TCP_N_STATES][64];
 397
 398   u8 log2_tstamp_clocks_per_tick;
 399   f64 tstamp_ticks_per_clock;
 400
 401   /** per-worker context */
 402   tcp_worker_ctx_t *wrk_ctx;
 403
 404   /* Pool of half-open connections on which we've sent a SYN */
 405   tcp_connection_t *half_open_connections;
 406   clib_spinlock_t half_open_lock;
 407
 408   /* Congestion control algorithms registered */
 409   tcp_cc_algorithm_t *cc_algos;
 410
 411   /** vlib buffer size */
 412   u32 bytes_per_buffer;
 413
 414   /*
 415    * Configuration
 416    */
 417
 418   /* Flag that indicates if stack is on or off */
 419   u8 is_enabled;
 420
 421   /** Max rx fifo size for a session. It is used in to compute the
 422    *  rfc 7323 window scaling factor */
 423   u32 max_rx_fifo;
 424
 425   /** Number of preallocated connections */
 426   u32 preallocated_connections;
 427   u32 preallocated_half_open_connections;
 428
 429   /** Vectors of src addresses. Optional unless one needs > 63K active-opens */
 430   ip4_address_t *ip4_src_addresses;
 431   u32 last_v4_address_rotor;
 432   u32 last_v6_address_rotor;
 433   ip6_address_t *ip6_src_addresses;
 434
 435   u8 punt_unknown4;
 436   u8 punt_unknown6;
 437
 438   /** fault-injection */
 439   f64 buffer_fail_fraction;
 440 } tcp_main_t;
 441
 442 extern tcp_main_t tcp_main;
 443 extern vlib_node_registration_t tcp4_input_node;
 444 extern vlib_node_registration_t tcp6_input_node;
 445 extern vlib_node_registration_t tcp4_output_node;
 446 extern vlib_node_registration_t tcp6_output_node;
 447
 448 always_inline tcp_main_t *
 449 vnet_get_tcp_main ()
 450 {
 451   return &tcp_main;
 452 }
 453
 454 always_inline tcp_header_t *
 455 tcp_buffer_hdr (vlib_buffer_t * b)
 456 {
 457   ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
 458   return (tcp_header_t *) (b->data + b->current_data
 459                            + vnet_buffer (b)->tcp.hdr_offset);
 460 }
 461
 462 #if (VLIB_BUFFER_TRACE_TRAJECTORY)
 463 #define tcp_trajectory_add_start(b, start)                      \
 464 {                                                               \
 465     (*vlib_buffer_trace_trajectory_cb) (b, start);              \
 466 }
 467 #else
 468 #define tcp_trajectory_add_start(b, start)
 469 #endif
 470
 471 clib_error_t *vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en);
 472
 473 void tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
 474
 475 always_inline tcp_connection_t *
 476 tcp_connection_get (u32 conn_index, u32 thread_index)
 477 {
 478   if (PREDICT_FALSE
 479       (pool_is_free_index (tcp_main.connections[thread_index], conn_index)))
 480     return 0;
 481   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 482 }
 483
 484 always_inline tcp_connection_t *
 485 tcp_connection_get_if_valid (u32 conn_index, u32 thread_index)
 486 {
 487   if (tcp_main.connections[thread_index] == 0)
 488     return 0;
 489   if (pool_is_free_index (tcp_main.connections[thread_index], conn_index))
 490     return 0;
 491   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 492 }
 493
 494 always_inline tcp_connection_t *
 495 tcp_get_connection_from_transport (transport_connection_t * tconn)
 496 {
 497   return (tcp_connection_t *) tconn;
 498 }
 499
 500 void tcp_connection_close (tcp_connection_t * tc);
 501 void tcp_connection_cleanup (tcp_connection_t * tc);
 502 void tcp_connection_del (tcp_connection_t * tc);
 503 int tcp_half_open_connection_cleanup (tcp_connection_t * tc);
 504 tcp_connection_t *tcp_connection_new (u8 thread_index);
 505 void tcp_connection_reset (tcp_connection_t * tc);
 506 int tcp_configure_v4_source_address_range (vlib_main_t * vm,
 507                                            ip4_address_t * start,
 508                                            ip4_address_t * end, u32 table_id);
 509 int tcp_configure_v6_source_address_range (vlib_main_t * vm,
 510                                            ip6_address_t * start,
 511                                            ip6_address_t * end, u32 table_id);
 512 void tcp_api_reference (void);
 513 u8 *format_tcp_connection (u8 * s, va_list * args);
 514
 515 always_inline tcp_connection_t *
 516 tcp_listener_get (u32 tli)
 517 {
 518   return pool_elt_at_index (tcp_main.listener_pool, tli);
 519 }
 520
 521 always_inline tcp_connection_t *
 522 tcp_half_open_connection_get (u32 conn_index)
 523 {
 524   tcp_connection_t *tc = 0;
 525   clib_spinlock_lock_if_init (&tcp_main.half_open_lock);
 526   if (!pool_is_free_index (tcp_main.half_open_connections, conn_index))
 527     tc = pool_elt_at_index (tcp_main.half_open_connections, conn_index);
 528   clib_spinlock_unlock_if_init (&tcp_main.half_open_lock);
 529   return tc;
 530 }
 531
 532 void tcp_make_ack (tcp_connection_t * ts, vlib_buffer_t * b);
 533 void tcp_make_fin (tcp_connection_t * tc, vlib_buffer_t * b);
 534 void tcp_make_synack (tcp_connection_t * ts, vlib_buffer_t * b);
 535 void tcp_send_reset_w_pkt (tcp_connection_t * tc, vlib_buffer_t * pkt,
 536                            u8 is_ip4);
 537 void tcp_send_reset (tcp_connection_t * tc);
 538 void tcp_send_syn (tcp_connection_t * tc);
 539 void tcp_send_fin (tcp_connection_t * tc);
 540 void tcp_init_mss (tcp_connection_t * tc);
 541 void tcp_update_burst_snd_vars (tcp_connection_t * tc);
 542 void tcp_update_rto (tcp_connection_t * tc);
 543 void tcp_flush_frame_to_output (vlib_main_t * vm, u8 thread_index, u8 is_ip4);
 544 void tcp_flush_frames_to_output (u8 thread_index);
 545
 546 always_inline u32
 547 tcp_end_seq (tcp_header_t * th, u32 len)
 548 {
 549   return th->seq_number + tcp_is_syn (th) + tcp_is_fin (th) + len;
 550 }
 551
 552 /* Modulo arithmetic for TCP sequence numbers */
 553 #define seq_lt(_s1, _s2) ((i32)((_s1)-(_s2)) < 0)
 554 #define seq_leq(_s1, _s2) ((i32)((_s1)-(_s2)) <= 0)
 555 #define seq_gt(_s1, _s2) ((i32)((_s1)-(_s2)) > 0)
 556 #define seq_geq(_s1, _s2) ((i32)((_s1)-(_s2)) >= 0)
 557 #define seq_max(_s1, _s2) (seq_gt((_s1), (_s2)) ? (_s1) : (_s2))
 558
 559 /* Modulo arithmetic for timestamps */
 560 #define timestamp_lt(_t1, _t2) ((i32)((_t1)-(_t2)) < 0)
 561 #define timestamp_leq(_t1, _t2) ((i32)((_t1)-(_t2)) <= 0)
 562
 563 /**
 564  * Our estimate of the number of bytes that have left the network
 565  */
 566 always_inline u32
 567 tcp_bytes_out (const tcp_connection_t * tc)
 568 {
 569   if (tcp_opts_sack_permitted (&tc->rcv_opts))
 570     return tc->sack_sb.sacked_bytes + tc->sack_sb.lost_bytes;
 571   else
 572     return tc->rcv_dupacks * tc->snd_mss;
 573 }
 574
 575 /**
 576  * Our estimate of the number of bytes in flight (pipe size)
 577  */
 578 always_inline u32
 579 tcp_flight_size (const tcp_connection_t * tc)
 580 {
 581   int flight_size;
 582
 583   flight_size = (int) (tc->snd_una_max - tc->snd_una) - tcp_bytes_out (tc)
 584     + tc->snd_rxt_bytes;
 585
 586   if (flight_size < 0)
 587     {
 588       if (0)
 589         clib_warning
 590           ("Negative: %u %u %u dupacks %u sacked bytes %u flags %d",
 591            tc->snd_una_max - tc->snd_una, tcp_bytes_out (tc),
 592            tc->snd_rxt_bytes, tc->rcv_dupacks, tc->sack_sb.sacked_bytes,
 593            tc->rcv_opts.flags);
 594       return 0;
 595     }
 596
 597   return flight_size;
 598 }
 599
 600 /**
 601  * Initial cwnd as per RFC5681
 602  */
 603 always_inline u32
 604 tcp_initial_cwnd (const tcp_connection_t * tc)
 605 {
 606   if (tc->snd_mss > 2190)
 607     return 2 * tc->snd_mss;
 608   else if (tc->snd_mss > 1095)
 609     return 3 * tc->snd_mss;
 610   else
 611     return 4 * tc->snd_mss;
 612 }
 613
 614 always_inline u32
 615 tcp_loss_wnd (const tcp_connection_t * tc)
 616 {
 617   return tc->snd_mss;
 618 }
 619
 620 always_inline u32
 621 tcp_available_snd_wnd (const tcp_connection_t * tc)
 622 {
 623   return clib_min (tc->cwnd, tc->snd_wnd);
 624 }
 625
 626 always_inline u32
 627 tcp_available_output_snd_space (const tcp_connection_t * tc)
 628 {
 629   u32 available_wnd = tcp_available_snd_wnd (tc);
 630   int flight_size = (int) (tc->snd_nxt - tc->snd_una);
 631
 632   if (available_wnd <= flight_size)
 633     return 0;
 634
 635   return available_wnd - flight_size;
 636 }
 637
 638 /**
 639  * Estimate of how many bytes we can still push into the network
 640  */
 641 always_inline u32
 642 tcp_available_cc_snd_space (const tcp_connection_t * tc)
 643 {
 644   u32 available_wnd = tcp_available_snd_wnd (tc);
 645   u32 flight_size = tcp_flight_size (tc);
 646
 647   if (available_wnd <= flight_size)
 648     return 0;
 649
 650   return available_wnd - flight_size;
 651 }
 652
 653 always_inline u8
 654 tcp_is_lost_fin (tcp_connection_t * tc)
 655 {
 656   if ((tc->flags & TCP_CONN_FINSNT) && tc->snd_una_max - tc->snd_una == 1)
 657     return 1;
 658   return 0;
 659 }
 660
 661 u32 tcp_snd_space (tcp_connection_t * tc);
 662 void tcp_retransmit_first_unacked (tcp_connection_t * tc);
 663 void tcp_fast_retransmit_no_sack (tcp_connection_t * tc);
 664 void tcp_fast_retransmit_sack (tcp_connection_t * tc);
 665 void tcp_fast_retransmit (tcp_connection_t * tc);
 666 void tcp_cc_init_congestion (tcp_connection_t * tc);
 667 void tcp_cc_fastrecovery_exit (tcp_connection_t * tc);
 668
 669 fib_node_index_t tcp_lookup_rmt_in_fib (tcp_connection_t * tc);
 670
 671 /* Made public for unit testing only */
 672 void tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end);
 673 u32 tcp_sack_list_bytes (tcp_connection_t * tc);
 674
 675 always_inline u32
 676 tcp_time_now (void)
 677 {
 678   return tcp_main.wrk_ctx[vlib_get_thread_index ()].time_now;
 679 }
 680
 681 always_inline u32
 682 tcp_set_time_now (u32 thread_index)
 683 {
 684   tcp_main.wrk_ctx[thread_index].time_now = clib_cpu_time_now ()
 685     * tcp_main.tstamp_ticks_per_clock;
 686   return tcp_main.wrk_ctx[thread_index].time_now;
 687 }
 688
 689 u32 tcp_push_header (tcp_connection_t * tconn, vlib_buffer_t * b);
 690
 691 void tcp_connection_timers_init (tcp_connection_t * tc);
 692 void tcp_connection_timers_reset (tcp_connection_t * tc);
 693 void tcp_init_snd_vars (tcp_connection_t * tc);
 694 void tcp_connection_init_vars (tcp_connection_t * tc);
 695
 696 always_inline void
 697 tcp_connection_force_ack (tcp_connection_t * tc, vlib_buffer_t * b)
 698 {
 699   /* Reset flags, make sure ack is sent */
 700   tc->flags = TCP_CONN_SNDACK;
 701   vnet_buffer (b)->tcp.flags &= ~TCP_BUF_FLAG_DUPACK;
 702 }
 703
 704 always_inline void
 705 tcp_timer_set (tcp_connection_t * tc, u8 timer_id, u32 interval)
 706 {
 707   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
 708   ASSERT (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID);
 709   tc->timers[timer_id] =
 710     tw_timer_start_16t_2w_512sl (&tcp_main.
 711                                  wrk_ctx[tc->c_thread_index].timer_wheel,
 712                                  tc->c_c_index, timer_id, interval);
 713 }
 714
 715 always_inline void
 716 tcp_timer_reset (tcp_connection_t * tc, u8 timer_id)
 717 {
 718   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
 719   if (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID)
 720     return;
 721
 722   tw_timer_stop_16t_2w_512sl (&tcp_main.
 723                               wrk_ctx[tc->c_thread_index].timer_wheel,
 724                               tc->timers[timer_id]);
 725   tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
 726 }
 727
 728 always_inline void
 729 tcp_timer_update (tcp_connection_t * tc, u8 timer_id, u32 interval)
 730 {
 731   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
 732   if (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID)
 733     tw_timer_update_16t_2w_512sl (&tcp_main.
 734                                   wrk_ctx[tc->c_thread_index].timer_wheel,
 735                                   tc->timers[timer_id], interval);
 736   else
 737     tc->timers[timer_id] =
 738       tw_timer_start_16t_2w_512sl (&tcp_main.
 739                                    wrk_ctx[tc->c_thread_index].timer_wheel,
 740                                    tc->c_c_index, timer_id, interval);
 741 }
 742
 743 always_inline void
 744 tcp_retransmit_timer_set (tcp_connection_t * tc)
 745 {
 746   ASSERT (tc->snd_una != tc->snd_una_max);
 747   tcp_timer_set (tc, TCP_TIMER_RETRANSMIT,
 748                  clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 749 }
 750
 751 always_inline void
 752 tcp_retransmit_timer_reset (tcp_connection_t * tc)
 753 {
 754   tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT);
 755 }
 756
 757 always_inline void
 758 tcp_retransmit_timer_force_update (tcp_connection_t * tc)
 759 {
 760   tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
 761                     clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 762 }
 763
 764 always_inline void
 765 tcp_persist_timer_set (tcp_connection_t * tc)
 766 {
 767   /* Reuse RTO. It's backed off in handler */
 768   tcp_timer_set (tc, TCP_TIMER_PERSIST,
 769                  clib_max (tc->rto * TCP_TO_TIMER_TICK,
 770                            TCP_TIMER_PERSIST_MIN));
 771 }
 772
 773 always_inline void
 774 tcp_persist_timer_update (tcp_connection_t * tc)
 775 {
 776   tcp_timer_update (tc, TCP_TIMER_PERSIST,
 777                     clib_max (tc->rto * TCP_TO_TIMER_TICK,
 778                               TCP_TIMER_PERSIST_MIN));
 779 }
 780
 781 always_inline void
 782 tcp_persist_timer_reset (tcp_connection_t * tc)
 783 {
 784   tcp_timer_reset (tc, TCP_TIMER_PERSIST);
 785 }
 786
 787 always_inline void
 788 tcp_retransmit_timer_update (tcp_connection_t * tc)
 789 {
 790   if (tc->snd_una == tc->snd_una_max)
 791     {
 792       tcp_retransmit_timer_reset (tc);
 793       if (tc->snd_wnd < tc->snd_mss)
 794         tcp_persist_timer_update (tc);
 795     }
 796   else
 797     tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
 798                       clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 799 }
 800
 801 always_inline u8
 802 tcp_timer_is_active (tcp_connection_t * tc, tcp_timers_e timer)
 803 {
 804   return tc->timers[timer] != TCP_TIMER_HANDLE_INVALID;
 805 }
 806
 807 #define tcp_validate_txf_size(_tc, _a)                                  \
 808   ASSERT(_tc->state != TCP_STATE_ESTABLISHED                            \
 809          || session_tx_fifo_max_dequeue (&_tc->connection) >= _a)
 810
 811 void tcp_rcv_sacks (tcp_connection_t * tc, u32 ack);
 812 u8 *tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose);
 813
 814 void tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
 815                            const tcp_cc_algorithm_t * vft);
 816
 817 tcp_cc_algorithm_t *tcp_cc_algo_get (tcp_cc_algorithm_type_e type);
 818
 819 /**
 820  * Push TCP header to buffer
 821  *
 822  * @param vm - vlib_main
 823  * @param b - buffer to write the header to
 824  * @param sp_net - source port net order
 825  * @param dp_net - destination port net order
 826  * @param seq - sequence number net order
 827  * @param ack - ack number net order
 828  * @param tcp_hdr_opts_len - header and options length in bytes
 829  * @param flags - header flags
 830  * @param wnd - window size
 831  *
 832  * @return - pointer to start of TCP header
 833  */
 834 always_inline void *
 835 vlib_buffer_push_tcp_net_order (vlib_buffer_t * b, u16 sp, u16 dp, u32 seq,
 836                                 u32 ack, u8 tcp_hdr_opts_len, u8 flags,
 837                                 u16 wnd)
 838 {
 839   tcp_header_t *th;
 840
 841   th = vlib_buffer_push_uninit (b, tcp_hdr_opts_len);
 842
 843   th->src_port = sp;
 844   th->dst_port = dp;
 845   th->seq_number = seq;
 846   th->ack_number = ack;
 847   th->data_offset_and_reserved = (tcp_hdr_opts_len >> 2) << 4;
 848   th->flags = flags;
 849   th->window = wnd;
 850   th->checksum = 0;
 851   th->urgent_pointer = 0;
 852   return th;
 853 }
 854
 855 /**
 856  * Push TCP header to buffer
 857  *
 858  * @param b - buffer to write the header to
 859  * @param sp_net - source port net order
 860  * @param dp_net - destination port net order
 861  * @param seq - sequence number host order
 862  * @param ack - ack number host order
 863  * @param tcp_hdr_opts_len - header and options length in bytes
 864  * @param flags - header flags
 865  * @param wnd - window size
 866  *
 867  * @return - pointer to start of TCP header
 868  */
 869 always_inline void *
 870 vlib_buffer_push_tcp (vlib_buffer_t * b, u16 sp_net, u16 dp_net, u32 seq,
 871                       u32 ack, u8 tcp_hdr_opts_len, u8 flags, u16 wnd)
 872 {
 873   return vlib_buffer_push_tcp_net_order (b, sp_net, dp_net,
 874                                          clib_host_to_net_u32 (seq),
 875                                          clib_host_to_net_u32 (ack),
 876                                          tcp_hdr_opts_len, flags,
 877                                          clib_host_to_net_u16 (wnd));
 878 }
 879
 880 #endif /* _vnet_tcp_h_ */
 881
 882 /*
 883  * fd.io coding-style-patch-verification: ON
 884  *
 885  * Local Variables:
 886  * eval: (c-set-style "gnu")
 887  * End:
 888  */