session: basic support for interrupt mode
[vpp.git] / src / vnet / session / session.h
index d126818..93278d6 100644 (file)
 #ifndef __included_session_h__
 #define __included_session_h__
 
+#include <vppinfra/llist.h>
 #include <vnet/session/session_types.h>
 #include <vnet/session/session_lookup.h>
 #include <vnet/session/session_debug.h>
 #include <svm/message_queue.h>
-#include <svm/ssvm.h>
+#include <svm/fifo_segment.h>
 
 #define foreach_session_input_error                                            \
 _(NO_SESSION, "No session drops")                                       \
@@ -29,9 +30,6 @@ _(NOT_READY, "Session not ready packets")                               \
 _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
-_(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair")   \
-_(NO_SPACE, "Couldn't allocate a fifo pair")                           \
-_(SEG_CREATE, "Couldn't create a new segment")
 
 typedef enum
 {
@@ -39,7 +37,7 @@ typedef enum
   foreach_session_input_error
 #undef _
     SESSION_N_ERROR,
-} session_error_t;
+} session_input_error_t;
 
 typedef struct session_tx_context_
 {
@@ -47,20 +45,42 @@ typedef struct session_tx_context_
   session_t *s;
   transport_proto_vft_t *transport_vft;
   transport_connection_t *tc;
+  transport_send_params_t sp;
   u32 max_dequeue;
-  u32 snd_space;
   u32 left_to_snd;
-  u32 tx_offset;
   u32 max_len_to_snd;
   u16 deq_per_first_buf;
   u16 deq_per_buf;
-  u16 snd_mss;
   u16 n_segs_per_evt;
+  u16 n_bufs_needed;
   u8 n_bufs_per_seg;
     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
   session_dgram_hdr_t hdr;
 } session_tx_context_t;
 
+typedef struct session_evt_elt
+{
+  clib_llist_anchor_t evt_list;
+  session_event_t evt;
+} session_evt_elt_t;
+
+typedef struct session_ctrl_evt_data_
+{
+  u8 data[SESSION_CTRL_MSG_MAX_SIZE];
+} session_evt_ctrl_data_t;
+
+typedef enum session_wrk_state_
+{
+  SESSION_WRK_POLLING,
+  SESSION_WRK_INTERRUPT,
+  SESSION_WRK_IDLE,
+} __clib_packed session_wrk_state_t;
+
+typedef enum session_wrk_flags_
+{
+  SESSION_WRK_F_ADAPTIVE = 1 << 0,
+} __clib_packed session_wrk_flag_t;
+
 typedef struct session_worker_
 {
   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
@@ -71,14 +91,26 @@ typedef struct session_worker_
   /** vpp event message queue for worker */
   svm_msg_q_t *vpp_event_queue;
 
-  /** Our approximation of a "complete" dispatch loop period */
-  f64 dispatch_period;
-
   /** vlib_time_now last time around the track */
-  f64 last_vlib_time;
+  clib_time_type_t last_vlib_time;
+
+  /** vlib_time_now rounded to us precision and as u64 */
+  clib_us_time_t last_vlib_us_time;
+
+  /** Convenience pointer to this worker's vlib_main */
+  vlib_main_t *vm;
 
   /** Per-proto vector of sessions to enqueue */
-  u32 *session_to_enqueue[TRANSPORT_N_PROTO];
+  u32 **session_to_enqueue;
+
+  /** Timerfd used to periodically signal wrk session queue node */
+  u32 timerfd;
+
+  /** Worker flags */
+  session_wrk_flag_t flags;
+
+  /** Worker state */
+  session_wrk_state_t state;
 
   /** Context for session tx */
   session_tx_context_t ctx;
@@ -86,29 +118,42 @@ typedef struct session_worker_
   /** Vector of tx buffer free lists */
   u32 *tx_buffers;
 
-  /** Vector of partially read events */
-  session_event_t *free_event_vector;
+  /** Pool of session event list elements */
+  session_evt_elt_t *event_elts;
+
+  /** Pool of ctrl events data buffers */
+  session_evt_ctrl_data_t *ctrl_evts_data;
 
-  /** Vector of active event vectors */
-  session_event_t *pending_event_vector;
+  /** Head of control events list */
+  clib_llist_index_t ctrl_head;
 
-  /** Vector of postponed disconnects */
-  session_event_t *pending_disconnects;
+  /** Head of list of elements */
+  clib_llist_index_t new_head;
 
-  /** Vector of postponed events */
-  session_event_t *postponed_event_vector;
+  /** Head of list of pending events */
+  clib_llist_index_t old_head;
 
   /** Peekers rw lock */
   clib_rwlock_t peekers_rw_locks;
 
-  u32 last_tx_packets;
+  /** Vector of buffers to be sent */
+  u32 *pending_tx_buffers;
 
+  /** Vector of nexts for the pending tx buffers */
+  u16 *pending_tx_nexts;
+
+  /** Clib file for timerfd. Used only if adaptive mode is on */
+  uword timerfd_file;
+
+#if SESSION_DEBUG
+  /** last event poll time by thread */
+  clib_time_type_t last_event_poll;
+#endif
 } session_worker_t;
 
-typedef int (session_fifo_rx_fn) (vlib_main_t * vm,
+typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
                                  vlib_node_runtime_t * node,
-                                 session_worker_t * wrk,
-                                 session_event_t * e, int *n_tx_pkts);
+                                 session_evt_elt_t * e, int *n_tx_packets);
 
 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
@@ -121,8 +166,8 @@ typedef struct session_main_
   /** Worker contexts */
   session_worker_t *wrk;
 
-  /** Event queues memfd segment initialized only if so configured */
-  ssvm_private_t evt_qs_segment;
+  /** Event queues memfd segment */
+  fifo_segment_t evt_qs_segment;
 
   /** Unique segment name counter */
   u32 unique_segment_name_counter;
@@ -135,6 +180,8 @@ typedef struct session_main_
    * Trade memory for speed, for now */
   u32 *session_type_to_next;
 
+  transport_proto_t last_transport_proto_type;
+
   /*
    * Config parameters
    */
@@ -142,6 +189,21 @@ typedef struct session_main_
   /** Session manager is enabled */
   u8 is_enabled;
 
+  /** Session manager initialized (not necessarily enabled) */
+  u8 is_initialized;
+
+  /** Enable session manager at startup */
+  u8 session_enable_asap;
+
+  /** Poll session node in main thread */
+  u8 poll_main;
+
+  /** Allocate private rx mqs for external apps */
+  u8 use_private_rx_mqs;
+
+  /** Do not enable session queue node adaptive mode */
+  u8 no_adaptive;
+
   /** vpp fifo event queue configured length */
   u32 configured_event_queue_length;
 
@@ -149,7 +211,6 @@ typedef struct session_main_
   uword session_baseva;
   uword session_va_space_size;
   uword evt_qs_segment_size;
-  u8 evt_qs_use_memfd_seg;
 
   /** Session table size parameters */
   u32 configured_v4_session_table_buckets;
@@ -168,14 +229,6 @@ typedef struct session_main_
   /** Preallocate session config parameter */
   u32 preallocated_sessions;
 
-#if SESSION_DEBUG
-  /**
-   * last event poll time by thread
-   * Debug only. Will cause false cache-line sharing as-is
-   */
-  f64 *last_event_poll_by_thread;
-#endif
-
 } session_main_t;
 
 extern session_main_t session_main;
@@ -183,25 +236,104 @@ extern vlib_node_registration_t session_queue_node;
 extern vlib_node_registration_t session_queue_process_node;
 extern vlib_node_registration_t session_queue_pre_input_node;
 
-#define SESSION_Q_PROCESS_FLUSH_FRAMES 1
-#define SESSION_Q_PROCESS_STOP         2
+typedef enum session_q_process_evt_
+{
+  SESSION_Q_PROCESS_RUN_ON_MAIN = 1,
+  SESSION_Q_PROCESS_STOP
+} session_q_process_evt_t;
 
-always_inline u8
-session_is_valid (u32 si, u8 thread_index)
+#define TRANSPORT_PROTO_INVALID (session_main.last_transport_proto_type + 1)
+#define TRANSPORT_N_PROTOS (session_main.last_transport_proto_type + 1)
+
+static inline session_evt_elt_t *
+session_evt_elt_alloc (session_worker_t * wrk)
 {
-  session_t *s;
-  s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
-  if (s->session_state == SESSION_STATE_CLOSED)
-    return 1;
+  session_evt_elt_t *elt;
+  pool_get (wrk->event_elts, elt);
+  return elt;
+}
 
-  if (s->thread_index != thread_index || s->session_index != si)
-    return 0;
-  return 1;
+static inline void
+session_evt_elt_free (session_worker_t * wrk, session_evt_elt_t * elt)
+{
+  pool_put (wrk->event_elts, elt);
+}
+
+static inline void
+session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
+{
+  clib_llist_add_tail (wrk->event_elts, evt_list, elt,
+                      pool_elt_at_index (wrk->event_elts, wrk->old_head));
+}
+
+static inline void
+session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
+{
+  clib_llist_add (wrk->event_elts, evt_list, elt,
+                 pool_elt_at_index (wrk->event_elts, wrk->old_head));
+}
+
+
+static inline u32
+session_evt_ctrl_data_alloc (session_worker_t * wrk)
+{
+  session_evt_ctrl_data_t *data;
+  pool_get (wrk->ctrl_evts_data, data);
+  return (data - wrk->ctrl_evts_data);
 }
 
+static inline session_evt_elt_t *
+session_evt_alloc_ctrl (session_worker_t * wrk)
+{
+  session_evt_elt_t *elt;
+  elt = session_evt_elt_alloc (wrk);
+  clib_llist_add_tail (wrk->event_elts, evt_list, elt,
+                      pool_elt_at_index (wrk->event_elts, wrk->ctrl_head));
+  return elt;
+}
+
+static inline void *
+session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
+{
+  return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
+                                     elt->evt.ctrl_data_index));
+}
+
+static inline void
+session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
+{
+  ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
+  pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
+}
+
+static inline session_evt_elt_t *
+session_evt_alloc_new (session_worker_t * wrk)
+{
+  session_evt_elt_t *elt;
+  elt = session_evt_elt_alloc (wrk);
+  clib_llist_add_tail (wrk->event_elts, evt_list, elt,
+                      pool_elt_at_index (wrk->event_elts, wrk->new_head));
+  return elt;
+}
+
+static inline session_evt_elt_t *
+session_evt_alloc_old (session_worker_t * wrk)
+{
+  session_evt_elt_t *elt;
+  elt = session_evt_elt_alloc (wrk);
+  clib_llist_add_tail (wrk->event_elts, evt_list, elt,
+                      pool_elt_at_index (wrk->event_elts, wrk->old_head));
+  return elt;
+}
+
+int session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq);
+
 session_t *session_alloc (u32 thread_index);
 void session_free (session_t * s);
 void session_free_w_fifos (session_t * s);
+void session_cleanup_half_open (transport_proto_t tp,
+                               session_handle_t ho_handle);
+u8 session_is_valid (u32 si, u8 thread_index);
 
 always_inline session_t *
 session_get (u32 si, u32 thread_index)
@@ -325,7 +457,9 @@ int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
 int session_stop_listen (session_t * s);
 void session_close (session_t * s);
+void session_reset (session_t * s);
 void session_transport_close (session_t * s);
+void session_transport_reset (session_t * s);
 void session_transport_cleanup (session_t * s);
 int session_send_io_evt_to_thread (svm_fifo_t * f,
                                   session_evt_type_t evt_type);
@@ -337,6 +471,9 @@ void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
                                     void *rpc_args);
 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
                                           void *rpc_args);
+void session_add_self_custom_tx_evt (transport_connection_t * tc,
+                                    u8 has_prio);
+void sesssion_reschedule_tx (transport_connection_t * tc);
 transport_connection_t *session_get_transport (session_t * s);
 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
                           u8 is_lcl);
@@ -357,20 +494,38 @@ int session_enqueue_dgram_connection (session_t * s,
                                      session_dgram_hdr_t * hdr,
                                      vlib_buffer_t * b, u8 proto,
                                      u8 queue_event);
-int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
+int session_stream_connect_notify (transport_connection_t * tc,
+                                  session_error_t err);
 int session_dgram_connect_notify (transport_connection_t * tc,
                                  u32 old_thread_index,
                                  session_t ** new_session);
 int session_stream_accept_notify (transport_connection_t * tc);
 void session_transport_closing_notify (transport_connection_t * tc);
 void session_transport_delete_notify (transport_connection_t * tc);
+void session_half_open_delete_notify (transport_proto_t tp,
+                                     session_handle_t ho_handle);
 void session_transport_closed_notify (transport_connection_t * tc);
 void session_transport_reset_notify (transport_connection_t * tc);
 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
                           u32 thread_index, u8 notify);
+int session_dgram_accept (transport_connection_t * tc, u32 listener_index,
+                         u32 thread_index);
+/**
+ * Initialize session layer for given transport proto and ip version
+ *
+ * Allocates per session type (transport proto + ip version) data structures
+ * and adds arc from session queue node to session type output node.
+ *
+ * @param transport_proto      transport proto to be registered
+ * @param vft                  virtual function table for transport
+ * @param is_ip4               flag that indicates if transports uses ipv4
+ *                             as underlying network layer
+ * @param output_node          output node for transport
+ */
 void session_register_transport (transport_proto_t transport_proto,
                                 const transport_proto_vft_t * vft, u8 is_ip4,
                                 u32 output_node);
+transport_proto_t session_add_transport_proto (void);
 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
                                u32 offset, u32 max_bytes);
 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
@@ -400,14 +555,14 @@ always_inline u32
 transport_rx_fifo_size (transport_connection_t * tc)
 {
   session_t *s = session_get (tc->s_index, tc->thread_index);
-  return s->rx_fifo->nitems;
+  return svm_fifo_size (s->rx_fifo);
 }
 
 always_inline u32
 transport_tx_fifo_size (transport_connection_t * tc)
 {
   session_t *s = session_get (tc->s_index, tc->thread_index);
-  return s->tx_fifo->nitems;
+  return svm_fifo_size (s->tx_fifo);
 }
 
 always_inline u8
@@ -417,16 +572,22 @@ transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
   return svm_fifo_has_ooo_data (s->rx_fifo);
 }
 
-always_inline f64
-transport_dispatch_period (u32 thread_index)
+always_inline clib_time_type_t
+transport_time_now (u32 thread_index)
 {
-  return session_main.wrk[thread_index].dispatch_period;
+  return session_main.wrk[thread_index].last_vlib_time;
 }
 
-always_inline f64
-transport_time_now (u32 thread_index)
+always_inline clib_us_time_t
+transport_us_time_now (u32 thread_index)
 {
-  return session_main.wrk[thread_index].last_vlib_time;
+  return session_main.wrk[thread_index].last_vlib_us_time;
+}
+
+always_inline clib_time_type_t
+transport_seconds_per_loop (u32 thread_index)
+{
+  return session_main.wrk[thread_index].vm->seconds_per_loop;
 }
 
 always_inline void
@@ -482,6 +643,7 @@ listen_session_get (u32 ls_index)
 always_inline void
 listen_session_free (session_t * s)
 {
+  ASSERT (!s->rx_fifo);
   session_free (s);
 }
 
@@ -503,6 +665,14 @@ session_main_get_worker (u32 thread_index)
   return &session_main.wrk[thread_index];
 }
 
+static inline session_worker_t *
+session_main_get_worker_if_valid (u32 thread_index)
+{
+  if (thread_index > vec_len (session_main.wrk))
+    return 0;
+  return &session_main.wrk[thread_index];
+}
+
 always_inline svm_msg_q_t *
 session_main_get_vpp_event_queue (u32 thread_index)
 {
@@ -517,17 +687,46 @@ session_main_is_enabled ()
 
 #define session_cli_return_if_not_enabled()                            \
 do {                                                                   \
-    if (!session_main.is_enabled)                              \
-      return clib_error_return(0, "session layer is not enabled");     \
+    if (!session_main.is_enabled)                                      \
+      return clib_error_return (0, "session layer is not enabled");    \
 } while (0)
 
 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
 int session_main_flush_all_enqueue_events (u8 transport_proto);
-void session_flush_frames_main_thread (vlib_main_t * vm);
-ssvm_private_t *session_main_get_evt_q_segment (void);
+void session_queue_run_on_main_thread (vlib_main_t * vm);
+
+/**
+ * Add session node pending buffer with custom node
+ *
+ * @param thread_index         worker thread expected to send the buffer
+ * @param bi           buffer index
+ * @param next_node    next node edge index for buffer. Edge to next node
+ *                     must exist
+ */
+always_inline void
+session_add_pending_tx_buffer (u32 thread_index, u32 bi, u32 next_node)
+{
+  session_worker_t *wrk = session_main_get_worker (thread_index);
+  vec_add1 (wrk->pending_tx_buffers, bi);
+  vec_add1 (wrk->pending_tx_nexts, next_node);
+  if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
+    vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
+}
+
+always_inline void
+session_wrk_update_time (session_worker_t *wrk, f64 now)
+{
+  wrk->last_vlib_time = now;
+  wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
+}
+
+void session_wrk_enable_adaptive_mode (session_worker_t *wrk);
+fifo_segment_t *session_main_get_evt_q_segment (void);
 void session_node_enable_disable (u8 is_en);
 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
 
+session_t *session_alloc_for_connection (transport_connection_t * tc);
+
 #endif /* __included_session_h__ */
 
 /*