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