src/vnet/tcp/tcp.h

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