vcl: add support for multi-worker apps
[vpp.git] / src / vcl / vppcom.h
index 45ff116..b5e7532 100644 (file)
 
 #include <netdb.h>
 #include <errno.h>
+#include <sys/poll.h>
 #include <sys/epoll.h>
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+/* *INDENT-ON* */
+
 /*
  * 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
 {
@@ -41,6 +50,26 @@ typedef enum
   VPPCOM_PROTO_UDP,
 } vppcom_proto_t;
 
+static inline char *
+vppcom_proto_str (vppcom_proto_t proto)
+{
+  char *proto_str;
+
+  switch (proto)
+    {
+    case VPPCOM_PROTO_TCP:
+      proto_str = "VPPCOM_PROTO_TCP";
+      break;
+    case VPPCOM_PROTO_UDP:
+      proto_str = "VPPCOM_PROTO_UDP";
+      break;
+    default:
+      proto_str = "UNKNOWN";
+      break;
+    }
+  return proto_str;
+}
+
 typedef enum
 {
   VPPCOM_IS_IP6 = 0,
@@ -49,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;
@@ -60,13 +88,18 @@ typedef enum
 {
   VPPCOM_OK = 0,
   VPPCOM_EAGAIN = -EAGAIN,
+  VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
+  VPPCOM_EFAULT = -EFAULT,
   VPPCOM_ENOMEM = -ENOMEM,
   VPPCOM_EINVAL = -EINVAL,
   VPPCOM_EBADFD = -EBADFD,
   VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
+  VPPCOM_ECONNABORTED = -ECONNABORTED,
   VPPCOM_ECONNRESET = -ECONNRESET,
+  VPPCOM_ENOTCONN = -ENOTCONN,
   VPPCOM_ECONNREFUSED = -ECONNREFUSED,
   VPPCOM_ETIMEDOUT = -ETIMEDOUT,
+  VPPCOM_EEXIST = -EEXIST
 } vppcom_error_t;
 
 typedef enum
@@ -77,14 +110,43 @@ typedef enum
   VPPCOM_ATTR_SET_FLAGS,
   VPPCOM_ATTR_GET_LCL_ADDR,
   VPPCOM_ATTR_GET_PEER_ADDR,
+  VPPCOM_ATTR_GET_LIBC_EPFD,
+  VPPCOM_ATTR_SET_LIBC_EPFD,
+  VPPCOM_ATTR_GET_PROTOCOL,
+  VPPCOM_ATTR_GET_LISTEN,
+  VPPCOM_ATTR_GET_ERROR,
+  VPPCOM_ATTR_GET_TX_FIFO_LEN,
+  VPPCOM_ATTR_SET_TX_FIFO_LEN,
+  VPPCOM_ATTR_GET_RX_FIFO_LEN,
+  VPPCOM_ATTR_SET_RX_FIFO_LEN,
+  VPPCOM_ATTR_GET_REUSEADDR,
   VPPCOM_ATTR_SET_REUSEADDR,
+  VPPCOM_ATTR_GET_REUSEPORT,
+  VPPCOM_ATTR_SET_REUSEPORT,
+  VPPCOM_ATTR_GET_BROADCAST,
   VPPCOM_ATTR_SET_BROADCAST,
+  VPPCOM_ATTR_GET_V6ONLY,
   VPPCOM_ATTR_SET_V6ONLY,
+  VPPCOM_ATTR_GET_KEEPALIVE,
   VPPCOM_ATTR_SET_KEEPALIVE,
+  VPPCOM_ATTR_GET_TCP_NODELAY,
+  VPPCOM_ATTR_SET_TCP_NODELAY,
+  VPPCOM_ATTR_GET_TCP_KEEPIDLE,
   VPPCOM_ATTR_SET_TCP_KEEPIDLE,
+  VPPCOM_ATTR_GET_TCP_KEEPINTVL,
   VPPCOM_ATTR_SET_TCP_KEEPINTVL,
+  VPPCOM_ATTR_GET_TCP_USER_MSS,
+  VPPCOM_ATTR_SET_TCP_USER_MSS,
 } vppcom_attr_op_t;
 
+typedef struct _vcl_poll
+{
+  uint32_t fds_ndx;
+  uint32_t sid;
+  short events;
+  short *revents;
+} vcl_poll_t;
+
 /*
  * VPPCOM Public API Functions
  */
@@ -103,6 +165,10 @@ vppcom_retval_str (int retval)
       st = "VPPCOM_EAGAIN";
       break;
 
+    case VPPCOM_EFAULT:
+      st = "VPPCOM_EFAULT";
+      break;
+
     case VPPCOM_ENOMEM:
       st = "VPPCOM_ENOMEM";
       break;
@@ -119,10 +185,18 @@ vppcom_retval_str (int retval)
       st = "VPPCOM_EAFNOSUPPORT";
       break;
 
+    case VPPCOM_ECONNABORTED:
+      st = "VPPCOM_ECONNABORTED";
+      break;
+
     case VPPCOM_ECONNRESET:
       st = "VPPCOM_ECONNRESET";
       break;
 
+    case VPPCOM_ENOTCONN:
+      st = "VPPCOM_ENOTCONN";
+      break;
+
     case VPPCOM_ECONNREFUSED:
       st = "VPPCOM_ECONNREFUSED";
       break;
@@ -143,20 +217,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,
-                                 vppcom_endpt_t * client_ep,
-                                 uint32_t flags, double wait_for_time);
+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, int n);
-extern int vppcom_session_write (uint32_t session_index, void *buf, int 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,
@@ -164,19 +237,42 @@ 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);
+
+/**
+ * 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);
+
+/*
+ * VPPCOM Event Functions
+ */
+extern void vce_poll_wait_connect_request_handler_fn (void *arg);
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+}
+#endif
+/* *INDENT-ON* */
 
 #endif /* included_vppcom_h */