ldp: basic multiworker support

[vpp.git] / src / vcl / vppcom.h

diff --git a/src/vcl/vppcom.h b/src/vcl/vppcom.h
index c79b90c..0c0b7ce 100644 (file)
--- a/src/vcl/vppcom.h
+++ b/src/vcl/vppcom.h
@@ -31,17 +31,18 @@ extern "C"
 /*
  * VPPCOM Public API Definitions, Enums, and Data Structures
  */
-#define INVALID_SESSION_ID                   (~0)
-#define VPPCOM_VRF_DEFAULT                   0
-#define VPPCOM_CONF_DEFAULT                  "/etc/vpp/vcl.conf"
-#define VPPCOM_ENV_CONF                      "VCL_CONFIG"
-#define VPPCOM_ENV_DEBUG                     "VCL_DEBUG"
-#define VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP   "VCL_APP_PROXY_TRANSPORT_TCP"
-#define VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP   "VCL_APP_PROXY_TRANSPORT_UDP"
-#define VPPCOM_ENV_APP_NAMESPACE_ID          "VCL_APP_NAMESPACE_ID"
-#define VPPCOM_ENV_APP_NAMESPACE_SECRET      "VCL_APP_NAMESPACE_SECRET"
-#define VPPCOM_ENV_APP_SCOPE_LOCAL           "VCL_APP_SCOPE_LOCAL"
-#define VPPCOM_ENV_APP_SCOPE_GLOBAL          "VCL_APP_SCOPE_GLOBAL"
+#define INVALID_SESSION_ID                     (~0)
+#define VPPCOM_CONF_DEFAULT                    "/etc/vpp/vcl.conf"
+#define VPPCOM_ENV_CONF                        "VCL_CONFIG"
+#define VPPCOM_ENV_DEBUG                       "VCL_DEBUG"
+#define VPPCOM_ENV_API_PREFIX                  "VCL_API_PREFIX"
+#define VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP     "VCL_APP_PROXY_TRANSPORT_TCP"
+#define VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP     "VCL_APP_PROXY_TRANSPORT_UDP"
+#define VPPCOM_ENV_APP_NAMESPACE_ID            "VCL_APP_NAMESPACE_ID"
+#define VPPCOM_ENV_APP_NAMESPACE_SECRET        "VCL_APP_NAMESPACE_SECRET"
+#define VPPCOM_ENV_APP_SCOPE_LOCAL             "VCL_APP_SCOPE_LOCAL"
+#define VPPCOM_ENV_APP_SCOPE_GLOBAL            "VCL_APP_SCOPE_GLOBAL"
+#define VPPCOM_ENV_VPP_API_SOCKET              "VCL_VPP_API_SOCKET"
 
 typedef enum
 {
@@ -77,7 +78,6 @@ typedef enum
 
 typedef struct vppcom_endpt_t_
 {
-  uint32_t vrf;
   uint8_t is_cut_thru;
   uint8_t is_ip4;
   uint8_t *ip;
@@ -88,6 +88,7 @@ typedef enum
 {
   VPPCOM_OK = 0,
   VPPCOM_EAGAIN = -EAGAIN,
+  VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
   VPPCOM_EFAULT = -EFAULT,
   VPPCOM_ENOMEM = -ENOMEM,
   VPPCOM_EINVAL = -EINVAL,
@@ -98,6 +99,7 @@ typedef enum
   VPPCOM_ENOTCONN = -ENOTCONN,
   VPPCOM_ECONNREFUSED = -ECONNREFUSED,
   VPPCOM_ETIMEDOUT = -ETIMEDOUT,
+  VPPCOM_EEXIST = -EEXIST
 } vppcom_error_t;
 
 typedef enum
@@ -142,9 +144,17 @@ typedef struct _vcl_poll
   uint32_t fds_ndx;
   uint32_t sid;
   short events;
-  short *revents;
+  short revents;
 } vcl_poll_t;
 
+typedef struct vppcom_data_segment_
+{
+  unsigned char *data;
+  uint32_t len;
+} vppcom_data_segment_t;
+
+typedef vppcom_data_segment_t vppcom_data_segments_t[2];
+
 /*
  * VPPCOM Public API Functions
  */
@@ -215,19 +225,19 @@ vppcom_retval_str (int retval)
 extern int vppcom_app_create (char *app_name);
 extern void vppcom_app_destroy (void);
 
-extern int vppcom_session_create (uint32_t vrf, uint8_t proto,
-                                 uint8_t is_nonblocking);
-extern int vppcom_session_close (uint32_t session_index);
+extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
+extern int vppcom_session_close (uint32_t session_handle);
+extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
+extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
 
-extern int vppcom_session_bind (uint32_t session_index, vppcom_endpt_t * ep);
-extern int vppcom_session_listen (uint32_t session_index, uint32_t q_len);
-extern int vppcom_session_accept (uint32_t session_index,
+extern int vppcom_session_accept (uint32_t session_handle,
                                  vppcom_endpt_t * client_ep, uint32_t flags);
 
-extern int vppcom_session_connect (uint32_t session_index,
+extern int vppcom_session_connect (uint32_t session_handle,
                                   vppcom_endpt_t * server_ep);
-extern int vppcom_session_read (uint32_t session_index, void *buf, size_t n);
-extern int vppcom_session_write (uint32_t session_index, void *buf, size_t n);
+extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
+extern int vppcom_session_write (uint32_t session_handle, void *buf,
+                                size_t n);
 
 extern int vppcom_select (unsigned long n_bits,
                          unsigned long *read_map,
@@ -235,21 +245,44 @@ extern int vppcom_select (unsigned long n_bits,
                          unsigned long *except_map, double wait_for_time);
 
 extern int vppcom_epoll_create (void);
-extern int vppcom_epoll_ctl (uint32_t vep_idx, int op,
-                            uint32_t session_index,
+extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
+                            uint32_t session_handle,
                             struct epoll_event *event);
-extern int vppcom_epoll_wait (uint32_t vep_idx, struct epoll_event *events,
+extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
                              int maxevents, double wait_for_time);
-extern int vppcom_session_attr (uint32_t session_index, uint32_t op,
+extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
                                void *buffer, uint32_t * buflen);
-extern int vppcom_session_recvfrom (uint32_t session_index, void *buffer,
+extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
                                    uint32_t buflen, int flags,
                                    vppcom_endpt_t * ep);
-extern int vppcom_session_sendto (uint32_t session_index, void *buffer,
+extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
                                  uint32_t buflen, int flags,
                                  vppcom_endpt_t * ep);
 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
                        double wait_for_time);
+extern int vppcom_mq_epoll_fd (void);
+extern int vppcom_session_index (uint32_t session_handle);
+extern int vppcom_session_handle (uint32_t session_index);
+
+extern int vppcom_session_read_segments (uint32_t session_handle,
+                                        vppcom_data_segments_t ds);
+extern void vppcom_session_free_segments (uint32_t session_handle,
+                                         vppcom_data_segments_t ds);
+extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
+                                    uint32_t max_bytes);
+
+/**
+ * Request from application to register a new worker
+ *
+ * Expectation is that applications will make use of this after a new pthread
+ * is spawned.
+ */
+extern int vppcom_worker_register (void);
+
+/**
+ * Retrieve current worker index
+ */
+extern int vppcom_worker_index (void);
 
 /* *INDENT-OFF* */
 #ifdef __cplusplus