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