src/vnet/session/session.h

   1 /*
   2  * Copyright (c) 2017 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 #ifndef __included_session_h__
  16 #define __included_session_h__
  17
  18 #include <vnet/session/stream_session.h>
  19 #include <vnet/session/session_lookup.h>
  20 #include <vnet/session/transport_interface.h>
  21 #include <vnet/session/session_debug.h>
  22 #include <vnet/session/segment_manager.h>
  23 #include <svm/queue.h>
  24
  25 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
  26 #define INVALID_INDEX ((u32)~0)
  27 #define SESSION_PROXY_LISTENER_INDEX ((u32)~0 - 1)
  28 #define SESSION_LOCAL_HANDLE_PREFIX 0x7FFFFFFF
  29
  30 /* TODO decide how much since we have pre-data as well */
  31 #define MAX_HDRS_LEN    100     /* Max number of bytes for headers */
  32
  33 typedef enum
  34 {
  35   FIFO_EVENT_APP_RX,
  36   FIFO_EVENT_APP_TX,
  37   FIFO_EVENT_TIMEOUT,
  38   FIFO_EVENT_DISCONNECT,
  39   FIFO_EVENT_BUILTIN_RX,
  40   FIFO_EVENT_RPC,
  41 } fifo_event_type_t;
  42
  43 static inline const char *
  44 fifo_event_type_str (fifo_event_type_t et)
  45 {
  46   switch (et)
  47     {
  48     case FIFO_EVENT_APP_RX:
  49       return "FIFO_EVENT_APP_RX";
  50     case FIFO_EVENT_APP_TX:
  51       return "FIFO_EVENT_APP_TX";
  52     case FIFO_EVENT_TIMEOUT:
  53       return "FIFO_EVENT_TIMEOUT";
  54     case FIFO_EVENT_DISCONNECT:
  55       return "FIFO_EVENT_DISCONNECT";
  56     case FIFO_EVENT_BUILTIN_RX:
  57       return "FIFO_EVENT_BUILTIN_RX";
  58     case FIFO_EVENT_RPC:
  59       return "FIFO_EVENT_RPC";
  60     default:
  61       return "UNKNOWN FIFO EVENT";
  62     }
  63 }
  64
  65 #define foreach_session_input_error                                     \
  66 _(NO_SESSION, "No session drops")                                       \
  67 _(NO_LISTENER, "No listener for dst port drops")                        \
  68 _(ENQUEUED, "Packets pushed into rx fifo")                              \
  69 _(NOT_READY, "Session not ready packets")                               \
  70 _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
  71 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
  72 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
  73 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair")   \
  74 _(NO_SPACE, "Couldn't allocate a fifo pair")                            \
  75 _(SEG_CREATE, "Couldn't create a new segment")
  76
  77 typedef enum
  78 {
  79 #define _(sym,str) SESSION_ERROR_##sym,
  80   foreach_session_input_error
  81 #undef _
  82     SESSION_N_ERROR,
  83 } session_error_t;
  84
  85 typedef struct
  86 {
  87   void *fp;
  88   void *arg;
  89 } rpc_args_t;
  90
  91 typedef u64 session_handle_t;
  92
  93 /* *INDENT-OFF* */
  94 typedef CLIB_PACKED (struct {
  95   union
  96     {
  97       svm_fifo_t * fifo;
  98       session_handle_t session_handle;
  99       rpc_args_t rpc_args;
 100     };
 101   u8 event_type;
 102   u8 postponed;
 103 }) session_fifo_event_t;
 104 /* *INDENT-ON* */
 105
 106 /* Forward definition */
 107 typedef struct _session_manager_main session_manager_main_t;
 108
 109 typedef int
 110   (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
 111                         session_manager_main_t * smm,
 112                         session_fifo_event_t * e0, stream_session_t * s0,
 113                         u32 thread_index, int *n_tx_pkts);
 114
 115 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
 116 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
 117 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
 118
 119 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_fifo_event_t * e);
 120
 121 struct _session_manager_main
 122 {
 123   /** Per worker thread session pools */
 124   stream_session_t **sessions;
 125
 126   /** Per worker-thread session pool peekers rw locks */
 127   clib_rwlock_t *peekers_rw_locks;
 128
 129   /** Per-proto, per-worker enqueue epoch counters */
 130   u32 *current_enqueue_epoch[TRANSPORT_N_PROTO];
 131
 132   /** Per-proto, per-worker thread vector of sessions to enqueue */
 133   u32 **session_to_enqueue[TRANSPORT_N_PROTO];
 134
 135   /** per-worker tx buffer free lists */
 136   u32 **tx_buffers;
 137
 138   /** Per worker-thread vector of partially read events */
 139   session_fifo_event_t **free_event_vector;
 140
 141   /** per-worker active event vectors */
 142   session_fifo_event_t **pending_event_vector;
 143
 144   /** per-worker postponed disconnects */
 145   session_fifo_event_t **pending_disconnects;
 146
 147   /** vpp fifo event queue */
 148   svm_queue_t **vpp_event_queues;
 149
 150   /** Event queues memfd segment initialized only if so configured */
 151   ssvm_private_t evt_qs_segment;
 152
 153   /** Unique segment name counter */
 154   u32 unique_segment_name_counter;
 155
 156   /** Per transport rx function that can either dequeue or peek */
 157   session_fifo_rx_fn **session_tx_fns;
 158
 159   /** Per session type output nodes. Could optimize to group nodes by
 160    * fib but lookup would then require session type parsing in session node.
 161    * Trade memory for speed, for now */
 162   u32 *session_type_to_next;
 163
 164   /** Session manager is enabled */
 165   u8 is_enabled;
 166
 167   /** vpp fifo event queue configured length */
 168   u32 configured_event_queue_length;
 169
 170   /*
 171    * Config parameters
 172    */
 173
 174   /** Session ssvm segment configs*/
 175   uword session_baseva;
 176   uword session_va_space_size;
 177   u32 evt_qs_segment_size;
 178   u8 evt_qs_use_memfd_seg;
 179
 180   /** Session table size parameters */
 181   u32 configured_v4_session_table_buckets;
 182   u32 configured_v4_session_table_memory;
 183   u32 configured_v4_halfopen_table_buckets;
 184   u32 configured_v4_halfopen_table_memory;
 185   u32 configured_v6_session_table_buckets;
 186   u32 configured_v6_session_table_memory;
 187   u32 configured_v6_halfopen_table_buckets;
 188   u32 configured_v6_halfopen_table_memory;
 189
 190   /** Transport table (preallocation) size parameters */
 191   u32 local_endpoints_table_memory;
 192   u32 local_endpoints_table_buckets;
 193
 194   /** Preallocate session config parameter */
 195   u32 preallocated_sessions;
 196
 197 #if SESSION_DEBUG
 198   /**
 199    * last event poll time by thread
 200    * Debug only. Will cause false cache-line sharing as-is
 201    */
 202   f64 *last_event_poll_by_thread;
 203 #endif
 204
 205 };
 206
 207 typedef struct session_dgram_pre_hdr_
 208 {
 209   u32 data_length;
 210   u32 data_offset;
 211 } session_dgram_pre_hdr_t;
 212
 213 /* *INDENT-OFF* */
 214 typedef CLIB_PACKED (struct session_dgram_header_
 215 {
 216   u32 data_length;
 217   u32 data_offset;
 218   ip46_address_t rmt_ip;
 219   ip46_address_t lcl_ip;
 220   u16 rmt_port;
 221   u16 lcl_port;
 222   u8 is_ip4;
 223 }) session_dgram_hdr_t;
 224 /* *INDENT-ON* */
 225
 226 #define SESSION_CONN_ID_LEN 37
 227 #define SESSION_CONN_HDR_LEN 45
 228
 229 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
 230                "session conn id wrong length");
 231
 232 extern session_manager_main_t session_manager_main;
 233 extern vlib_node_registration_t session_queue_node;
 234
 235 /*
 236  * Session manager function
 237  */
 238 always_inline session_manager_main_t *
 239 vnet_get_session_manager_main ()
 240 {
 241   return &session_manager_main;
 242 }
 243
 244 always_inline u8
 245 stream_session_is_valid (u32 si, u8 thread_index)
 246 {
 247   stream_session_t *s;
 248   s = pool_elt_at_index (session_manager_main.sessions[thread_index], si);
 249   if (s->thread_index != thread_index || s->session_index != si
 250       /* || s->server_rx_fifo->master_session_index != si
 251          || s->server_tx_fifo->master_session_index != si
 252          || s->server_rx_fifo->master_thread_index != thread_index
 253          || s->server_tx_fifo->master_thread_index != thread_index */ )
 254     return 0;
 255   return 1;
 256 }
 257
 258 stream_session_t *session_alloc (u32 thread_index);
 259 int session_alloc_fifos (segment_manager_t * sm, stream_session_t * s);
 260 void session_free (stream_session_t * s);
 261
 262 always_inline stream_session_t *
 263 session_get (u32 si, u32 thread_index)
 264 {
 265   ASSERT (stream_session_is_valid (si, thread_index));
 266   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
 267 }
 268
 269 always_inline stream_session_t *
 270 session_get_if_valid (u64 si, u32 thread_index)
 271 {
 272   if (thread_index >= vec_len (session_manager_main.sessions))
 273     return 0;
 274
 275   if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
 276     return 0;
 277
 278   ASSERT (stream_session_is_valid (si, thread_index));
 279   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
 280 }
 281
 282 always_inline session_handle_t
 283 session_handle (stream_session_t * s)
 284 {
 285   return ((u64) s->thread_index << 32) | (u64) s->session_index;
 286 }
 287
 288 always_inline u32
 289 session_index_from_handle (session_handle_t handle)
 290 {
 291   return handle & 0xFFFFFFFF;
 292 }
 293
 294 always_inline u32
 295 session_thread_from_handle (session_handle_t handle)
 296 {
 297   return handle >> 32;
 298 }
 299
 300 always_inline void
 301 session_parse_handle (session_handle_t handle, u32 * index,
 302                       u32 * thread_index)
 303 {
 304   *index = session_index_from_handle (handle);
 305   *thread_index = session_thread_from_handle (handle);
 306 }
 307
 308 always_inline stream_session_t *
 309 session_get_from_handle (session_handle_t handle)
 310 {
 311   session_manager_main_t *smm = &session_manager_main;
 312   u32 session_index, thread_index;
 313   session_parse_handle (handle, &session_index, &thread_index);
 314   return pool_elt_at_index (smm->sessions[thread_index], session_index);
 315 }
 316
 317 always_inline stream_session_t *
 318 session_get_from_handle_if_valid (session_handle_t handle)
 319 {
 320   u32 session_index, thread_index;
 321   session_parse_handle (handle, &session_index, &thread_index);
 322   return session_get_if_valid (session_index, thread_index);
 323 }
 324
 325 always_inline u8
 326 session_handle_is_local (session_handle_t handle)
 327 {
 328   if ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX)
 329     return 1;
 330   return 0;
 331 }
 332
 333 always_inline transport_proto_t
 334 session_type_transport_proto (session_type_t st)
 335 {
 336   return (st >> 1);
 337 }
 338
 339 always_inline u8
 340 session_type_is_ip4 (session_type_t st)
 341 {
 342   return (st & 1);
 343 }
 344
 345 always_inline transport_proto_t
 346 session_get_transport_proto (stream_session_t * s)
 347 {
 348   return (s->session_type >> 1);
 349 }
 350
 351 always_inline fib_protocol_t
 352 session_get_fib_proto (stream_session_t * s)
 353 {
 354   u8 is_ip4 = s->session_type & 1;
 355   return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
 356 }
 357
 358 always_inline session_type_t
 359 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
 360 {
 361   return (proto << 1 | is_ip4);
 362 }
 363
 364 always_inline u8
 365 session_has_transport (stream_session_t * s)
 366 {
 367   return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
 368 }
 369
 370 always_inline transport_service_type_t
 371 session_transport_service_type (stream_session_t * s)
 372 {
 373   transport_proto_t tp;
 374   tp = session_get_transport_proto (s);
 375   return transport_protocol_service_type (tp);
 376 }
 377
 378 /**
 379  * Acquires a lock that blocks a session pool from expanding.
 380  *
 381  * This is typically used for safely peeking into other threads'
 382  * pools in order to clone elements. Lock should be dropped as soon
 383  * as possible by calling @ref session_pool_remove_peeker.
 384  *
 385  * NOTE: Avoid using pool_elt_at_index while the lock is held because
 386  * it may lead to free elt bitmap expansion/contraction!
 387  */
 388 always_inline void
 389 session_pool_add_peeker (u32 thread_index)
 390 {
 391   session_manager_main_t *smm = &session_manager_main;
 392   if (thread_index == vlib_get_thread_index ())
 393     return;
 394   clib_rwlock_reader_lock (&smm->peekers_rw_locks[thread_index]);
 395 }
 396
 397 always_inline void
 398 session_pool_remove_peeker (u32 thread_index)
 399 {
 400   session_manager_main_t *smm = &session_manager_main;
 401   if (thread_index == vlib_get_thread_index ())
 402     return;
 403   clib_rwlock_reader_unlock (&smm->peekers_rw_locks[thread_index]);
 404 }
 405
 406 /**
 407  * Get session from handle and 'lock' pool resize if not in same thread
 408  *
 409  * Caller should drop the peek 'lock' as soon as possible.
 410  */
 411 always_inline stream_session_t *
 412 session_get_from_handle_safe (u64 handle)
 413 {
 414   session_manager_main_t *smm = &session_manager_main;
 415   u32 thread_index = session_thread_from_handle (handle);
 416   if (thread_index == vlib_get_thread_index ())
 417     {
 418       return pool_elt_at_index (smm->sessions[thread_index],
 419                                 session_index_from_handle (handle));
 420     }
 421   else
 422     {
 423       session_pool_add_peeker (thread_index);
 424       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
 425       return smm->sessions[thread_index] + session_index_from_handle (handle);
 426     }
 427 }
 428
 429 always_inline u32
 430 stream_session_max_rx_enqueue (transport_connection_t * tc)
 431 {
 432   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 433   return svm_fifo_max_enqueue (s->server_rx_fifo);
 434 }
 435
 436 always_inline u32
 437 stream_session_rx_fifo_size (transport_connection_t * tc)
 438 {
 439   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 440   return s->server_rx_fifo->nitems;
 441 }
 442
 443 always_inline u32
 444 session_get_index (stream_session_t * s)
 445 {
 446   return (s - session_manager_main.sessions[s->thread_index]);
 447 }
 448
 449 always_inline stream_session_t *
 450 session_clone_safe (u32 session_index, u32 thread_index)
 451 {
 452   stream_session_t *old_s, *new_s;
 453   u32 current_thread_index = vlib_get_thread_index ();
 454
 455   /* If during the memcpy pool is reallocated AND the memory allocator
 456    * decides to give the old chunk of memory to somebody in a hurry to
 457    * scribble something on it, we have a problem. So add this thread as
 458    * a session pool peeker.
 459    */
 460   session_pool_add_peeker (thread_index);
 461   new_s = session_alloc (current_thread_index);
 462   old_s = session_manager_main.sessions[thread_index] + session_index;
 463   clib_memcpy (new_s, old_s, sizeof (*new_s));
 464   session_pool_remove_peeker (thread_index);
 465   new_s->thread_index = current_thread_index;
 466   new_s->session_index = session_get_index (new_s);
 467   return new_s;
 468 }
 469
 470 transport_connection_t *session_get_transport (stream_session_t * s);
 471
 472 u32 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc);
 473
 474 int
 475 session_enqueue_stream_connection (transport_connection_t * tc,
 476                                    vlib_buffer_t * b, u32 offset,
 477                                    u8 queue_event, u8 is_in_order);
 478 int session_enqueue_dgram_connection (stream_session_t * s,
 479                                       session_dgram_hdr_t * hdr,
 480                                       vlib_buffer_t * b, u8 proto,
 481                                       u8 queue_event);
 482 int stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
 483                                u32 offset, u32 max_bytes);
 484 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 485
 486 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
 487 int session_dgram_connect_notify (transport_connection_t * tc,
 488                                   u32 old_thread_index,
 489                                   stream_session_t ** new_session);
 490 void stream_session_init_fifos_pointers (transport_connection_t * tc,
 491                                          u32 rx_pointer, u32 tx_pointer);
 492
 493 void stream_session_accept_notify (transport_connection_t * tc);
 494 void stream_session_disconnect_notify (transport_connection_t * tc);
 495 void stream_session_delete_notify (transport_connection_t * tc);
 496 void stream_session_reset_notify (transport_connection_t * tc);
 497 int stream_session_accept (transport_connection_t * tc, u32 listener_index,
 498                            u8 notify);
 499 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
 500 int stream_session_listen (stream_session_t * s, session_endpoint_t * tep);
 501 int stream_session_stop_listen (stream_session_t * s);
 502 void stream_session_disconnect (stream_session_t * s);
 503 void stream_session_disconnect_transport (stream_session_t * s);
 504 void stream_session_cleanup (stream_session_t * s);
 505 void session_send_session_evt_to_thread (u64 session_handle,
 506                                          fifo_event_type_t evt_type,
 507                                          u32 thread_index);
 508 ssvm_private_t *session_manager_get_evt_q_segment (void);
 509
 510 u8 *format_stream_session (u8 * s, va_list * args);
 511 uword unformat_stream_session (unformat_input_t * input, va_list * args);
 512 uword unformat_transport_connection (unformat_input_t * input,
 513                                      va_list * args);
 514
 515 void session_register_transport (transport_proto_t transport_proto,
 516                                  const transport_proto_vft_t * vft, u8 is_ip4,
 517                                  u32 output_node);
 518
 519 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 520
 521 always_inline svm_queue_t *
 522 session_manager_get_vpp_event_queue (u32 thread_index)
 523 {
 524   return session_manager_main.vpp_event_queues[thread_index];
 525 }
 526
 527 int session_manager_flush_enqueue_events (u8 proto, u32 thread_index);
 528 int session_manager_flush_all_enqueue_events (u8 transport_proto);
 529
 530 always_inline u64
 531 listen_session_get_handle (stream_session_t * s)
 532 {
 533   ASSERT (s->session_state == SESSION_STATE_LISTENING);
 534   return session_handle (s);
 535 }
 536
 537 always_inline stream_session_t *
 538 listen_session_get_from_handle (session_handle_t handle)
 539 {
 540   return session_get_from_handle (handle);
 541 }
 542
 543 always_inline void
 544 listen_session_parse_handle (session_handle_t handle, u32 * index,
 545                              u32 * thread_index)
 546 {
 547   session_parse_handle (handle, index, thread_index);
 548 }
 549
 550 always_inline stream_session_t *
 551 listen_session_new (u8 thread_index, session_type_t type)
 552 {
 553   stream_session_t *s;
 554   s = session_alloc (thread_index);
 555   s->session_type = type;
 556   s->session_state = SESSION_STATE_LISTENING;
 557   return s;
 558 }
 559
 560 always_inline stream_session_t *
 561 listen_session_get (u32 index)
 562 {
 563   return session_get (index, 0);
 564 }
 565
 566 always_inline void
 567 listen_session_del (stream_session_t * s)
 568 {
 569   session_free (s);
 570 }
 571
 572 transport_connection_t *listen_session_get_transport (stream_session_t * s);
 573
 574 int
 575 listen_session_get_local_session_endpoint (stream_session_t * listener,
 576                                            session_endpoint_t * sep);
 577
 578 always_inline u8
 579 session_manager_is_enabled ()
 580 {
 581   return session_manager_main.is_enabled == 1;
 582 }
 583
 584 #define session_cli_return_if_not_enabled()                             \
 585 do {                                                                    \
 586     if (!session_manager_main.is_enabled)                               \
 587       return clib_error_return(0, "session layer is not enabled");      \
 588 } while (0)
 589
 590 void session_node_enable_disable (u8 is_en);
 591
 592 #endif /* __included_session_h__ */
 593
 594 /*
 595  * fd.io coding-style-patch-verification: ON
 596  *
 597  * Local Variables:
 598  * eval: (c-set-style "gnu")
 599  * End:
 600  */