vcl session: switch to generic cert key apis
[vpp.git] / src / vcl / vcl_private.h
index 0506355..7104adc 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Cisco and/or its affiliates.
+ * Copyright (c) 2018-2019 Cisco and/or its affiliates.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this
  * You may obtain a copy of the License at:
@@ -18,7 +18,6 @@
 
 #include <vnet/session/application_interface.h>
 #include <vcl/vppcom.h>
-#include <vcl/vcl_event.h>
 #include <vcl/vcl_debug.h>
 
 #if (CLIB_DEBUG > 0)
 
 #define VPPCOM_DEBUG vcm->debug
 
+extern __thread uword __vcl_worker_index;
+
+static inline void
+vcl_set_worker_index (uword wrk_index)
+{
+  __vcl_worker_index = wrk_index;
+}
+
+static inline uword
+vcl_get_worker_index (void)
+{
+  return __vcl_worker_index;
+}
+
 /*
  * VPPCOM Private definitions and functions.
  */
@@ -43,52 +56,61 @@ typedef enum
   STATE_APP_CONN_VPP,
   STATE_APP_ENABLED,
   STATE_APP_ATTACHED,
-} app_state_t;
+  STATE_APP_ADDING_WORKER,
+  STATE_APP_ADDING_TLS_DATA,
+  STATE_APP_FAILED,
+  STATE_APP_READY
+} vcl_bapi_app_state_t;
 
-typedef enum
+typedef enum vcl_session_state_
 {
-  STATE_START = 0x01,
-  STATE_CONNECT = 0x02,
-  STATE_LISTEN = 0x04,
-  STATE_ACCEPT = 0x08,
-  STATE_CLOSE_ON_EMPTY = 0x10,
-  STATE_DISCONNECT = 0x20,
-  STATE_FAILED = 0x40
-} session_state_t;
-
-#define SERVER_STATE_OPEN  (STATE_ACCEPT|STATE_CLOSE_ON_EMPTY)
-#define CLIENT_STATE_OPEN  (STATE_CONNECT|STATE_CLOSE_ON_EMPTY)
-#define STATE_OPEN (SERVER_STATE_OPEN | CLIENT_STATE_OPEN)
+  VCL_STATE_CLOSED,
+  VCL_STATE_LISTEN,
+  VCL_STATE_READY,
+  VCL_STATE_VPP_CLOSING,
+  VCL_STATE_DISCONNECT,
+  VCL_STATE_DETACHED,
+  VCL_STATE_UPDATED,
+  VCL_STATE_LISTEN_NO_MQ,
+} vcl_session_state_t;
 
 typedef struct epoll_event vppcom_epoll_event_t;
 
 typedef struct
 {
-  u32 next_sid;
-  u32 prev_sid;
-  u32 vep_idx;
+  u32 next_sh;
+  u32 prev_sh;
+  u32 vep_sh;
   vppcom_epoll_event_t ev;
 #define VEP_DEFAULT_ET_MASK  (EPOLLIN|EPOLLOUT)
 #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
   u32 et_mask;
 } vppcom_epoll_t;
 
+/* Select uses the vcl_si_set as if a clib_bitmap. Make sure they are the
+ * same size */
+STATIC_ASSERT (sizeof (clib_bitmap_t) == sizeof (vcl_si_set),
+              "vppcom bitmap size mismatch");
+
 typedef struct
 {
   u8 is_ip4;
   ip46_address_t ip46;
 } vppcom_ip46_t;
 
+#define VCL_ACCEPTED_F_CLOSED  (1 << 0)
+#define VCL_ACCEPTED_F_RESET   (1 << 1)
+
 typedef struct vcl_session_msg
 {
-  u32 next;
   union
   {
     session_accepted_msg_t accepted_msg;
   };
+  u32 flags;
 } vcl_session_msg_t;
 
-enum
+typedef enum
 {
   VCL_SESS_ATTR_SERVER,
   VCL_SESS_ATTR_CUT_THRU,
@@ -104,46 +126,46 @@ enum
   VCL_SESS_ATTR_TCP_NODELAY,   // SOL_TCP,TCP_NODELAY
   VCL_SESS_ATTR_TCP_KEEPIDLE,  // SOL_TCP,TCP_KEEPIDLE
   VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL
+  VCL_SESS_ATTR_SHUT_RD,
+  VCL_SESS_ATTR_SHUT_WR,
   VCL_SESS_ATTR_MAX
 } vppcom_session_attr_t;
 
-#define VCL_SESS_ATTR_SET(ATTR, VAL)            \
-do {                                            \
-  (ATTR) |= 1 << (VAL);                         \
- } while (0)
-
-#define VCL_SESS_ATTR_CLR(ATTR, VAL)            \
-do {                                            \
-  (ATTR) &= ~(1 << (VAL));                      \
- } while (0)
-
-#define VCL_SESS_ATTR_TEST(ATTR, VAL)           \
-  ((ATTR) & (1 << (VAL)) ? 1 : 0)
+typedef enum vcl_session_flags_
+{
+  VCL_SESSION_F_CONNECTED = 1 << 0,
+  VCL_SESSION_F_IS_VEP = 1 << 1,
+  VCL_SESSION_F_IS_VEP_SESSION = 1 << 2,
+  VCL_SESSION_F_HAS_RX_EVT = 1 << 3,
+} __clib_packed vcl_session_flags_t;
 
-typedef struct
+typedef struct vcl_session_
 {
+  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
+
 #define _(type, name) type name;
   foreach_app_session_field
 #undef _
+  vcl_session_flags_t flags;   /**< see @ref vcl_session_flags_t */
+  u32 rx_bytes_pending;                /**< bytes rx-ed as segs but not yet freed */
+
+  svm_fifo_t *ct_rx_fifo;
+  svm_fifo_t *ct_tx_fifo;
+  vcl_session_msg_t *accept_evts_fifo;
+
+  u64 vpp_handle;
+  u64 parent_handle;
+  u32 listener_index;          /**< index of parent listener (if any) */
+  int n_accepted_sessions;     /**< sessions accepted by this listener */
+  vppcom_epoll_t vep;
+  u32 attributes;              /**< see @ref vppcom_session_attr_t */
+  int libc_epfd;
+  u32 ckpair_index;
+
   u32 sndbuf_size;             // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
   u32 rcvbuf_size;             // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
   u32 user_mss;                        // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
-  u8 *segment_name;
-  u32 sm_seg_index;
-  u32 client_context;
-  u64 vpp_handle;
 
-  /* Socket configuration state */
-  u8 is_vep;
-  u8 is_vep_session;
-  u32 attr;
-  u32 wait_cont_idx;
-  vppcom_epoll_t vep;
-  int libc_epfd;
-  svm_msg_q_t *our_evt_q;
-  u64 options[16];
-  vce_event_handler_reg_t *poll_reg;
-  vcl_session_msg_t *accept_evts_fifo;
 #if VCL_ELOG
   elog_track_t elog_track;
 #endif
@@ -151,11 +173,11 @@ typedef struct
 
 typedef struct vppcom_cfg_t_
 {
-  u64 heapsize;
-  u32 vpp_api_q_length;
-  u64 segment_baseva;
-  u32 segment_size;
-  u32 add_segment_size;
+  uword heapsize;
+  u32 max_workers;
+  uword segment_baseva;
+  uword segment_size;
+  uword add_segment_size;
   u32 preallocated_fifo_pairs;
   u32 rx_fifo_size;
   u32 tx_fifo_size;
@@ -173,8 +195,10 @@ typedef struct vppcom_cfg_t_
   f64 accept_timeout;
   u32 event_ring_size;
   char *event_log_path;
-  u8 *vpp_api_filename;
-  u8 *vpp_api_socket_name;
+  u8 *vpp_app_socket_api;      /**< app socket api socket file name */
+  u8 *vpp_bapi_socket_name;    /**< bapi socket transport socket name */
+  u32 tls_engine;
+  u8 mt_wrk_supported;
 } vppcom_cfg_t;
 
 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
@@ -194,24 +218,30 @@ typedef struct vcl_mq_evt_conn_
   int mq_fd;
 } vcl_mq_evt_conn_t;
 
-typedef struct vppcom_main_t_
+typedef struct vcl_worker_
 {
-  u8 init;
-  u32 debug;
-  int main_cpu;
+  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
+
+  /* Session pool */
+  vcl_session_t *sessions;
+
+  /** Worker/thread index in current process */
+  u32 wrk_index;
 
-  /* FIFO for accepted connections - used in epoll/select */
-  clib_spinlock_t session_fifo_lockp;
-  u32 *client_session_index_fifo;
+  /** Worker index in vpp*/
+  u32 vpp_wrk_index;
 
-  /* vpp input queue */
+  /**
+   * Generic api client handle. When binary api is in used, it stores
+   * the "client_index" and when socket api is use, it stores the sapi
+   * client handle */
+  u32 api_client_handle;
+
+  /** VPP binary api input queue */
   svm_queue_t *vl_input_queue;
 
-  /* API client handle */
-  u32 my_client_index;
-  /* Session pool */
-  clib_spinlock_t sessions_lockp;
-  vcl_session_t *sessions;
+  /** VPP mq to be used for exchanging control messages */
+  svm_msg_q_t *ctrl_mq;
 
   /** Message queues epoll fd. Initialized only if using mqs with eventfds */
   int mqs_epfd;
@@ -222,52 +252,100 @@ typedef struct vppcom_main_t_
   /** Per worker buffer for receiving mq epoll events */
   struct epoll_event *mq_events;
 
-  /* Hash table for disconnect processing */
+  /** Hash table for disconnect processing */
   uword *session_index_by_vpp_handles;
 
-  /* Select bitmaps */
+  /** Select bitmaps */
   clib_bitmap_t *rd_bitmap;
   clib_bitmap_t *wr_bitmap;
   clib_bitmap_t *ex_bitmap;
 
-  /* Our event queue */
+  /** Our event message queue */
   svm_msg_q_t *app_event_queue;
 
-  svm_msg_q_t **vpp_event_queues;
+  /** For deadman timers */
+  clib_time_t clib_time;
 
-  /* unique segment name counter */
-  u32 unique_segment_index;
+  /** Vector acting as buffer for mq messages */
+  svm_msg_q_msg_t *mq_msg_vector;
 
-  /* For deadman timers */
-  clib_time_t clib_time;
+  /** Vector of unhandled events */
+  session_event_t *unhandled_evts_vector;
+
+  u32 *pending_session_wrk_updates;
+
+  /** Used also as a thread stop key buffer */
+  pthread_t thread_id;
+
+  /** Current pid, may be different from main_pid if forked child */
+  pid_t current_pid;
+
+  u32 forked_child;
+
+  clib_socket_t app_api_sock;
+  socket_client_main_t bapi_sock_ctx;
+  api_main_t bapi_api_ctx;
 
   /* State of the connection, shared between msg RX thread and main thread */
-  volatile app_state_t app_state;
+  volatile vcl_bapi_app_state_t bapi_app_state;
+  volatile uword bapi_return;
 
+  /** vcl needs next epoll_create to go to libc_epoll */
+  u8 vcl_needs_real_epoll;
+  volatile int rpc_done;
+} vcl_worker_t;
+
+STATIC_ASSERT (sizeof (session_disconnected_msg_t) <= 16,
+              "disconnected must fit in session_event_t");
+STATIC_ASSERT (sizeof (session_reset_msg_t) <= 16,
+              "disconnected must fit in session_event_t");
+
+typedef void (vcl_rpc_fn_t) (void *args);
+
+typedef struct vppcom_main_t_
+{
+  u8 is_init;
+  u32 debug;
+  pthread_t main_cpu;
+
+  /** Main process pid */
+  pid_t main_pid;
+
+  /** App's index in vpp. It's used by vpp to identify the app */
+  u32 app_index;
+
+  u8 *app_name;
+
+  /** VCL configuration */
   vppcom_cfg_t cfg;
 
-  /* Event thread */
-  vce_event_thread_t event_thread;
+  volatile u32 forking;
 
-  /* IO thread */
-  vppcom_session_io_thread_t session_io_thread;
+  /** Workers */
+  vcl_worker_t *workers;
 
-  /* pool of ctrl msgs */
-  vcl_session_msg_t *ctrl_evt_pool;
+  /** Lock to protect worker registrations */
+  clib_spinlock_t workers_lock;
 
-  /** Pool of cut through registrations */
-  vcl_cut_through_registration_t *cut_through_registrations;
+  /** Lock to protect segment hash table */
+  clib_rwlock_t segment_table_lock;
 
-  /** Lock for accessing ct registration pool */
-  clib_spinlock_t ct_registration_lock;
+  /** Mapped segments table */
+  uword *segment_table;
 
-  /** Cut-through registration by mq address hash table */
-  uword *ct_registration_by_mq;
+  /** Control mq obtained from attach */
+  svm_msg_q_t *ctrl_mq;
 
-  svm_msg_q_msg_t *mq_msg_vector;
+  fifo_segment_main_t segment_main;
+
+  vcl_rpc_fn_t *wrk_rpc_fn;
 
-  /** Flag indicating that a new segment is being mounted */
-  volatile u32 mounting_segment;
+  /*
+   * Binary api context
+   */
+
+  /* VNET_API_ERROR_FOO -> "Foo" hash table */
+  uword *error_string_by_error_number;
 
 #ifdef VCL_ELOG
   /* VPP Event-logger */
@@ -275,186 +353,374 @@ typedef struct vppcom_main_t_
   elog_track_t elog_track;
 #endif
 
-  /* VNET_API_ERROR_FOO -> "Foo" hash table */
-  uword *error_string_by_error_number;
 } vppcom_main_t;
 
 extern vppcom_main_t *vcm;
-
-#define VCL_SESSION_LOCK_AND_GET(I, S)                          \
-do {                                                            \
-  clib_spinlock_lock (&vcm->sessions_lockp);                    \
-  rv = vppcom_session_at_index (I, S);                          \
-  if (PREDICT_FALSE (rv))                                       \
-    {                                                           \
-      clib_spinlock_unlock (&vcm->sessions_lockp);              \
-      clib_warning ("VCL<%d>: ERROR: Invalid ##I (%u)!",        \
-                    getpid (), I);                              \
-      goto done;                                                \
-    }                                                           \
-} while (0)
-
-#define VCL_SESSION_LOCK() clib_spinlock_lock (&(vcm->sessions_lockp))
-#define VCL_SESSION_UNLOCK() clib_spinlock_unlock (&(vcm->sessions_lockp))
-
-#define VCL_IO_SESSIONS_LOCK() \
-  clib_spinlock_lock (&(vcm->session_io_thread.io_sessions_lockp))
-#define VCL_IO_SESSIONS_UNLOCK() \
-  clib_spinlock_unlock (&(vcm->session_io_thread.io_sessions_lockp))
-
-#define VCL_ACCEPT_FIFO_LOCK() clib_spinlock_lock (&(vcm->session_fifo_lockp))
-#define VCL_ACCEPT_FIFO_UNLOCK() \
-  clib_spinlock_unlock (&(vcm->session_fifo_lockp))
-
-#define VCL_EVENTS_LOCK() \
-  clib_spinlock_lock (&(vcm->event_thread.events_lockp))
-#define VCL_EVENTS_UNLOCK() \
-  clib_spinlock_unlock (&(vcm->event_thread.events_lockp))
+extern vppcom_main_t _vppcom_main;
 
 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
+#define VCL_INVALID_SESSION_HANDLE ((u64)~0)
+#define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
+#define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
 
 static inline vcl_session_t *
-vcl_session_alloc (void)
+vcl_session_alloc (vcl_worker_t * wrk)
 {
   vcl_session_t *s;
-  pool_get (vcm->sessions, s);
+  pool_get (wrk->sessions, s);
   memset (s, 0, sizeof (*s));
+  s->session_index = s - wrk->sessions;
+  s->listener_index = VCL_INVALID_SESSION_INDEX;
   return s;
 }
 
 static inline void
-vcl_session_free (vcl_session_t * s)
+vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
 {
-  pool_put (vcm->sessions, s);
+  /* Debug level set to 1 to avoid debug messages while ldp is cleaning up */
+  VDBG (1, "session %u [0x%llx] removed", s->session_index, s->vpp_handle);
+  pool_put (wrk->sessions, s);
 }
 
 static inline vcl_session_t *
-vcl_session_get (u32 session_index)
+vcl_session_get (vcl_worker_t * wrk, u32 session_index)
 {
-  if (pool_is_free_index (vcm->sessions, session_index))
+  if (pool_is_free_index (wrk->sessions, session_index))
     return 0;
-  return pool_elt_at_index (vcm->sessions, session_index);
+  return pool_elt_at_index (wrk->sessions, session_index);
 }
 
-static inline u32
-vcl_session_index (vcl_session_t * s)
+static inline vcl_session_handle_t
+vcl_session_handle_from_wrk_session_index (u32 session_index, u32 wrk_index)
+{
+  ASSERT (session_index < 2 << 24);
+  return (wrk_index << 24 | session_index);
+}
+
+static inline vcl_session_handle_t
+vcl_session_handle_from_index (u32 session_index)
+{
+  ASSERT (session_index < 2 << 24);
+  return (vcl_get_worker_index () << 24 | session_index);
+}
+
+static inline vcl_session_handle_t
+vcl_session_handle (vcl_session_t * s)
+{
+  return vcl_session_handle_from_index (s->session_index);
+}
+
+static inline void
+vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
 {
-  return (s - vcm->sessions);
+  *wrk_index = handle >> 24;
+  *session_index = handle & 0xFFFFFF;
 }
 
 static inline vcl_session_t *
-vcl_session_get_w_handle (u64 handle)
+vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
+{
+  u32 session_index, wrk_index;
+  vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
+  ASSERT (wrk_index == wrk->wrk_index);
+  return vcl_session_get (wrk, session_index);
+}
+
+static inline vcl_session_t *
+vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 {
   uword *p;
-  if ((p = hash_get (vcm->session_index_by_vpp_handles, handle)))
-    return vcl_session_get ((u32) p[0]);
+  if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
+    return vcl_session_get (wrk, (u32) p[0]);
   return 0;
 }
 
 static inline u32
-vcl_session_get_index_from_handle (u64 handle)
+vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 {
   uword *p;
-  if ((p = hash_get (vcm->session_index_by_vpp_handles, handle)))
+  if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
     return p[0];
   return VCL_INVALID_SESSION_INDEX;
 }
 
-static inline u8
-vcl_session_is_ct (vcl_session_t * s)
+static inline void
+vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
 {
-  return (s->our_evt_q != 0);
+  hash_set (wrk->session_index_by_vpp_handles, handle, value);
 }
 
-static inline int
-vppcom_session_at_index (u32 session_index, vcl_session_t * volatile *sess)
+static inline void
+vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
 {
-  /* Assumes that caller has acquired spinlock: vcm->sessions_lockp */
-  if (PREDICT_FALSE ((session_index == ~0) ||
-                    pool_is_free_index (vcm->sessions, session_index)))
-    {
-      clib_warning ("VCL<%d>: invalid session, sid (%u) has been closed!",
-                   getpid (), session_index);
-      return VPPCOM_EBADFD;
-    }
-  *sess = pool_elt_at_index (vcm->sessions, session_index);
-  return VPPCOM_OK;
+  hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
+}
+
+static inline uword *
+vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
+{
+  return hash_get (wrk->session_index_by_vpp_handles, handle);
+}
+
+static inline void
+vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
+                               u32 value)
+{
+  hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
 }
 
 static inline void
-vppcom_session_table_add_listener (u64 listener_handle, u32 value)
+vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
+{
+  hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
+}
+
+static inline int
+vcl_session_is_connectable_listener (vcl_worker_t * wrk,
+                                    vcl_session_t * session)
 {
-  /* Session and listener handles have different formats. The latter has
-   * the thread index in the upper 32 bits while the former has the session
-   * type. Knowing that, for listeners we just flip the MSB to 1 */
-  listener_handle |= 1ULL << 63;
-  hash_set (vcm->session_index_by_vpp_handles, listener_handle, value);
+  /* Tell if we session_handle is a QUIC session.
+   * We can be in the following cases :
+   * Listen session <- QUIC session <- Stream session
+   * QUIC session <- Stream session
+   */
+  vcl_session_t *ls;
+  if (session->session_type != VPPCOM_PROTO_QUIC)
+    return 0;
+  if (session->listener_index == VCL_INVALID_SESSION_INDEX)
+    return !(session->session_state == VCL_STATE_LISTEN);
+  ls = vcl_session_get_w_handle (wrk, session->listener_index);
+  if (!ls)
+    return VPPCOM_EBADFD;
+  return ls->session_state == VCL_STATE_LISTEN;
 }
 
 static inline vcl_session_t *
-vppcom_session_table_lookup_listener (u64 listener_handle)
+vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
 {
   uword *p;
-  u64 handle = listener_handle | (1ULL << 63);
-  vcl_session_t *session;
+  vcl_session_t *s;
 
-  p = hash_get (vcm->session_index_by_vpp_handles, handle);
+  p = hash_get (wrk->session_index_by_vpp_handles, handle);
   if (!p)
     {
-      clib_warning ("VCL<%d>: couldn't find listen session: unknown vpp "
-                   "listener handle %llx", getpid (), listener_handle);
+      VDBG (0, "could not find listen session: unknown vpp listener handle"
+           " %llx", handle);
       return 0;
     }
-  if (pool_is_free_index (vcm->sessions, p[0]))
+  s = vcl_session_get (wrk, p[0]);
+  if (!s)
     {
-      VDBG (1, "VCL<%d>: invalid listen session, sid (%u)", getpid (), p[0]);
+      VDBG (1, "invalid listen session index (%u)", p[0]);
       return 0;
     }
 
-  session = pool_elt_at_index (vcm->sessions, p[0]);
-  ASSERT (session->session_state & STATE_LISTEN);
-  return session;
+  ASSERT (s->session_state == VCL_STATE_LISTEN
+         || s->session_state == VCL_STATE_LISTEN_NO_MQ
+         || vcl_session_is_connectable_listener (wrk, s));
+  return s;
+}
+
+const char *vppcom_session_state_str (vcl_session_state_t state);
+
+static inline u8
+vcl_session_is_ct (vcl_session_t * s)
+{
+  return (s->ct_tx_fifo != 0);
+}
+
+static inline u8
+vcl_session_is_cl (vcl_session_t * s)
+{
+  if (s->session_type == VPPCOM_PROTO_UDP)
+    return !(s->flags & VCL_SESSION_F_CONNECTED);
+  return 0;
+}
+
+static inline u8
+vcl_session_has_crypto (vcl_session_t *s)
+{
+  return (s->session_type == VPPCOM_PROTO_TLS ||
+         s->session_type == VPPCOM_PROTO_QUIC);
+}
+
+static inline u8
+vcl_session_is_ready (vcl_session_t * s)
+{
+  return (s->session_state == VCL_STATE_READY
+         || s->session_state == VCL_STATE_VPP_CLOSING);
+}
+
+static inline u8
+vcl_session_is_open (vcl_session_t * s)
+{
+  return ((vcl_session_is_ready (s))
+         || (s->session_state == VCL_STATE_LISTEN && vcl_session_is_cl (s)));
+}
+
+static inline u8
+vcl_session_is_closing (vcl_session_t * s)
+{
+  return (s->session_state == VCL_STATE_VPP_CLOSING
+         || s->session_state == VCL_STATE_DISCONNECT);
+}
+
+static inline u8
+vcl_session_is_closed (vcl_session_t * s)
+{
+  return (!s || (s->session_state == VCL_STATE_CLOSED));
+}
+
+static inline int
+vcl_session_closing_error (vcl_session_t * s)
+{
+  /* Return 0 on closing sockets */
+  return s->session_state == VCL_STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
+}
+
+static inline int
+vcl_session_closed_error (vcl_session_t * s)
+{
+  return s->session_state == VCL_STATE_DISCONNECT
+    ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
+}
+
+static inline void
+vcl_ip_copy_from_ep (ip46_address_t * ip, vppcom_endpt_t * ep)
+{
+  if (ep->is_ip4)
+    clib_memcpy_fast (&ip->ip4, ep->ip, sizeof (ip4_address_t));
+  else
+    clib_memcpy_fast (&ip->ip6, ep->ip, sizeof (ip6_address_t));
+}
+
+static inline void
+vcl_ip_copy_to_ep (ip46_address_t * ip, vppcom_endpt_t * ep, u8 is_ip4)
+{
+  ep->is_ip4 = is_ip4;
+  if (is_ip4)
+    clib_memcpy_fast (ep->ip, &ip->ip4, sizeof (ip4_address_t));
+  else
+    clib_memcpy_fast (ep->ip, &ip->ip6, sizeof (ip6_address_t));
 }
 
-const char *vppcom_session_state_str (session_state_t state);
+static inline int
+vcl_proto_is_dgram (uint8_t proto)
+{
+  return proto == VPPCOM_PROTO_UDP;
+}
+
+static inline u8
+vcl_session_has_attr (vcl_session_t * s, u8 attr)
+{
+  return (s->attributes & (1 << attr)) ? 1 : 0;
+}
+
+static inline void
+vcl_session_set_attr (vcl_session_t * s, u8 attr)
+{
+  s->attributes |= 1 << attr;
+}
+
+static inline void
+vcl_session_clear_attr (vcl_session_t * s, u8 attr)
+{
+  s->attributes &= ~(1 << attr);
+}
 
 /*
  * Helpers
  */
-vcl_cut_through_registration_t *vcl_ct_registration_lock_and_alloc (void);
-void vcl_ct_registration_del (vcl_cut_through_registration_t * ctr);
-u32 vcl_ct_registration_index (vcl_cut_through_registration_t * ctr);
-void vcl_ct_registration_unlock (void);
-vcl_cut_through_registration_t *vcl_ct_registration_get (u32 ctr_index);
-vcl_cut_through_registration_t *vcl_ct_registration_lock_and_lookup (uword);
-void vcl_ct_registration_lookup_add (uword mq_addr, u32 ctr_index);
-void vcl_ct_registration_lookup_del (uword mq_addr);
-vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (void);
-u32 vcl_mq_evt_conn_index (vcl_mq_evt_conn_t * mqc);
-vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (u32 mq_conn_idx);
-int vcl_mq_epoll_add_evfd (svm_msg_q_t * mq);
-int vcl_mq_epoll_del_evfd (u32 mqc_index);
+vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
+u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
+vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
+int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
+int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
+
+vcl_worker_t *vcl_worker_alloc_and_init (void);
+void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
+int vcl_worker_register_with_vpp (void);
+svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
+
+void vcl_flush_mq_events (void);
+int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
+                        vcl_session_handle_t sh, u8 do_disconnect);
+
+void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
+u32 vcl_segment_table_lookup (u64 segment_handle);
+void vcl_segment_table_del (u64 segment_handle);
+
+int vcl_session_read_ready (vcl_session_t * session);
+int vcl_session_write_ready (vcl_session_t * session);
+
+static inline vcl_worker_t *
+vcl_worker_get (u32 wrk_index)
+{
+  return pool_elt_at_index (vcm->workers, wrk_index);
+}
+
+static inline vcl_worker_t *
+vcl_worker_get_if_valid (u32 wrk_index)
+{
+  if (pool_is_free_index (vcm->workers, wrk_index))
+    return 0;
+  return pool_elt_at_index (vcm->workers, wrk_index);
+}
+
+static inline vcl_worker_t *
+vcl_worker_get_current (void)
+{
+  return vcl_worker_get (vcl_get_worker_index ());
+}
+
+static inline u8
+vcl_n_workers (void)
+{
+  return pool_elts (vcm->workers);
+}
+
+static inline u64
+vcl_vpp_worker_segment_handle (u32 wrk_index)
+{
+  return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
+}
+
+void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
+                                    u32 wrk_index);
+int vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len);
+
+int vcl_segment_attach (u64 segment_handle, char *name,
+                       ssvm_segment_type_t type, int fd);
+void vcl_segment_detach (u64 segment_handle);
+void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
+
+int vcl_segment_attach_session (uword segment_handle, uword rxf_offset,
+                               uword txf_offset, uword mq_offset, u8 is_ct,
+                               vcl_session_t *s);
+int vcl_segment_attach_mq (uword segment_handle, uword mq_offset, u32 mq_index,
+                          svm_msg_q_t **mq);
 
 /*
  * VCL Binary API
  */
-int vppcom_connect_to_vpp (char *app_name);
-void vppcom_init_error_string_table (void);
-void vppcom_send_session_enable_disable (u8 is_enable);
-void vppcom_app_send_attach (void);
-void vppcom_app_send_detach (void);
-void vppcom_send_connect_sock (vcl_session_t * session, u32 session_index);
-void vppcom_send_disconnect_session_reply (u64 vpp_handle, u32 session_index,
-                                          int rv);
-void vppcom_send_disconnect_session (u64 vpp_handle, u32 session_index);
-void vppcom_send_bind_sock (vcl_session_t * session, u32 session_index);
-void vppcom_send_unbind_sock (u64 vpp_handle);
-void vppcom_api_hookup (void);
-void vppcom_send_accept_session_reply (u64 handle, u32 context, int retval);
-
-u32 vcl_max_nsid_len (void);
-
-u8 *format_api_error (u8 * s, va_list * args);
+int vcl_bapi_attach (void);
+int vcl_bapi_app_worker_add (void);
+void vcl_bapi_app_worker_del (vcl_worker_t * wrk);
+void vcl_bapi_disconnect_from_vpp (void);
+int vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
+int vcl_bapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
+int vcl_bapi_del_cert_key_pair (u32 ckpair_index);
+u32 vcl_bapi_max_nsid_len (void);
+int vcl_bapi_worker_set (void);
+
+/*
+ * VCL Socket API
+ */
+int vcl_sapi_attach (void);
+int vcl_sapi_app_worker_add (void);
+void vcl_sapi_app_worker_del (vcl_worker_t * wrk);
+void vcl_sapi_detach (vcl_worker_t * wrk);
+int vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
 
 #endif /* SRC_VCL_VCL_PRIVATE_H_ */