TCP proxy prototype
[vpp.git] / src / vnet / session / session.h
index 96c00d8..74d82a4 100644 (file)
 #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 <vlibmemory/api.h>
-#include <vppinfra/sparse_vec.h>
-#include <svm/svm_fifo_segment.h>
+#include <vnet/session/session_debug.h>
+#include <vnet/session/segment_manager.h>
 
 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
 #define INVALID_INDEX ((u32)~0)
 
 typedef enum
 {
-  FIFO_EVENT_SERVER_RX,
-  FIFO_EVENT_SERVER_TX,
+  FIFO_EVENT_APP_RX,
+  FIFO_EVENT_APP_TX,
   FIFO_EVENT_TIMEOUT,
-  FIFO_EVENT_SERVER_EXIT,
+  FIFO_EVENT_DISCONNECT,
+  FIFO_EVENT_BUILTIN_RX,
+  FIFO_EVENT_RPC,
 } fifo_event_type_t;
 
-#define foreach_session_input_error                                         \
+#define foreach_session_input_error                                            \
 _(NO_SESSION, "No session drops")                                       \
 _(NO_LISTENER, "No listener for dst port drops")                        \
 _(ENQUEUED, "Packets pushed into rx fifo")                              \
@@ -65,93 +68,24 @@ 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 CLIB_PACKED (struct
-                    {
-                    svm_fifo_t * fifo;
-                    u8 event_type;
-                    /* $$$$ for event logging */
-                    u16 event_id;
-                    u32 enqueue_length;
-                    }) session_fifo_event_t;
-
-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;
-
-  /** used during unbind processing */
-  u8 is_deleted;
-
-  /** To avoid n**2 "one event per frame" check */
-  u8 enqueue_epoch;
-
-  /** 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;
-
-  /** svm segment index */
-  u32 server_segment_index;
-} stream_session_t;
-
-typedef struct _session_manager
+typedef struct
 {
-  /** segments mapped by this server */
-  u32 *segment_indices;
-
-  /** Session fifo sizes. They are provided for binds and take default
-   * values for connects */
-  u32 rx_fifo_size;
-  u32 tx_fifo_size;
-
-  /** Configured additional segment size */
-  u32 add_segment_size;
-
-  /** Flag that indicates if additional segments should be created */
-  u8 add_segment;
-} session_manager_t;
+  void *fp;
+  void *arg;
+} rpc_args_t;
+
+/* *INDENT-OFF* */
+typedef CLIB_PACKED (struct {
+  union
+    {
+      svm_fifo_t * fifo;
+      u64 session_handle;
+      rpc_args_t rpc_args;
+    };
+  u8 event_type;
+  u16 event_id;
+}) session_fifo_event_t;
+/* *INDENT-ON* */
 
 /* Forward definition */
 typedef struct _session_manager_main session_manager_main_t;
@@ -165,16 +99,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;
 
@@ -194,30 +122,47 @@ struct _session_manager_main
   u32 **tx_buffers;
 
   /** Per worker-thread vector of partially read events */
-  session_fifo_event_t **evts_partially_read;
+  session_fifo_event_t **free_event_vector;
 
   /** per-worker active event vectors */
-  session_fifo_event_t **fifo_events;
+  session_fifo_event_t **pending_event_vector;
 
   /** vpp fifo event queue */
   unix_shared_memory_queue_t **vpp_event_queues;
 
-  /** Unique segment name counter */
-  u32 unique_segment_name_counter;
+  /** vpp fifo event queue configured length */
+  u32 configured_event_queue_length;
 
-  /* Connection manager used by incoming connects */
-  u32 connect_manager_index[SESSION_N_TYPES];
+  /** 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;
 
-  session_manager_t *session_managers;
+  /** 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
+  /**
+   * last event poll time by thread
+   * Debug only. Will cause false cache-line sharing as-is
+   */
+  f64 *last_event_poll_by_thread;
+#endif
+
 };
 
 extern session_manager_main_t session_manager_main;
@@ -232,89 +177,72 @@ vnet_get_session_manager_main ()
   return &session_manager_main;
 }
 
-always_inline session_manager_t *
-session_manager_get (u32 index)
+always_inline u8
+stream_session_is_valid (u32 si, u8 thread_index)
 {
-  return pool_elt_at_index (session_manager_main.session_managers, index);
+  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 unix_shared_memory_queue_t *
-session_manager_get_vpp_event_queue (u32 thread_index)
+always_inline stream_session_t *
+stream_session_get (u32 si, u32 thread_index)
 {
-  return session_manager_main.vpp_event_queues[thread_index];
+  ASSERT (stream_session_is_valid (si, thread_index));
+  return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
 }
 
-always_inline session_manager_t *
-connects_session_manager_get (session_manager_main_t * smm,
-                             session_type_t session_type)
+always_inline stream_session_t *
+stream_session_get_if_valid (u64 si, u32 thread_index)
 {
-  return pool_elt_at_index (smm->session_managers,
-                           smm->connect_manager_index[session_type]);
-}
-
-void session_manager_get_segment_info (u32 index, u8 ** name, u32 * size);
-int session_manager_flush_enqueue_events (u32 thread_index);
-int
-session_manager_add_first_segment (session_manager_main_t * smm,
-                                  session_manager_t * sm, u32 segment_size,
-                                  u8 ** segment_name);
-void
-session_manager_del (session_manager_main_t * smm, session_manager_t * sm);
-void
-connects_session_manager_init (session_manager_main_t * smm, u8 session_type);
+  if (thread_index >= vec_len (session_manager_main.sessions))
+    return 0;
 
-/*
- * Stream session functions
- */
+  if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
+    return 0;
 
-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);
+  ASSERT (stream_session_is_valid (si, thread_index));
+  return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
+}
 
-always_inline stream_session_t *
-stream_session_get_tsi (u64 ti_and_si, u32 thread_index)
+always_inline u64
+stream_session_handle (stream_session_t * s)
 {
-  ASSERT ((u32) (ti_and_si >> 32) == thread_index);
-  return pool_elt_at_index (session_manager_main.sessions[thread_index],
-                           ti_and_si & 0xFFFFFFFFULL);
+  return ((u64) s->thread_index << 32) | (u64) s->session_index;
 }
 
-always_inline stream_session_t *
-stream_session_get (u64 si, u32 thread_index)
+always_inline u32
+stream_session_index_from_handle (u64 handle)
 {
-  return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
+  return handle & 0xFFFFFFFF;
 }
 
-always_inline stream_session_t *
-stream_session_get_if_valid (u64 si, u32 thread_index)
+always_inline u32
+stream_session_thread_from_handle (u64 handle)
 {
-  if (thread_index >= vec_len (session_manager_main.sessions))
-    return 0;
+  return handle >> 32;
+}
 
-  if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
-    return 0;
+always_inline void
+stream_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);
+}
 
-  return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
+always_inline stream_session_t *
+stream_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));
 }
 
 always_inline stream_session_t *
@@ -333,31 +261,32 @@ stream_session_get_index (stream_session_t * s)
 }
 
 always_inline u32
-stream_session_max_enqueue (transport_connection_t * tc)
+stream_session_max_rx_enqueue (transport_connection_t * tc)
 {
   stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
   return svm_fifo_max_enqueue (s->server_rx_fifo);
 }
 
 always_inline u32
-stream_session_fifo_size (transport_connection_t * tc)
+stream_session_rx_fifo_size (transport_connection_t * tc)
 {
   stream_session_t *s = stream_session_get (tc->s_index, tc->thread_index);
   return s->server_rx_fifo->nitems;
 }
 
+u32 stream_session_tx_fifo_max_dequeue (transport_connection_t * tc);
 
 int
-stream_session_enqueue_data (transport_connection_t * tc, u8 * data, u16 len,
-                            u8 queue_event);
-u32
+stream_session_enqueue_data (transport_connection_t * tc, vlib_buffer_t * b,
+                            u32 offset, u8 queue_event, u8 is_in_order);
+int
 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);
 
-void
-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);
 
 void stream_session_accept_notify (transport_connection_t * tc);
 void stream_session_disconnect_notify (transport_connection_t * tc);
@@ -366,21 +295,114 @@ void stream_session_reset_notify (transport_connection_t * tc);
 int
 stream_session_accept (transport_connection_t * tc, u32 listener_index,
                       u8 sst, u8 notify);
-int stream_session_open (u8 sst, ip46_address_t * addr,
-                        u16 port_host_byte_order, u32 api_client_index);
+int
+stream_session_open (u32 app_index, session_type_t st,
+                    transport_endpoint_t * tep,
+                    transport_connection_t ** tc);
+int stream_session_listen (stream_session_t * s, transport_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);
-int
-stream_session_start_listen (u32 server_index, ip46_address_t * ip, u16 port);
-void stream_session_stop_listen (u32 server_index);
+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 *
+session_manager_get_vpp_event_queue (u32 thread_index)
+{
+  return session_manager_main.vpp_event_queues[thread_index];
+}
+
+int session_manager_flush_enqueue_events (u32 thread_index);
+
+always_inline u64
+listen_session_get_handle (stream_session_t * s)
+{
+  ASSERT (s->session_state == SESSION_STATE_LISTENING);
+  return ((u64) s->session_type << 32) | s->session_index;
+}
+
+always_inline stream_session_t *
+listen_session_get_from_handle (u64 handle)
+{
+  session_manager_main_t *smm = &session_manager_main;
+  stream_session_t *s;
+  u32 type, index;
+  type = handle >> 32;
+  index = handle & 0xFFFFFFFF;
+
+  if (pool_is_free_index (smm->listen_sessions[type], index))
+    return 0;
+
+  s = pool_elt_at_index (smm->listen_sessions[type], index);
+  ASSERT (s->session_state == SESSION_STATE_LISTENING);
+  return s;
+}
+
+always_inline stream_session_t *
+listen_session_new (session_type_t type)
+{
+  stream_session_t *s;
+  pool_get_aligned (session_manager_main.listen_sessions[type], s,
+                   CLIB_CACHE_LINE_BYTES);
+  memset (s, 0, sizeof (*s));
+
+  s->session_type = type;
+  s->session_state = SESSION_STATE_LISTENING;
+  s->session_index = s - session_manager_main.listen_sessions[type];
+
+  return s;
+}
+
+always_inline stream_session_t *
+listen_session_get (session_type_t type, u32 index)
+{
+  return pool_elt_at_index (session_manager_main.listen_sessions[type],
+                           index);
+}
+
+always_inline void
+listen_session_del (stream_session_t * s)
+{
+  pool_put (session_manager_main.listen_sessions[s->session_type], s);
+}
+
+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;
+}
+
 #endif /* __included_session_h__ */
 
 /*