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