src/vnet/tcp/tcp.h

   1 /*
   2  * Copyright (c) 2016-2019 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef _vnet_tcp_h_
  17 #define _vnet_tcp_h_
  18
  19 #include <vnet/vnet.h>
  20 #include <vnet/ip/ip.h>
  21 #include <vnet/session/session.h>
  22 #include <vnet/tcp/tcp_types.h>
  23 #include <vnet/tcp/tcp_timer.h>
  24 #include <vnet/tcp/tcp_debug.h>
  25 #include <vnet/tcp/tcp_sack.h>
  26 #include <vnet/tcp/tcp_bt.h>
  27 #include <vnet/tcp/tcp_cc.h>
  28
  29 typedef void (timer_expiration_handler) (tcp_connection_t * tc);
  30
  31 extern timer_expiration_handler tcp_timer_retransmit_handler;
  32 extern timer_expiration_handler tcp_timer_persist_handler;
  33 extern timer_expiration_handler tcp_timer_retransmit_syn_handler;
  34
  35 typedef enum _tcp_error
  36 {
  37 #define tcp_error(n,s) TCP_ERROR_##n,
  38 #include <vnet/tcp/tcp_error.def>
  39 #undef tcp_error
  40   TCP_N_ERROR,
  41 } tcp_error_t;
  42
  43 typedef struct _tcp_lookup_dispatch
  44 {
  45   u8 next, error;
  46 } tcp_lookup_dispatch_t;
  47
  48 #define foreach_tcp_wrk_stat                                    \
  49   _(timer_expirations, u64, "timer expirations")                \
  50   _(rxt_segs, u64, "segments retransmitted")                    \
  51   _(tr_events, u32, "timer retransmit events")                  \
  52   _(to_closewait, u32, "timeout close-wait")                    \
  53   _(to_closewait2, u32, "timeout close-wait w/data")            \
  54   _(to_finwait1, u32, "timeout fin-wait-1")                     \
  55   _(to_finwait2, u32, "timeout fin-wait-2")                     \
  56   _(to_lastack, u32, "timeout last-ack")                        \
  57   _(to_closing, u32, "timeout closing")                         \
  58   _(tr_abort, u32, "timer retransmit abort")                    \
  59   _(rst_unread, u32, "reset on close due to unread data")       \
  60   _(no_buffer, u32, "out of buffers")                           \
  61
  62 typedef struct tcp_wrk_stats_
  63 {
  64 #define _(name, type, str) type name;
  65   foreach_tcp_wrk_stat
  66 #undef _
  67 } tcp_wrk_stats_t;
  68
  69 typedef struct tcp_free_req_
  70 {
  71   clib_time_type_t free_time;
  72   u32 connection_index;
  73 } tcp_cleanup_req_t;
  74
  75 typedef struct tcp_worker_ctx_
  76 {
  77   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  78
  79   /** worker's pool of connections */
  80   tcp_connection_t *connections;
  81
  82   /** vector of pending ack dequeues */
  83   u32 *pending_deq_acked;
  84
  85   /** vector of pending disconnect notifications */
  86   u32 *pending_disconnects;
  87
  88   /** vector of pending reset notifications */
  89   u32 *pending_resets;
  90
  91   /** convenience pointer to this thread's vlib main */
  92   vlib_main_t *vm;
  93
  94   /** Time used for high precision (us) measurements in seconds */
  95   f64 time_us;
  96
  97   /** Time measured in @ref TCP_TSTAMP_TICK used for time stamps */
  98   u32 time_tstamp;
  99
 100   /* Max timers to be handled per dispatch loop */
 101   u32 max_timers_per_loop;
 102
 103   /* Fifo of pending timer expirations */
 104   u32 *pending_timers;
 105
 106     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 107
 108   /** cached 'on the wire' options for bursts */
 109   u8 cached_opts[40];
 110
 111   /** tx buffer free list */
 112   u32 *tx_buffers;
 113
 114   /* fifo of pending free requests */
 115   tcp_cleanup_req_t *pending_cleanups;
 116
 117   /** Session layer edge indices to tcp output */
 118   u32 tco_next_node[2];
 119
 120   /** worker timer wheel */
 121   tcp_timer_wheel_t timer_wheel;
 122
 123     CLIB_CACHE_LINE_ALIGN_MARK (cacheline2);
 124
 125   tcp_wrk_stats_t stats;
 126 } tcp_worker_ctx_t;
 127
 128 #define tcp_worker_stats_inc(_wrk,_stat,_val)           \
 129   _wrk->stats._stat += _val
 130
 131 typedef struct tcp_iss_seed_
 132 {
 133   u64 first;
 134   u64 second;
 135 } tcp_iss_seed_t;
 136
 137 typedef struct tcp_configuration_
 138 {
 139   /** Max rx fifo size for a session (in bytes). It is used in to compute the
 140    *  rfc 7323 window scaling factor */
 141   u32 max_rx_fifo;
 142
 143   /** Min rx fifo for a session (in bytes) */
 144   u32 min_rx_fifo;
 145
 146   /** Default MTU to be used when establishing connections */
 147   u16 default_mtu;
 148
 149   /** Initial CWND multiplier, which multiplies MSS to determine initial CWND.
 150    *  Set 0 to determine the initial CWND by another way */
 151   u16 initial_cwnd_multiplier;
 152
 153   /** Enable tx pacing for new connections */
 154   u8 enable_tx_pacing;
 155
 156   /** Allow use of TSO whenever available */
 157   u8 allow_tso;
 158
 159   /** Set if csum offloading is enabled */
 160   u8 csum_offload;
 161
 162   /** Default congestion control algorithm type */
 163   tcp_cc_algorithm_type_e cc_algo;
 164
 165   /** Min rwnd, as number of snd_mss segments, for update ack to be sent after
 166    * a zero rwnd advertisement */
 167   u32 rwnd_min_update_ack;
 168
 169   /** Timer ticks to wait for close from app */
 170   u32 closewait_time;
 171
 172   /** Timer ticks to wait in time-wait. Also known as 2MSL */
 173   u32 timewait_time;
 174
 175   /** Timer ticks to wait in fin-wait1 to send fin and rcv fin-ack */
 176   u32 finwait1_time;
 177
 178   /** Timer ticks to wait in last ack for ack */
 179   u32 lastack_time;
 180
 181   /** Timer ticks to wait in fin-wait2 for fin */
 182   u32 finwait2_time;
 183
 184   /** Timer ticks to wait in closing for fin ack */
 185   u32 closing_time;
 186
 187   /** Time to wait (sec) before cleaning up the connection */
 188   f32 cleanup_time;
 189
 190   /** Number of preallocated connections */
 191   u32 preallocated_connections;
 192
 193   /** Number of preallocated half-open connections */
 194   u32 preallocated_half_open_connections;
 195
 196   /** Maxium allowed GSO packet size */
 197   u32 max_gso_size;
 198
 199   /** Vectors of src addresses. Optional unless one needs > 63K active-opens */
 200   ip4_address_t *ip4_src_addrs;
 201   ip6_address_t *ip6_src_addrs;
 202
 203   /** Fault-injection. Debug only */
 204   f64 buffer_fail_fraction;
 205 } tcp_configuration_t;
 206
 207 typedef struct _tcp_main
 208 {
 209   /** per-worker context */
 210   tcp_worker_ctx_t *wrk_ctx;
 211
 212   /* Pool of listeners. */
 213   tcp_connection_t *listener_pool;
 214
 215   /** vlib buffer size */
 216   u32 bytes_per_buffer;
 217
 218   /** Session layer edge indices to ip lookup (syns, rst) */
 219   u32 ipl_next_node[2];
 220
 221   /** Dispatch table by state and flags */
 222   tcp_lookup_dispatch_t dispatch_table[TCP_N_STATES][64];
 223
 224   clib_spinlock_t half_open_lock;
 225
 226   /** Pool of half-open connections on which we've sent a SYN */
 227   tcp_connection_t *half_open_connections;
 228
 229   /** Seed used to generate random iss */
 230   tcp_iss_seed_t iss_seed;
 231
 232   /** Congestion control algorithms registered */
 233   tcp_cc_algorithm_t *cc_algos;
 234
 235   /** Hash table of cc algorithms by name */
 236   uword *cc_algo_by_name;
 237
 238   /** Last cc algo registered */
 239   tcp_cc_algorithm_type_e cc_last_type;
 240
 241   /** Flag that indicates if stack is on or off */
 242   u8 is_enabled;
 243
 244   /** Flag that indicates if v4 punting is enabled */
 245   u8 punt_unknown4;
 246
 247   /** Flag that indicates if v6 punting is enabled */
 248   u8 punt_unknown6;
 249
 250   /** Rotor for v4 source addresses */
 251   u32 last_v4_addr_rotor;
 252
 253   /** Rotor for v6 source addresses */
 254   u32 last_v6_addr_rotor;
 255
 256   /** Protocol configuration */
 257   tcp_configuration_t cfg;
 258 } tcp_main_t;
 259
 260 extern tcp_main_t tcp_main;
 261 extern vlib_node_registration_t tcp4_input_node;
 262 extern vlib_node_registration_t tcp6_input_node;
 263 extern vlib_node_registration_t tcp4_output_node;
 264 extern vlib_node_registration_t tcp6_output_node;
 265 extern vlib_node_registration_t tcp4_established_node;
 266 extern vlib_node_registration_t tcp6_established_node;
 267 extern vlib_node_registration_t tcp4_syn_sent_node;
 268 extern vlib_node_registration_t tcp6_syn_sent_node;
 269 extern vlib_node_registration_t tcp4_rcv_process_node;
 270 extern vlib_node_registration_t tcp6_rcv_process_node;
 271 extern vlib_node_registration_t tcp4_listen_node;
 272 extern vlib_node_registration_t tcp6_listen_node;
 273
 274 #define tcp_cfg tcp_main.cfg
 275 #define tcp_node_index(node_id, is_ip4)                                 \
 276   ((is_ip4) ? tcp4_##node_id##_node.index : tcp6_##node_id##_node.index)
 277
 278 always_inline tcp_main_t *
 279 vnet_get_tcp_main ()
 280 {
 281   return &tcp_main;
 282 }
 283
 284 always_inline tcp_worker_ctx_t *
 285 tcp_get_worker (u32 thread_index)
 286 {
 287   ASSERT (thread_index < vec_len (tcp_main.wrk_ctx));
 288   return &tcp_main.wrk_ctx[thread_index];
 289 }
 290
 291 #if (VLIB_BUFFER_TRACE_TRAJECTORY)
 292 #define tcp_trajectory_add_start(b, start)                      \
 293 {                                                               \
 294     (*vlib_buffer_trace_trajectory_cb) (b, start);              \
 295 }
 296 #else
 297 #define tcp_trajectory_add_start(b, start)
 298 #endif
 299
 300 tcp_connection_t *tcp_connection_alloc (u8 thread_index);
 301 tcp_connection_t *tcp_connection_alloc_w_base (u8 thread_index,
 302                                                tcp_connection_t * base);
 303 void tcp_connection_free (tcp_connection_t * tc);
 304 void tcp_connection_close (tcp_connection_t * tc);
 305 void tcp_connection_cleanup (tcp_connection_t * tc);
 306 void tcp_connection_del (tcp_connection_t * tc);
 307 int tcp_half_open_connection_cleanup (tcp_connection_t * tc);
 308
 309 void tcp_send_reset_w_pkt (tcp_connection_t * tc, vlib_buffer_t * pkt,
 310                            u32 thread_index, u8 is_ip4);
 311 void tcp_send_reset (tcp_connection_t * tc);
 312 void tcp_send_syn (tcp_connection_t * tc);
 313 void tcp_send_synack (tcp_connection_t * tc);
 314 void tcp_send_fin (tcp_connection_t * tc);
 315 void tcp_send_ack (tcp_connection_t * tc);
 316 void tcp_send_window_update_ack (tcp_connection_t * tc);
 317
 318 void tcp_program_ack (tcp_connection_t * tc);
 319 void tcp_program_dupack (tcp_connection_t * tc);
 320 void tcp_program_retransmit (tcp_connection_t * tc);
 321
 322 void tcp_update_burst_snd_vars (tcp_connection_t * tc);
 323 u32 tcp_snd_space (tcp_connection_t * tc);
 324 int tcp_fastrecovery_prr_snd_space (tcp_connection_t * tc);
 325 void tcp_reschedule (tcp_connection_t * tc);
 326 fib_node_index_t tcp_lookup_rmt_in_fib (tcp_connection_t * tc);
 327 u32 tcp_session_push_header (transport_connection_t * tconn,
 328                              vlib_buffer_t * b);
 329 int tcp_session_custom_tx (void *conn, transport_send_params_t * sp);
 330
 331 void tcp_connection_timers_init (tcp_connection_t * tc);
 332 void tcp_connection_timers_reset (tcp_connection_t * tc);
 333 void tcp_init_snd_vars (tcp_connection_t * tc);
 334 void tcp_connection_init_vars (tcp_connection_t * tc);
 335 void tcp_connection_tx_pacer_update (tcp_connection_t * tc);
 336 void tcp_connection_tx_pacer_reset (tcp_connection_t * tc, u32 window,
 337                                     u32 start_bucket);
 338 void tcp_program_cleanup (tcp_worker_ctx_t * wrk, tcp_connection_t * tc);
 339 void tcp_check_gso (tcp_connection_t *tc);
 340
 341 void tcp_punt_unknown (vlib_main_t * vm, u8 is_ip4, u8 is_add);
 342 int tcp_configure_v4_source_address_range (vlib_main_t * vm,
 343                                            ip4_address_t * start,
 344                                            ip4_address_t * end, u32 table_id);
 345 int tcp_configure_v6_source_address_range (vlib_main_t * vm,
 346                                            ip6_address_t * start,
 347                                            ip6_address_t * end, u32 table_id);
 348
 349 clib_error_t *vnet_tcp_enable_disable (vlib_main_t * vm, u8 is_en);
 350
 351 format_function_t format_tcp_state;
 352 format_function_t format_tcp_flags;
 353 format_function_t format_tcp_sacks;
 354 format_function_t format_tcp_rcv_sacks;
 355 format_function_t format_tcp_connection;
 356 format_function_t format_tcp_connection_id;
 357
 358 #define tcp_validate_txf_size(_tc, _a)                                  \
 359   ASSERT(_tc->state != TCP_STATE_ESTABLISHED                            \
 360          || transport_max_tx_dequeue (&_tc->connection) >= _a)
 361
 362 #endif /* _vnet_tcp_h_ */
 363
 364 /*
 365  * fd.io coding-style-patch-verification: ON
 366  *
 367  * Local Variables:
 368  * eval: (c-set-style "gnu")
 369  * End:
 370  */