src/vnet/tcp/tcp.h

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