Add TLS support for VCL
[vpp.git] / src / vcl / vcl_private.h
index ba9094c..9dce518 100644 (file)
@@ -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)
@@ -68,13 +67,13 @@ typedef enum
   STATE_CONNECT = 0x02,
   STATE_LISTEN = 0x04,
   STATE_ACCEPT = 0x08,
-  STATE_CLOSE_ON_EMPTY = 0x10,
+  STATE_VPP_CLOSING = 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 SERVER_STATE_OPEN  (STATE_ACCEPT|STATE_VPP_CLOSING)
+#define CLIENT_STATE_OPEN  (STATE_CONNECT|STATE_VPP_CLOSING)
 #define STATE_OPEN (SERVER_STATE_OPEN | CLIENT_STATE_OPEN)
 
 typedef struct epoll_event vppcom_epoll_event_t;
@@ -96,6 +95,9 @@ typedef struct
   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;
@@ -103,6 +105,7 @@ typedef struct vcl_session_msg
   {
     session_accepted_msg_t accepted_msg;
   };
+  u32 flags;
 } vcl_session_msg_t;
 
 enum
@@ -137,8 +140,15 @@ do {                                            \
 #define VCL_SESS_ATTR_TEST(ATTR, VAL)           \
   ((ATTR) & (1 << (VAL)) ? 1 : 0)
 
+typedef struct vcl_shared_session_
+{
+  u32 ss_index;
+  u32 *workers;
+} vcl_shared_session_t;
+
 typedef struct
 {
+  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 #define _(type, name) type name;
   foreach_app_session_field
 #undef _
@@ -149,10 +159,12 @@ typedef struct
   u32 sm_seg_index;
   u32 client_context;
   u64 vpp_handle;
+  u32 vpp_thread_index;
 
   /* Socket configuration state */
   u8 is_vep;
   u8 is_vep_session;
+  u8 has_rx_evt;
   u32 attr;
   u32 wait_cont_idx;
   vppcom_epoll_t vep;
@@ -160,6 +172,7 @@ typedef struct
   svm_msg_q_t *our_evt_q;
   u64 options[16];
   vcl_session_msg_t *accept_evts_fifo;
+  u32 shared_index;
 #if VCL_ELOG
   elog_track_t elog_track;
 #endif
@@ -167,10 +180,10 @@ typedef struct
 
 typedef struct vppcom_cfg_t_
 {
-  u64 heapsize;
+  uword heapsize;
   u32 max_workers;
   u32 vpp_api_q_length;
-  u64 segment_baseva;
+  uword segment_baseva;
   u32 segment_size;
   u32 add_segment_size;
   u32 preallocated_fifo_pairs;
@@ -218,8 +231,21 @@ typedef struct vcl_worker_
   /* Session pool */
   vcl_session_t *sessions;
 
+  /** Worker/thread index in current process */
   u32 wrk_index;
 
+  /** Worker index in vpp*/
+  u32 vpp_wrk_index;
+
+  /** API client handle */
+  u32 my_client_index;
+
+  /** State of the connection, shared between msg RX thread and main thread */
+  volatile app_state_t wrk_state;
+
+  /** VPP binary api input queue */
+  svm_queue_t *vl_input_queue;
+
   /** Message queues epoll fd. Initialized only if using mqs with eventfds */
   int mqs_epfd;
 
@@ -257,6 +283,18 @@ typedef struct vcl_worker_
 
   /** Vector acting as buffer for mq messages */
   svm_msg_q_msg_t *mq_msg_vector;
+
+  /** Vector of unhandled events */
+  session_event_t *unhandled_evts_vector;
+
+  /** 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;
+
 } vcl_worker_t;
 
 typedef struct vppcom_main_t_
@@ -265,24 +303,39 @@ typedef struct vppcom_main_t_
   u32 debug;
   pthread_t main_cpu;
 
-  /** VPP binary api input queue */
-  svm_queue_t *vl_input_queue;
+  /** Main process pid */
+  pid_t main_pid;
 
-  /** API client handle */
-  u32 my_client_index;
+  /** App's index in vpp. It's used by vpp to identify the app */
+  u32 app_index;
 
   /** State of the connection, shared between msg RX thread and main thread */
   volatile app_state_t app_state;
 
+  u8 *app_name;
+
   /** VCL configuration */
   vppcom_cfg_t cfg;
 
-  /** Flag indicating that a new segment is being mounted */
-  volatile u32 mounting_segment;
+  volatile u32 forking;
 
   /** Workers */
   vcl_worker_t *workers;
 
+  /** Lock to protect worker registrations */
+  clib_spinlock_t workers_lock;
+
+  /** Pool of shared sessions */
+  vcl_shared_session_t *shared_sessions;
+
+  /** Lock to protect segment hash table */
+  clib_rwlock_t segment_table_lock;
+
+  /** Mapped segments table */
+  uword *segment_table;
+
+  svm_fifo_segment_main_t segment_main;
+
 #ifdef VCL_ELOG
   /* VPP Event-logger */
   elog_main_t elog_main;
@@ -292,18 +345,13 @@ typedef struct vppcom_main_t_
   /* VNET_API_ERROR_FOO -> "Foo" hash table */
   uword *error_string_by_error_number;
 
-  /* Obsolete */
-
-  /* Event thread */
-  vce_event_thread_t event_thread;
-
-  /* IO thread */
-  vppcom_session_io_thread_t session_io_thread;
 } vppcom_main_t;
 
 extern vppcom_main_t *vcm;
 
 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
+#define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
+#define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
 
 static inline vcl_session_t *
 vcl_session_alloc (vcl_worker_t * wrk)
@@ -312,6 +360,7 @@ vcl_session_alloc (vcl_worker_t * wrk)
   pool_get (wrk->sessions, s);
   memset (s, 0, sizeof (*s));
   s->session_index = s - wrk->sessions;
+  s->shared_index = ~0;
   return s;
 }
 
@@ -463,6 +512,16 @@ 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);
+int vcl_worker_set_bapi (void);
+void vcl_worker_share_sessions (vcl_worker_t * parent_wrk);
+int vcl_worker_unshare_session (vcl_worker_t * wrk, vcl_session_t * s);
+int vcl_session_get_refcnt (vcl_session_t * s);
+
+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);
 
 static inline vcl_worker_t *
 vcl_worker_get (u32 wrk_index)
@@ -470,6 +529,14 @@ 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)
 {
@@ -490,7 +557,13 @@ void vppcom_send_bind_sock (vcl_session_t * session);
 void vppcom_send_unbind_sock (u64 vpp_handle);
 void vppcom_api_hookup (void);
 void vppcom_send_accept_session_reply (u64 vpp_handle, u32 context, int rv);
+void vppcom_send_application_tls_cert_add (vcl_session_t * session,
+                                          char *cert, u32 cert_len);
+void
+vppcom_send_application_tls_key_add (vcl_session_t * session, char *key,
+                                    u32 key_len);
 void vcl_send_app_worker_add_del (u8 is_add);
+void vcl_send_child_worker_del (vcl_worker_t * wrk);
 
 u32 vcl_max_nsid_len (void);