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