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