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 <vlibmemory/unix_shared_memory_queue.h>
  22 #include <vnet/session/session_debug.h>
  23 #include <vnet/session/segment_manager.h>
  24
  25 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
  26 #define INVALID_INDEX ((u32)~0)
  27
  28 /* TODO decide how much since we have pre-data as well */
  29 #define MAX_HDRS_LEN    100     /* Max number of bytes for headers */
  30
  31 typedef enum
  32 {
  33   FIFO_EVENT_APP_RX,
  34   FIFO_EVENT_APP_TX,
  35   FIFO_EVENT_TIMEOUT,
  36   FIFO_EVENT_DISCONNECT,
  37   FIFO_EVENT_BUILTIN_RX,
  38   FIFO_EVENT_RPC,
  39 } fifo_event_type_t;
  40
  41 static inline const char *
  42 fifo_event_type_str (fifo_event_type_t et)
  43 {
  44   switch (et)
  45     {
  46     case FIFO_EVENT_APP_RX:
  47       return "FIFO_EVENT_APP_RX";
  48     case FIFO_EVENT_APP_TX:
  49       return "FIFO_EVENT_APP_TX";
  50     case FIFO_EVENT_TIMEOUT:
  51       return "FIFO_EVENT_TIMEOUT";
  52     case FIFO_EVENT_DISCONNECT:
  53       return "FIFO_EVENT_DISCONNECT";
  54     case FIFO_EVENT_BUILTIN_RX:
  55       return "FIFO_EVENT_BUILTIN_RX";
  56     case FIFO_EVENT_RPC:
  57       return "FIFO_EVENT_RPC";
  58     default:
  59       return "UNKNOWN FIFO EVENT";
  60     }
  61 }
  62
  63 #define foreach_session_input_error                                     \
  64 _(NO_SESSION, "No session drops")                                       \
  65 _(NO_LISTENER, "No listener for dst port drops")                        \
  66 _(ENQUEUED, "Packets pushed into rx fifo")                              \
  67 _(NOT_READY, "Session not ready packets")                               \
  68 _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
  69 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
  70 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
  71 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair")   \
  72 _(NO_SPACE, "Couldn't allocate a fifo pair")
  73
  74 typedef enum
  75 {
  76 #define _(sym,str) SESSION_ERROR_##sym,
  77   foreach_session_input_error
  78 #undef _
  79     SESSION_N_ERROR,
  80 } session_error_t;
  81
  82 /* Event queue input node static next indices */
  83 typedef enum
  84 {
  85   SESSION_QUEUE_NEXT_DROP,
  86   SESSION_QUEUE_NEXT_TCP_IP4_OUTPUT,
  87   SESSION_QUEUE_NEXT_IP4_LOOKUP,
  88   SESSION_QUEUE_NEXT_TCP_IP6_OUTPUT,
  89   SESSION_QUEUE_NEXT_IP6_LOOKUP,
  90   SESSION_QUEUE_N_NEXT,
  91 } session_queue_next_t;
  92
  93 typedef struct
  94 {
  95   void *fp;
  96   void *arg;
  97 } rpc_args_t;
  98
  99 /* *INDENT-OFF* */
 100 typedef CLIB_PACKED (struct {
 101   union
 102     {
 103       svm_fifo_t * fifo;
 104       u64 session_handle;
 105       rpc_args_t rpc_args;
 106     };
 107   u8 event_type;
 108   u16 event_id;
 109 }) session_fifo_event_t;
 110 /* *INDENT-ON* */
 111
 112 /* Forward definition */
 113 typedef struct _session_manager_main session_manager_main_t;
 114
 115 typedef int
 116   (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
 117                         session_manager_main_t * smm,
 118                         session_fifo_event_t * e0, stream_session_t * s0,
 119                         u32 thread_index, int *n_tx_pkts);
 120
 121 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
 122 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
 123
 124 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_fifo_event_t * e);
 125
 126 struct _session_manager_main
 127 {
 128   /** Per worker thread session pools */
 129   stream_session_t **sessions;
 130
 131   /** Pool of listen sessions. Same type as stream sessions to ease lookups */
 132   stream_session_t *listen_sessions[SESSION_N_TYPES];
 133
 134   /** Sparse vector to map dst port to stream server  */
 135   u16 *stream_server_by_dst_port[SESSION_N_TYPES];
 136
 137   /** per-worker enqueue epoch counters */
 138   u8 *current_enqueue_epoch;
 139
 140   /** Per-worker thread vector of sessions to enqueue */
 141   u32 **session_indices_to_enqueue_by_thread;
 142
 143   /** per-worker tx buffer free lists */
 144   u32 **tx_buffers;
 145
 146   /** Per worker-thread vector of partially read events */
 147   session_fifo_event_t **free_event_vector;
 148
 149   /** per-worker active event vectors */
 150   session_fifo_event_t **pending_event_vector;
 151
 152   /** vpp fifo event queue */
 153   unix_shared_memory_queue_t **vpp_event_queues;
 154
 155   /** vpp fifo event queue configured length */
 156   u32 configured_event_queue_length;
 157
 158   /** session table size parameters */
 159   u32 configured_v4_session_table_buckets;
 160   u32 configured_v4_session_table_memory;
 161   u32 configured_v4_halfopen_table_buckets;
 162   u32 configured_v4_halfopen_table_memory;
 163   u32 configured_v6_session_table_buckets;
 164   u32 configured_v6_session_table_memory;
 165   u32 configured_v6_halfopen_table_buckets;
 166   u32 configured_v6_halfopen_table_memory;
 167
 168   /** Unique segment name counter */
 169   u32 unique_segment_name_counter;
 170
 171   /** Per transport rx function that can either dequeue or peek */
 172   session_fifo_rx_fn *session_tx_fns[SESSION_N_TYPES];
 173
 174   /** Session manager is enabled */
 175   u8 is_enabled;
 176
 177   /** Preallocate session config parameter */
 178   u32 preallocated_sessions;
 179
 180 #if SESSION_DBG
 181   /**
 182    * last event poll time by thread
 183    * Debug only. Will cause false cache-line sharing as-is
 184    */
 185   f64 *last_event_poll_by_thread;
 186 #endif
 187
 188 };
 189
 190 extern session_manager_main_t session_manager_main;
 191 extern vlib_node_registration_t session_queue_node;
 192
 193 /*
 194  * Session manager function
 195  */
 196 always_inline session_manager_main_t *
 197 vnet_get_session_manager_main ()
 198 {
 199   return &session_manager_main;
 200 }
 201
 202 always_inline u8
 203 stream_session_is_valid (u32 si, u8 thread_index)
 204 {
 205   stream_session_t *s;
 206   s = pool_elt_at_index (session_manager_main.sessions[thread_index], si);
 207   if (s->thread_index != thread_index || s->session_index != si
 208       /* || s->server_rx_fifo->master_session_index != si
 209          || s->server_tx_fifo->master_session_index != si
 210          || s->server_rx_fifo->master_thread_index != thread_index
 211          || s->server_tx_fifo->master_thread_index != thread_index */ )
 212     return 0;
 213   return 1;
 214 }
 215
 216 always_inline stream_session_t *
 217 session_get (u32 si, u32 thread_index)
 218 {
 219   ASSERT (stream_session_is_valid (si, thread_index));
 220   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
 221 }
 222
 223 always_inline stream_session_t *
 224 stream_session_get_if_valid (u64 si, u32 thread_index)
 225 {
 226   if (thread_index >= vec_len (session_manager_main.sessions))
 227     return 0;
 228
 229   if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
 230     return 0;
 231
 232   ASSERT (stream_session_is_valid (si, thread_index));
 233   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
 234 }
 235
 236 always_inline u64
 237 stream_session_handle (stream_session_t * s)
 238 {
 239   return ((u64) s->thread_index << 32) | (u64) s->session_index;
 240 }
 241
 242 always_inline u32
 243 session_index_from_handle (u64 handle)
 244 {
 245   return handle & 0xFFFFFFFF;
 246 }
 247
 248 always_inline u32
 249 session_thread_from_handle (u64 handle)
 250 {
 251   return handle >> 32;
 252 }
 253
 254 always_inline void
 255 session_parse_handle (u64 handle, u32 * index, u32 * thread_index)
 256 {
 257   *index = session_index_from_handle (handle);
 258   *thread_index = session_thread_from_handle (handle);
 259 }
 260
 261 always_inline stream_session_t *
 262 session_get_from_handle (u64 handle)
 263 {
 264   session_manager_main_t *smm = &session_manager_main;
 265   return
 266     pool_elt_at_index (smm->sessions[session_thread_from_handle (handle)],
 267                        session_index_from_handle (handle));
 268 }
 269
 270 always_inline stream_session_t *
 271 stream_session_listener_get (u8 sst, u64 si)
 272 {
 273   return pool_elt_at_index (session_manager_main.listen_sessions[sst], si);
 274 }
 275
 276 always_inline u32
 277 stream_session_get_index (stream_session_t * s)
 278 {
 279   if (s->session_state == SESSION_STATE_LISTENING)
 280     return s - session_manager_main.listen_sessions[s->session_type];
 281
 282   return s - session_manager_main.sessions[s->thread_index];
 283 }
 284
 285 always_inline u32
 286 stream_session_max_rx_enqueue (transport_connection_t * tc)
 287 {
 288   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 289   return svm_fifo_max_enqueue (s->server_rx_fifo);
 290 }
 291
 292 always_inline u32
 293 stream_session_rx_fifo_size (transport_connection_t * tc)
 294 {
 295   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
 296   return s->server_rx_fifo->nitems;
 297 }
 298
 299 u32 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc);
 300
 301 int
 302 stream_session_enqueue_data (transport_connection_t * tc, vlib_buffer_t * b,
 303                              u32 offset, u8 queue_event, u8 is_in_order);
 304 int
 305 stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
 306                            u32 offset, u32 max_bytes);
 307 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 308
 309 int stream_session_connect_notify (transport_connection_t * tc, u8 is_fail);
 310 void stream_session_init_fifos_pointers (transport_connection_t * tc,
 311                                          u32 rx_pointer, u32 tx_pointer);
 312
 313 void stream_session_accept_notify (transport_connection_t * tc);
 314 void stream_session_disconnect_notify (transport_connection_t * tc);
 315 void stream_session_delete_notify (transport_connection_t * tc);
 316 void stream_session_reset_notify (transport_connection_t * tc);
 317 int
 318 stream_session_accept (transport_connection_t * tc, u32 listener_index,
 319                        u8 notify);
 320 int
 321 stream_session_open (u32 app_index, session_endpoint_t * tep,
 322                      transport_connection_t ** tc);
 323 int stream_session_listen (stream_session_t * s, session_endpoint_t * tep);
 324 int stream_session_stop_listen (stream_session_t * s);
 325 void stream_session_disconnect (stream_session_t * s);
 326 void stream_session_cleanup (stream_session_t * s);
 327 void session_send_session_evt_to_thread (u64 session_handle,
 328                                          fifo_event_type_t evt_type,
 329                                          u32 thread_index);
 330
 331 u8 *format_stream_session (u8 * s, va_list * args);
 332 uword unformat_stream_session (unformat_input_t * input, va_list * args);
 333 uword unformat_transport_connection (unformat_input_t * input,
 334                                      va_list * args);
 335
 336 int
 337 send_session_connected_callback (u32 app_index, u32 api_context,
 338                                  stream_session_t * s, u8 is_fail);
 339
 340
 341 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 342
 343 always_inline unix_shared_memory_queue_t *
 344 session_manager_get_vpp_event_queue (u32 thread_index)
 345 {
 346   return session_manager_main.vpp_event_queues[thread_index];
 347 }
 348
 349 int session_manager_flush_enqueue_events (u32 thread_index);
 350
 351 always_inline u64
 352 listen_session_get_handle (stream_session_t * s)
 353 {
 354   ASSERT (s->session_state == SESSION_STATE_LISTENING);
 355   return ((u64) s->session_type << 32) | s->session_index;
 356 }
 357
 358 always_inline stream_session_t *
 359 listen_session_get_from_handle (u64 handle)
 360 {
 361   session_manager_main_t *smm = &session_manager_main;
 362   stream_session_t *s;
 363   u32 type, index;
 364   type = handle >> 32;
 365   index = handle & 0xFFFFFFFF;
 366
 367   if (pool_is_free_index (smm->listen_sessions[type], index))
 368     return 0;
 369
 370   s = pool_elt_at_index (smm->listen_sessions[type], index);
 371   ASSERT (s->session_state == SESSION_STATE_LISTENING);
 372   return s;
 373 }
 374
 375 always_inline stream_session_t *
 376 listen_session_new (session_type_t type)
 377 {
 378   stream_session_t *s;
 379   pool_get_aligned (session_manager_main.listen_sessions[type], s,
 380                     CLIB_CACHE_LINE_BYTES);
 381   memset (s, 0, sizeof (*s));
 382
 383   s->session_type = type;
 384   s->session_state = SESSION_STATE_LISTENING;
 385   s->session_index = s - session_manager_main.listen_sessions[type];
 386
 387   return s;
 388 }
 389
 390 always_inline stream_session_t *
 391 listen_session_get (session_type_t type, u32 index)
 392 {
 393   return pool_elt_at_index (session_manager_main.listen_sessions[type],
 394                             index);
 395 }
 396
 397 always_inline void
 398 listen_session_del (stream_session_t * s)
 399 {
 400   pool_put (session_manager_main.listen_sessions[s->session_type], s);
 401 }
 402
 403 int
 404 listen_session_get_local_session_endpoint (stream_session_t * listener,
 405                                            session_endpoint_t * sep);
 406
 407 always_inline stream_session_t *
 408 session_manager_get_listener (u8 type, u32 index)
 409 {
 410   return pool_elt_at_index (session_manager_main.listen_sessions[type],
 411                             index);
 412 }
 413
 414 always_inline void
 415 session_manager_set_transport_rx_fn (u8 type, u8 is_peek)
 416 {
 417   /* If an offset function is provided, then peek instead of dequeue */
 418   session_manager_main.session_tx_fns[type] = (is_peek) ?
 419     session_tx_fifo_peek_and_snd : session_tx_fifo_dequeue_and_snd;
 420 }
 421
 422 session_type_t
 423 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4);
 424
 425 always_inline u8
 426 session_manager_is_enabled ()
 427 {
 428   return session_manager_main.is_enabled == 1;
 429 }
 430
 431 #define session_cli_return_if_not_enabled()                             \
 432 do {                                                                    \
 433     if (!session_manager_main.is_enabled)                               \
 434       return clib_error_return(0, "session layer is not enabled");      \
 435 } while (0)
 436
 437 #endif /* __included_session_h__ */
 438
 439 /*
 440  * fd.io coding-style-patch-verification: ON
 441  *
 442  * Local Variables:
 443  * eval: (c-set-style "gnu")
 444  * End:
 445  */