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