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