session: add support for application namespacing
[vpp.git] / src / vnet / session / session.h
index 5fa4225..b1a03d2 100644 (file)
@@ -15,7 +15,9 @@
 #ifndef __included_session_h__
 #define __included_session_h__
 
-#include <vnet/session/transport.h>
+#include <vnet/session/stream_session.h>
+#include <vnet/session/session_lookup.h>
+#include <vnet/session/transport_interface.h>
 #include <vlibmemory/unix_shared_memory_queue.h>
 #include <vnet/session/session_debug.h>
 #include <vnet/session/segment_manager.h>
@@ -36,6 +38,28 @@ typedef enum
   FIFO_EVENT_RPC,
 } fifo_event_type_t;
 
+static inline const char *
+fifo_event_type_str (fifo_event_type_t et)
+{
+  switch (et)
+    {
+    case FIFO_EVENT_APP_RX:
+      return "FIFO_EVENT_APP_RX";
+    case FIFO_EVENT_APP_TX:
+      return "FIFO_EVENT_APP_TX";
+    case FIFO_EVENT_TIMEOUT:
+      return "FIFO_EVENT_TIMEOUT";
+    case FIFO_EVENT_DISCONNECT:
+      return "FIFO_EVENT_DISCONNECT";
+    case FIFO_EVENT_BUILTIN_RX:
+      return "FIFO_EVENT_BUILTIN_RX";
+    case FIFO_EVENT_RPC:
+      return "FIFO_EVENT_RPC";
+    default:
+      return "UNKNOWN FIFO EVENT";
+    }
+}
+
 #define foreach_session_input_error                                            \
 _(NO_SESSION, "No session drops")                                       \
 _(NO_LISTENER, "No listener for dst port drops")                        \
@@ -66,32 +90,6 @@ typedef enum
   SESSION_QUEUE_N_NEXT,
 } session_queue_next_t;
 
-#define foreach_session_type                    \
-  _(IP4_TCP, ip4_tcp)                           \
-  _(IP4_UDP, ip4_udp)                           \
-  _(IP6_TCP, ip6_tcp)                           \
-  _(IP6_UDP, ip6_udp)
-
-typedef enum
-{
-#define _(A, a) SESSION_TYPE_##A,
-  foreach_session_type
-#undef _
-    SESSION_N_TYPES,
-} session_type_t;
-
-/*
- * Application session state
- */
-typedef enum
-{
-  SESSION_STATE_LISTENING,
-  SESSION_STATE_CONNECTING,
-  SESSION_STATE_READY,
-  SESSION_STATE_CLOSED,
-  SESSION_STATE_N_STATES,
-} stream_session_state_t;
-
 typedef struct
 {
   void *fp;
@@ -111,48 +109,6 @@ typedef CLIB_PACKED (struct {
 }) session_fifo_event_t;
 /* *INDENT-ON* */
 
-typedef struct _stream_session_t
-{
-  /** fifo pointers. Once allocated, these do not move */
-  svm_fifo_t *server_rx_fifo;
-  svm_fifo_t *server_tx_fifo;
-
-  /** Type */
-  u8 session_type;
-
-  /** State */
-  u8 session_state;
-
-  u8 thread_index;
-
-  /** To avoid n**2 "one event per frame" check */
-  u8 enqueue_epoch;
-
-  /** Pad to a multiple of 8 octets */
-  u8 align_pad[4];
-
-  /** svm segment index where fifos were allocated */
-  u32 svm_segment_index;
-
-  /** Session index in per_thread pool */
-  u32 session_index;
-
-  /** Transport specific */
-  u32 connection_index;
-
-  /** Application specific */
-  u32 pid;
-
-  /** stream server pool index */
-  u32 app_index;
-
-  /** Parent listener session if the result of an accept */
-  u32 listener_index;
-
-  /** Opaque, pad to a 64-octet boundary */
-  u64 opaque[2];
-} stream_session_t;
-
 /* Forward definition */
 typedef struct _session_manager_main session_manager_main_t;
 
@@ -165,16 +121,10 @@ typedef int
 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
 
+u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_fifo_event_t * e);
+
 struct _session_manager_main
 {
-  /** Lookup tables for established sessions and listeners */
-  clib_bihash_16_8_t v4_session_hash;
-  clib_bihash_48_8_t v6_session_hash;
-
-  /** Lookup tables for half-open sessions */
-  clib_bihash_16_8_t v4_half_open_hash;
-  clib_bihash_48_8_t v6_half_open_hash;
-
   /** Per worker thread session pools */
   stream_session_t **sessions;
 
@@ -205,17 +155,27 @@ struct _session_manager_main
   /** vpp fifo event queue configured length */
   u32 configured_event_queue_length;
 
+  /** session table size parameters */
+  u32 configured_v4_session_table_buckets;
+  u32 configured_v4_session_table_memory;
+  u32 configured_v4_halfopen_table_buckets;
+  u32 configured_v4_halfopen_table_memory;
+  u32 configured_v6_session_table_buckets;
+  u32 configured_v6_session_table_memory;
+  u32 configured_v6_halfopen_table_buckets;
+  u32 configured_v6_halfopen_table_memory;
+
   /** Unique segment name counter */
   u32 unique_segment_name_counter;
 
   /** Per transport rx function that can either dequeue or peek */
   session_fifo_rx_fn *session_tx_fns[SESSION_N_TYPES];
 
+  /** Session manager is enabled */
   u8 is_enabled;
 
-  /* Convenience */
-  vlib_main_t *vlib_main;
-  vnet_main_t *vnet_main;
+  /** Preallocate session config parameter */
+  u32 preallocated_sessions;
 
 #if SESSION_DBG
   /**
@@ -239,47 +199,24 @@ vnet_get_session_manager_main ()
   return &session_manager_main;
 }
 
-/*
- * Stream session functions
- */
-
-stream_session_t *stream_session_lookup_listener4 (ip4_address_t * lcl,
-                                                  u16 lcl_port, u8 proto);
-stream_session_t *stream_session_lookup4 (ip4_address_t * lcl,
-                                         ip4_address_t * rmt, u16 lcl_port,
-                                         u16 rmt_port, u8 proto,
-                                         u32 thread_index);
-stream_session_t *stream_session_lookup_listener6 (ip6_address_t * lcl,
-                                                  u16 lcl_port, u8 proto);
-stream_session_t *stream_session_lookup6 (ip6_address_t * lcl,
-                                         ip6_address_t * rmt, u16 lcl_port,
-                                         u16 rmt_port, u8, u32 thread_index);
-transport_connection_t
-  * stream_session_lookup_transport4 (ip4_address_t * lcl,
-                                     ip4_address_t * rmt, u16 lcl_port,
-                                     u16 rmt_port, u8 proto,
-                                     u32 thread_index);
-transport_connection_t
-  * stream_session_lookup_transport6 (ip6_address_t * lcl,
-                                     ip6_address_t * rmt, u16 lcl_port,
-                                     u16 rmt_port, u8 proto,
-                                     u32 thread_index);
-stream_session_t *stream_session_lookup_listener (ip46_address_t * lcl,
-                                                 u16 lcl_port, u8 proto);
-void stream_session_table_add_for_tc (transport_connection_t * tc, u64 value);
-int stream_session_table_del_for_tc (transport_connection_t * tc);
-
-always_inline stream_session_t *
-stream_session_get_tsi (u64 ti_and_si, u32 thread_index)
+always_inline u8
+stream_session_is_valid (u32 si, u8 thread_index)
 {
-  ASSERT ((u32) (ti_and_si >> 32) == thread_index);
-  return pool_elt_at_index (session_manager_main.sessions[thread_index],
-                           ti_and_si & 0xFFFFFFFFULL);
+  stream_session_t *s;
+  s = pool_elt_at_index (session_manager_main.sessions[thread_index], si);
+  if (s->thread_index != thread_index || s->session_index != si
+      /* || s->server_rx_fifo->master_session_index != si
+         || s->server_tx_fifo->master_session_index != si
+         || s->server_rx_fifo->master_thread_index != thread_index
+         || s->server_tx_fifo->master_thread_index != thread_index */ )
+    return 0;
+  return 1;
 }
 
 always_inline stream_session_t *
-stream_session_get (u32 si, u32 thread_index)
+session_get (u32 si, u32 thread_index)
 {
+  ASSERT (stream_session_is_valid (si, thread_index));
   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
 }
 
@@ -292,6 +229,7 @@ stream_session_get_if_valid (u64 si, u32 thread_index)
   if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
     return 0;
 
+  ASSERT (stream_session_is_valid (si, thread_index));
   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
 }
 
@@ -302,31 +240,31 @@ stream_session_handle (stream_session_t * s)
 }
 
 always_inline u32
-stream_session_index_from_handle (u64 handle)
+session_index_from_handle (u64 handle)
 {
   return handle & 0xFFFFFFFF;
 }
 
 always_inline u32
-stream_session_thread_from_handle (u64 handle)
+session_thread_from_handle (u64 handle)
 {
   return handle >> 32;
 }
 
 always_inline void
-stream_session_parse_handle (u64 handle, u32 * index, u32 * thread_index)
+session_parse_handle (u64 handle, u32 * index, u32 * thread_index)
 {
-  *index = stream_session_index_from_handle (handle);
-  *thread_index = stream_session_thread_from_handle (handle);
+  *index = session_index_from_handle (handle);
+  *thread_index = session_thread_from_handle (handle);
 }
 
 always_inline stream_session_t *
-stream_session_get_from_handle (u64 handle)
+session_get_from_handle (u64 handle)
 {
   session_manager_main_t *smm = &session_manager_main;
-  return pool_elt_at_index (smm->sessions[stream_session_thread_from_handle
-                                         (handle)],
-                           stream_session_index_from_handle (handle));
+  return
+    pool_elt_at_index (smm->sessions[session_thread_from_handle (handle)],
+                      session_index_from_handle (handle));
 }
 
 always_inline stream_session_t *
@@ -347,14 +285,14 @@ stream_session_get_index (stream_session_t * s)
 always_inline u32
 stream_session_max_rx_enqueue (transport_connection_t * tc)
 {
-  stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
+  stream_session_t *s = session_get (tc->s_index, tc->thread_index);
   return svm_fifo_max_enqueue (s->server_rx_fifo);
 }
 
 always_inline u32
 stream_session_rx_fifo_size (transport_connection_t * tc)
 {
-  stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
+  stream_session_t *s = session_get (tc->s_index, tc->thread_index);
   return s->server_rx_fifo->nitems;
 }
 
@@ -368,8 +306,7 @@ stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
                           u32 offset, u32 max_bytes);
 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
 
-int stream_session_connect_notify (transport_connection_t * tc, u8 sst,
-                                  u8 is_fail);
+int stream_session_connect_notify (transport_connection_t * tc, u8 is_fail);
 void stream_session_init_fifos_pointers (transport_connection_t * tc,
                                         u32 rx_pointer, u32 tx_pointer);
 
@@ -379,27 +316,28 @@ void stream_session_delete_notify (transport_connection_t * tc);
 void stream_session_reset_notify (transport_connection_t * tc);
 int
 stream_session_accept (transport_connection_t * tc, u32 listener_index,
-                      u8 sst, u8 notify);
+                      u8 notify);
 int
-stream_session_open (u32 app_index, session_type_t st,
-                    transport_endpoint_t * tep,
+stream_session_open (u32 app_index, session_endpoint_t * tep,
                     transport_connection_t ** tc);
-int stream_session_listen (stream_session_t * s, transport_endpoint_t * tep);
+int stream_session_listen (stream_session_t * s, session_endpoint_t * tep);
 int stream_session_stop_listen (stream_session_t * s);
 void stream_session_disconnect (stream_session_t * s);
 void stream_session_cleanup (stream_session_t * s);
 void session_send_session_evt_to_thread (u64 session_handle,
                                         fifo_event_type_t evt_type,
                                         u32 thread_index);
+
 u8 *format_stream_session (u8 * s, va_list * args);
+uword unformat_stream_session (unformat_input_t * input, va_list * args);
+uword unformat_transport_connection (unformat_input_t * input,
+                                    va_list * args);
+
 int
 send_session_connected_callback (u32 app_index, u32 api_context,
                                 stream_session_t * s, u8 is_fail);
 
 
-void session_register_transport (u8 type, const transport_proto_vft_t * vft);
-transport_proto_vft_t *session_get_transport_vft (u8 type);
-
 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 
 always_inline unix_shared_memory_queue_t *
@@ -462,12 +400,40 @@ listen_session_del (stream_session_t * s)
   pool_put (session_manager_main.listen_sessions[s->session_type], s);
 }
 
+int
+listen_session_get_local_session_endpoint (stream_session_t * listener,
+                                          session_endpoint_t * sep);
+
+always_inline stream_session_t *
+session_manager_get_listener (u8 type, u32 index)
+{
+  return pool_elt_at_index (session_manager_main.listen_sessions[type],
+                           index);
+}
+
+always_inline void
+session_manager_set_transport_rx_fn (u8 type, u8 is_peek)
+{
+  /* If an offset function is provided, then peek instead of dequeue */
+  session_manager_main.session_tx_fns[type] = (is_peek) ?
+    session_tx_fifo_peek_and_snd : session_tx_fifo_dequeue_and_snd;
+}
+
+session_type_t
+session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4);
+
 always_inline u8
 session_manager_is_enabled ()
 {
   return session_manager_main.is_enabled == 1;
 }
 
+#define session_cli_return_if_not_enabled()                            \
+do {                                                                   \
+    if (!session_manager_main.is_enabled)                              \
+      return clib_error_return(0, "session layer is not enabled");     \
+} while (0)
+
 #endif /* __included_session_h__ */
 
 /*