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