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 20
  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   _(FR_1_SMSS, "Sent 1 SMSS")                   \
 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 struct _tcp_cc_algorithm
 340 {
 341   void (*rcv_ack) (tcp_connection_t * tc);
 342   void (*rcv_cong_ack) (tcp_connection_t * tc, tcp_cc_ack_t ack);
 343   void (*congestion) (tcp_connection_t * tc);
 344   void (*recovered) (tcp_connection_t * tc);
 345   void (*init) (tcp_connection_t * tc);
 346 };
 347
 348 #define tcp_fastrecovery_on(tc) (tc)->flags |= TCP_CONN_FAST_RECOVERY
 349 #define tcp_fastrecovery_off(tc) (tc)->flags &= ~TCP_CONN_FAST_RECOVERY
 350 #define tcp_recovery_on(tc) (tc)->flags |= TCP_CONN_RECOVERY
 351 #define tcp_recovery_off(tc) (tc)->flags &= ~TCP_CONN_RECOVERY
 352 #define tcp_in_fastrecovery(tc) ((tc)->flags & TCP_CONN_FAST_RECOVERY)
 353 #define tcp_in_recovery(tc) ((tc)->flags & (TCP_CONN_RECOVERY))
 354 #define tcp_in_slowstart(tc) (tc->cwnd < tc->ssthresh)
 355 #define tcp_fastrecovery_sent_1_smss(tc) ((tc)->flags & TCP_CONN_FR_1_SMSS)
 356 #define tcp_fastrecovery_1_smss_on(tc) ((tc)->flags |= TCP_CONN_FR_1_SMSS)
 357 #define tcp_fastrecovery_1_smss_off(tc) ((tc)->flags &= ~TCP_CONN_FR_1_SMSS)
 358 #define tcp_fastrecovery_first(tc) ((tc)->flags & TCP_CONN_FRXT_FIRST)
 359 #define tcp_fastrecovery_first_on(tc) ((tc)->flags |= TCP_CONN_FRXT_FIRST)
 360 #define tcp_fastrecovery_first_off(tc) ((tc)->flags &= ~TCP_CONN_FRXT_FIRST)
 361
 362 #define tcp_in_cong_recovery(tc) ((tc)->flags &                 \
 363           (TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY))
 364
 365 always_inline void
 366 tcp_cong_recovery_off (tcp_connection_t * tc)
 367 {
 368   tc->flags &= ~(TCP_CONN_FAST_RECOVERY | TCP_CONN_RECOVERY);
 369   tcp_fastrecovery_1_smss_off (tc);
 370   tcp_fastrecovery_first_off (tc);
 371 }
 372
 373 typedef enum _tcp_error
 374 {
 375 #define tcp_error(n,s) TCP_ERROR_##n,
 376 #include <vnet/tcp/tcp_error.def>
 377 #undef tcp_error
 378   TCP_N_ERROR,
 379 } tcp_error_t;
 380
 381 typedef struct _tcp_lookup_dispatch
 382 {
 383   u8 next, error;
 384 } tcp_lookup_dispatch_t;
 385
 386 typedef struct tcp_worker_ctx_
 387 {
 388   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 389   u32 time_now;                                 /**< worker time */
 390   tw_timer_wheel_16t_2w_512sl_t timer_wheel;    /**< worker timer wheel */
 391   u32 *tx_buffers;                              /**< tx buffer free list */
 392   vlib_frame_t *tx_frames[2];                   /**< tx frames for tcp 4/6
 393                                                      output nodes */
 394   vlib_frame_t *ip_lookup_tx_frames[2];         /**< tx frames for ip 4/6
 395                                                      lookup nodes */
 396   u32 *pending_fast_rxt;                        /**< vector of connections
 397                                                      needing fast rxt */
 398   u32 *ongoing_fast_rxt;                        /**< vector of connections
 399                                                      now doing fast rxt */
 400   u32 *postponed_fast_rxt;                      /**< vector of connections
 401                                                      that will do fast rxt */
 402   u32 *pending_deq_acked;
 403   u32 *pending_acks;
 404   vlib_main_t *vm;                              /**< pointer to vm */
 405
 406     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 407   u8 cached_opts[40];                           /**< cached 'on the wire'
 408                                                      options for bursts */
 409
 410 } tcp_worker_ctx_t;
 411
 412 typedef struct _tcp_main
 413 {
 414   /* Per-worker thread tcp connection pools */
 415   tcp_connection_t **connections;
 416
 417   /* Pool of listeners. */
 418   tcp_connection_t *listener_pool;
 419
 420   /** Dispatch table by state and flags */
 421   tcp_lookup_dispatch_t dispatch_table[TCP_N_STATES][64];
 422
 423   u8 log2_tstamp_clocks_per_tick;
 424   f64 tstamp_ticks_per_clock;
 425
 426   /** per-worker context */
 427   tcp_worker_ctx_t *wrk_ctx;
 428
 429   /* Pool of half-open connections on which we've sent a SYN */
 430   tcp_connection_t *half_open_connections;
 431   clib_spinlock_t half_open_lock;
 432
 433   /* Congestion control algorithms registered */
 434   tcp_cc_algorithm_t *cc_algos;
 435
 436   /** vlib buffer size */
 437   u32 bytes_per_buffer;
 438
 439   /*
 440    * Configuration
 441    */
 442
 443   /* Flag that indicates if stack is on or off */
 444   u8 is_enabled;
 445
 446   /** Max rx fifo size for a session. It is used in to compute the
 447    *  rfc 7323 window scaling factor */
 448   u32 max_rx_fifo;
 449
 450   /** Number of preallocated connections */
 451   u32 preallocated_connections;
 452   u32 preallocated_half_open_connections;
 453
 454   /** Vectors of src addresses. Optional unless one needs > 63K active-opens */
 455   ip4_address_t *ip4_src_addresses;
 456   u32 last_v4_address_rotor;
 457   u32 last_v6_address_rotor;
 458   ip6_address_t *ip6_src_addresses;
 459
 460   /** Enable tx pacing for new connections */
 461   u8 tx_pacing;
 462
 463   u8 punt_unknown4;
 464   u8 punt_unknown6;
 465
 466   /** fault-injection */
 467   f64 buffer_fail_fraction;
 468
 469   u8 cc_algo;
 470 } tcp_main_t;
 471
 472 extern tcp_main_t tcp_main;
 473 extern vlib_node_registration_t tcp4_input_node;
 474 extern vlib_node_registration_t tcp6_input_node;
 475 extern vlib_node_registration_t tcp4_output_node;
 476 extern vlib_node_registration_t tcp6_output_node;
 477
 478 always_inline tcp_main_t *
 479 vnet_get_tcp_main ()
 480 {
 481   return &tcp_main;
 482 }
 483
 484 always_inline tcp_worker_ctx_t *
 485 tcp_get_worker (u32 thread_index)
 486 {
 487   return &tcp_main.wrk_ctx[thread_index];
 488 }
 489
 490 always_inline tcp_header_t *
 491 tcp_buffer_hdr (vlib_buffer_t * b)
 492 {
 493   ASSERT ((signed) b->current_data >= (signed) -VLIB_BUFFER_PRE_DATA_SIZE);
 494   return (tcp_header_t *) (b->data + b->current_data
 495                            + vnet_buffer (b)->tcp.hdr_offset);
 496 }
 497
 498 #if (VLIB_BUFFER_TRACE_TRAJECTORY)
 499 #define tcp_trajectory_add_start(b, start)                      \
 500 {                                                               \
 501     (*vlib_buffer_trace_trajectory_cb) (b, start);              \
 502 }
 503 #else
 504 #define tcp_trajectory_add_start(b, start)
 505 #endif
 506
 507 clib_error_t *vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en);
 508
 509 void tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
 510
 511 always_inline tcp_connection_t *
 512 tcp_connection_get (u32 conn_index, u32 thread_index)
 513 {
 514   if (PREDICT_FALSE
 515       (pool_is_free_index (tcp_main.connections[thread_index], conn_index)))
 516     return 0;
 517   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 518 }
 519
 520 always_inline tcp_connection_t *
 521 tcp_connection_get_if_valid (u32 conn_index, u32 thread_index)
 522 {
 523   if (tcp_main.connections[thread_index] == 0)
 524     return 0;
 525   if (pool_is_free_index (tcp_main.connections[thread_index], conn_index))
 526     return 0;
 527   return pool_elt_at_index (tcp_main.connections[thread_index], conn_index);
 528 }
 529
 530 always_inline tcp_connection_t *
 531 tcp_get_connection_from_transport (transport_connection_t * tconn)
 532 {
 533   return (tcp_connection_t *) tconn;
 534 }
 535
 536 void tcp_connection_close (tcp_connection_t * tc);
 537 void tcp_connection_cleanup (tcp_connection_t * tc);
 538 void tcp_connection_del (tcp_connection_t * tc);
 539 int tcp_half_open_connection_cleanup (tcp_connection_t * tc);
 540 tcp_connection_t *tcp_connection_new (u8 thread_index);
 541 void tcp_connection_reset (tcp_connection_t * tc);
 542 int tcp_configure_v4_source_address_range (vlib_main_t * vm,
 543                                            ip4_address_t * start,
 544                                            ip4_address_t * end, u32 table_id);
 545 int tcp_configure_v6_source_address_range (vlib_main_t * vm,
 546                                            ip6_address_t * start,
 547                                            ip6_address_t * end, u32 table_id);
 548 void tcp_api_reference (void);
 549 u8 *format_tcp_connection (u8 * s, va_list * args);
 550
 551 always_inline tcp_connection_t *
 552 tcp_listener_get (u32 tli)
 553 {
 554   return pool_elt_at_index (tcp_main.listener_pool, tli);
 555 }
 556
 557 always_inline tcp_connection_t *
 558 tcp_half_open_connection_get (u32 conn_index)
 559 {
 560   tcp_connection_t *tc = 0;
 561   clib_spinlock_lock_if_init (&tcp_main.half_open_lock);
 562   if (!pool_is_free_index (tcp_main.half_open_connections, conn_index))
 563     tc = pool_elt_at_index (tcp_main.half_open_connections, conn_index);
 564   clib_spinlock_unlock_if_init (&tcp_main.half_open_lock);
 565   return tc;
 566 }
 567
 568 void tcp_make_ack (tcp_connection_t * ts, vlib_buffer_t * b);
 569 void tcp_make_fin (tcp_connection_t * tc, vlib_buffer_t * b);
 570 void tcp_make_synack (tcp_connection_t * ts, vlib_buffer_t * b);
 571 void tcp_send_reset_w_pkt (tcp_connection_t * tc, vlib_buffer_t * pkt,
 572                            u8 is_ip4);
 573 void tcp_send_reset (tcp_connection_t * tc);
 574 void tcp_send_syn (tcp_connection_t * tc);
 575 void tcp_send_synack (tcp_connection_t * tc);
 576 void tcp_send_fin (tcp_connection_t * tc);
 577 void tcp_init_mss (tcp_connection_t * tc);
 578 void tcp_update_burst_snd_vars (tcp_connection_t * tc);
 579 void tcp_update_rto (tcp_connection_t * tc);
 580 void tcp_flush_frame_to_output (tcp_worker_ctx_t * wrk, u8 is_ip4);
 581 void tcp_flush_frames_to_output (tcp_worker_ctx_t * wrk);
 582 void tcp_program_fastretransmit (tcp_worker_ctx_t * wrk,
 583                                  tcp_connection_t * tc);
 584 void tcp_do_fastretransmits (tcp_worker_ctx_t * wrk);
 585
 586 void tcp_program_ack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc);
 587 void tcp_program_dupack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc);
 588 void tcp_send_acks (tcp_worker_ctx_t * wrk);
 589
 590 always_inline u32
 591 tcp_end_seq (tcp_header_t * th, u32 len)
 592 {
 593   return th->seq_number + tcp_is_syn (th) + tcp_is_fin (th) + len;
 594 }
 595
 596 /* Modulo arithmetic for TCP sequence numbers */
 597 #define seq_lt(_s1, _s2) ((i32)((_s1)-(_s2)) < 0)
 598 #define seq_leq(_s1, _s2) ((i32)((_s1)-(_s2)) <= 0)
 599 #define seq_gt(_s1, _s2) ((i32)((_s1)-(_s2)) > 0)
 600 #define seq_geq(_s1, _s2) ((i32)((_s1)-(_s2)) >= 0)
 601 #define seq_max(_s1, _s2) (seq_gt((_s1), (_s2)) ? (_s1) : (_s2))
 602
 603 /* Modulo arithmetic for timestamps */
 604 #define timestamp_lt(_t1, _t2) ((i32)((_t1)-(_t2)) < 0)
 605 #define timestamp_leq(_t1, _t2) ((i32)((_t1)-(_t2)) <= 0)
 606
 607 /**
 608  * Our estimate of the number of bytes that have left the network
 609  */
 610 always_inline u32
 611 tcp_bytes_out (const tcp_connection_t * tc)
 612 {
 613   if (tcp_opts_sack_permitted (&tc->rcv_opts))
 614     return tc->sack_sb.sacked_bytes + tc->sack_sb.lost_bytes;
 615   else
 616     return tc->rcv_dupacks * tc->snd_mss;
 617 }
 618
 619 /**
 620  * Our estimate of the number of bytes in flight (pipe size)
 621  */
 622 always_inline u32
 623 tcp_flight_size (const tcp_connection_t * tc)
 624 {
 625   int flight_size;
 626
 627   flight_size = (int) (tc->snd_una_max - tc->snd_una) - tcp_bytes_out (tc)
 628     + tc->snd_rxt_bytes;
 629
 630   if (flight_size < 0)
 631     {
 632       if (0)
 633         clib_warning
 634           ("Negative: %u %u %u dupacks %u sacked bytes %u flags %d",
 635            tc->snd_una_max - tc->snd_una, tcp_bytes_out (tc),
 636            tc->snd_rxt_bytes, tc->rcv_dupacks, tc->sack_sb.sacked_bytes,
 637            tc->rcv_opts.flags);
 638       return 0;
 639     }
 640
 641   return flight_size;
 642 }
 643
 644 /**
 645  * Initial cwnd as per RFC5681
 646  */
 647 always_inline u32
 648 tcp_initial_cwnd (const tcp_connection_t * tc)
 649 {
 650   if (tc->snd_mss > 2190)
 651     return 2 * tc->snd_mss;
 652   else if (tc->snd_mss > 1095)
 653     return 3 * tc->snd_mss;
 654   else
 655     return 4 * tc->snd_mss;
 656 }
 657
 658 /*
 659  * Accumulate acked bytes for cwnd increase
 660  *
 661  * Once threshold bytes are accumulated, snd_mss bytes are added
 662  * to the cwnd.
 663  */
 664 always_inline void
 665 tcp_cwnd_accumulate (tcp_connection_t * tc, u32 thresh, u32 bytes)
 666 {
 667   tc->cwnd_acc_bytes += bytes;
 668   if (tc->cwnd_acc_bytes >= thresh)
 669     {
 670       u32 inc = tc->cwnd_acc_bytes / thresh;
 671       tc->cwnd_acc_bytes -= inc * thresh;
 672       tc->cwnd += inc * tc->snd_mss;
 673       tc->cwnd = clib_min (tc->cwnd, tc->tx_fifo_size);
 674     }
 675 }
 676
 677 always_inline u32
 678 tcp_loss_wnd (const tcp_connection_t * tc)
 679 {
 680   return tc->snd_mss;
 681 }
 682
 683 always_inline u32
 684 tcp_available_snd_wnd (const tcp_connection_t * tc)
 685 {
 686   return clib_min (tc->cwnd, tc->snd_wnd);
 687 }
 688
 689 always_inline u32
 690 tcp_available_output_snd_space (const tcp_connection_t * tc)
 691 {
 692   u32 available_wnd = tcp_available_snd_wnd (tc);
 693   int flight_size = (int) (tc->snd_nxt - tc->snd_una);
 694
 695   if (available_wnd <= flight_size)
 696     return 0;
 697
 698   return available_wnd - flight_size;
 699 }
 700
 701 /**
 702  * Estimate of how many bytes we can still push into the network
 703  */
 704 always_inline u32
 705 tcp_available_cc_snd_space (const tcp_connection_t * tc)
 706 {
 707   u32 available_wnd = tcp_available_snd_wnd (tc);
 708   u32 flight_size = tcp_flight_size (tc);
 709
 710   if (available_wnd <= flight_size)
 711     return 0;
 712
 713   return available_wnd - flight_size;
 714 }
 715
 716 always_inline u8
 717 tcp_is_lost_fin (tcp_connection_t * tc)
 718 {
 719   if ((tc->flags & TCP_CONN_FINSNT) && tc->snd_una_max - tc->snd_una == 1)
 720     return 1;
 721   return 0;
 722 }
 723
 724 u32 tcp_snd_space (tcp_connection_t * tc);
 725 int tcp_retransmit_first_unacked (tcp_worker_ctx_t * wrk,
 726                                   tcp_connection_t * tc);
 727 int tcp_fast_retransmit_no_sack (tcp_worker_ctx_t * wrk,
 728                                  tcp_connection_t * tc, u32 burst_size);
 729 int tcp_fast_retransmit_sack (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
 730                               u32 burst_size);
 731 int tcp_fast_retransmit (tcp_worker_ctx_t * wrk, tcp_connection_t * tc,
 732                          u32 burst_size);
 733 void tcp_cc_init_congestion (tcp_connection_t * tc);
 734 void tcp_cc_fastrecovery_exit (tcp_connection_t * tc);
 735
 736 fib_node_index_t tcp_lookup_rmt_in_fib (tcp_connection_t * tc);
 737
 738 /* Made public for unit testing only */
 739 void tcp_update_sack_list (tcp_connection_t * tc, u32 start, u32 end);
 740 u32 tcp_sack_list_bytes (tcp_connection_t * tc);
 741
 742 always_inline u32
 743 tcp_time_now (void)
 744 {
 745   return tcp_main.wrk_ctx[vlib_get_thread_index ()].time_now;
 746 }
 747
 748 always_inline u32
 749 tcp_time_now_w_thread (u32 thread_index)
 750 {
 751   return tcp_main.wrk_ctx[thread_index].time_now;
 752 }
 753
 754 always_inline f64
 755 tcp_time_now_us (u32 thread_index)
 756 {
 757   return transport_time_now (thread_index);
 758 }
 759
 760 always_inline u32
 761 tcp_set_time_now (tcp_worker_ctx_t * wrk)
 762 {
 763   wrk->time_now = clib_cpu_time_now () * tcp_main.tstamp_ticks_per_clock;
 764   return wrk->time_now;
 765 }
 766
 767 u32 tcp_push_header (tcp_connection_t * tconn, vlib_buffer_t * b);
 768
 769 void tcp_connection_timers_init (tcp_connection_t * tc);
 770 void tcp_connection_timers_reset (tcp_connection_t * tc);
 771 void tcp_init_snd_vars (tcp_connection_t * tc);
 772 void tcp_connection_init_vars (tcp_connection_t * tc);
 773 void tcp_connection_tx_pacer_update (tcp_connection_t * tc);
 774 void tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
 775                                     u32 start_bucket);
 776
 777 always_inline void
 778 tcp_cc_rcv_ack (tcp_connection_t * tc)
 779 {
 780   tc->cc_algo->rcv_ack (tc);
 781   tc->tsecr_last_ack = tc->rcv_opts.tsecr;
 782 }
 783
 784 always_inline void
 785 tcp_timer_set (tcp_connection_t * tc, u8 timer_id, u32 interval)
 786 {
 787   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
 788   ASSERT (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID);
 789   tc->timers[timer_id] =
 790     tw_timer_start_16t_2w_512sl (&tcp_main.
 791                                  wrk_ctx[tc->c_thread_index].timer_wheel,
 792                                  tc->c_c_index, timer_id, interval);
 793 }
 794
 795 always_inline void
 796 tcp_timer_reset (tcp_connection_t * tc, u8 timer_id)
 797 {
 798   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
 799   if (tc->timers[timer_id] == TCP_TIMER_HANDLE_INVALID)
 800     return;
 801
 802   tw_timer_stop_16t_2w_512sl (&tcp_main.
 803                               wrk_ctx[tc->c_thread_index].timer_wheel,
 804                               tc->timers[timer_id]);
 805   tc->timers[timer_id] = TCP_TIMER_HANDLE_INVALID;
 806 }
 807
 808 always_inline void
 809 tcp_timer_update (tcp_connection_t * tc, u8 timer_id, u32 interval)
 810 {
 811   ASSERT (tc->c_thread_index == vlib_get_thread_index ());
 812   if (tc->timers[timer_id] != TCP_TIMER_HANDLE_INVALID)
 813     tw_timer_update_16t_2w_512sl (&tcp_main.
 814                                   wrk_ctx[tc->c_thread_index].timer_wheel,
 815                                   tc->timers[timer_id], interval);
 816   else
 817     tc->timers[timer_id] =
 818       tw_timer_start_16t_2w_512sl (&tcp_main.
 819                                    wrk_ctx[tc->c_thread_index].timer_wheel,
 820                                    tc->c_c_index, timer_id, interval);
 821 }
 822
 823 always_inline void
 824 tcp_retransmit_timer_set (tcp_connection_t * tc)
 825 {
 826   ASSERT (tc->snd_una != tc->snd_una_max);
 827   tcp_timer_set (tc, TCP_TIMER_RETRANSMIT,
 828                  clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 829 }
 830
 831 always_inline void
 832 tcp_retransmit_timer_reset (tcp_connection_t * tc)
 833 {
 834   tcp_timer_reset (tc, TCP_TIMER_RETRANSMIT);
 835 }
 836
 837 always_inline void
 838 tcp_retransmit_timer_force_update (tcp_connection_t * tc)
 839 {
 840   tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
 841                     clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 842 }
 843
 844 always_inline void
 845 tcp_persist_timer_set (tcp_connection_t * tc)
 846 {
 847   /* Reuse RTO. It's backed off in handler */
 848   tcp_timer_set (tc, TCP_TIMER_PERSIST,
 849                  clib_max (tc->rto * TCP_TO_TIMER_TICK,
 850                            TCP_TIMER_PERSIST_MIN));
 851 }
 852
 853 always_inline void
 854 tcp_persist_timer_update (tcp_connection_t * tc)
 855 {
 856   tcp_timer_update (tc, TCP_TIMER_PERSIST,
 857                     clib_max (tc->rto * TCP_TO_TIMER_TICK,
 858                               TCP_TIMER_PERSIST_MIN));
 859 }
 860
 861 always_inline void
 862 tcp_persist_timer_reset (tcp_connection_t * tc)
 863 {
 864   tcp_timer_reset (tc, TCP_TIMER_PERSIST);
 865 }
 866
 867 always_inline void
 868 tcp_retransmit_timer_update (tcp_connection_t * tc)
 869 {
 870   if (tc->snd_una == tc->snd_una_max)
 871     {
 872       tcp_retransmit_timer_reset (tc);
 873       if (tc->snd_wnd < tc->snd_mss)
 874         tcp_persist_timer_update (tc);
 875     }
 876   else
 877     tcp_timer_update (tc, TCP_TIMER_RETRANSMIT,
 878                       clib_max (tc->rto * TCP_TO_TIMER_TICK, 1));
 879 }
 880
 881 always_inline u8
 882 tcp_timer_is_active (tcp_connection_t * tc, tcp_timers_e timer)
 883 {
 884   return tc->timers[timer] != TCP_TIMER_HANDLE_INVALID;
 885 }
 886
 887 #define tcp_validate_txf_size(_tc, _a)                                  \
 888   ASSERT(_tc->state != TCP_STATE_ESTABLISHED                            \
 889          || session_tx_fifo_max_dequeue (&_tc->connection) >= _a)
 890
 891 void tcp_rcv_sacks (tcp_connection_t * tc, u32 ack);
 892 u8 *tcp_scoreboard_replay (u8 * s, tcp_connection_t * tc, u8 verbose);
 893
 894 void tcp_cc_algo_register (tcp_cc_algorithm_type_e type,
 895                            const tcp_cc_algorithm_t * vft);
 896
 897 tcp_cc_algorithm_t *tcp_cc_algo_get (tcp_cc_algorithm_type_e type);
 898
 899 static inline void *
 900 tcp_cc_data (tcp_connection_t * tc)
 901 {
 902   return (void *) tc->cc_data;
 903 }
 904
 905 void newreno_rcv_cong_ack (tcp_connection_t * tc, tcp_cc_ack_t ack_type);
 906
 907 /**
 908  * Push TCP header to buffer
 909  *
 910  * @param vm - vlib_main
 911  * @param b - buffer to write the header to
 912  * @param sp_net - source port net order
 913  * @param dp_net - destination port net order
 914  * @param seq - sequence number net order
 915  * @param ack - ack number net order
 916  * @param tcp_hdr_opts_len - header and options length in bytes
 917  * @param flags - header flags
 918  * @param wnd - window size
 919  *
 920  * @return - pointer to start of TCP header
 921  */
 922 always_inline void *
 923 vlib_buffer_push_tcp_net_order (vlib_buffer_t * b, u16 sp, u16 dp, u32 seq,
 924                                 u32 ack, u8 tcp_hdr_opts_len, u8 flags,
 925                                 u16 wnd)
 926 {
 927   tcp_header_t *th;
 928
 929   th = vlib_buffer_push_uninit (b, tcp_hdr_opts_len);
 930
 931   th->src_port = sp;
 932   th->dst_port = dp;
 933   th->seq_number = seq;
 934   th->ack_number = ack;
 935   th->data_offset_and_reserved = (tcp_hdr_opts_len >> 2) << 4;
 936   th->flags = flags;
 937   th->window = wnd;
 938   th->checksum = 0;
 939   th->urgent_pointer = 0;
 940   return th;
 941 }
 942
 943 /**
 944  * Push TCP header to buffer
 945  *
 946  * @param b - buffer to write the header to
 947  * @param sp_net - source port net order
 948  * @param dp_net - destination port net order
 949  * @param seq - sequence number host order
 950  * @param ack - ack number host order
 951  * @param tcp_hdr_opts_len - header and options length in bytes
 952  * @param flags - header flags
 953  * @param wnd - window size
 954  *
 955  * @return - pointer to start of TCP header
 956  */
 957 always_inline void *
 958 vlib_buffer_push_tcp (vlib_buffer_t * b, u16 sp_net, u16 dp_net, u32 seq,
 959                       u32 ack, u8 tcp_hdr_opts_len, u8 flags, u16 wnd)
 960 {
 961   return vlib_buffer_push_tcp_net_order (b, sp_net, dp_net,
 962                                          clib_host_to_net_u32 (seq),
 963                                          clib_host_to_net_u32 (ack),
 964                                          tcp_hdr_opts_len, flags,
 965                                          clib_host_to_net_u16 (wnd));
 966 }
 967
 968 #endif /* _vnet_tcp_h_ */
 969
 970 /*
 971  * fd.io coding-style-patch-verification: ON
 972  *
 973  * Local Variables:
 974  * eval: (c-set-style "gnu")
 975  * End:
 976  */