#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_ENV "VPPCOM_CONF"
-#define VPPCOM_CONF_DEFAULT "/etc/vpp/vppcom.conf"
+#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"
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,
typedef struct vppcom_endpt_t_
{
- uint32_t vrf;
uint8_t is_cut_thru;
uint8_t is_ip4;
uint8_t *ip;
{
VPPCOM_OK = 0,
VPPCOM_EAGAIN = -EAGAIN,
+ 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_error_t;
typedef enum
{
VPPCOM_ATTR_GET_NREAD,
- VPPCOM_ATTR_PEEK_NREAD,
+ VPPCOM_ATTR_GET_NWRITE,
VPPCOM_ATTR_GET_FLAGS,
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;
+
+typedef struct vppcom_ioevent_
+{
+ uint32_t session_index;
+ size_t bytes;
+} vppcom_ioevent_t;
+
+
/*
* VPPCOM Public API Functions
*/
st = "VPPCOM_EAGAIN";
break;
+ case VPPCOM_EFAULT:
+ st = "VPPCOM_EFAULT";
+ break;
+
+ case VPPCOM_ENOMEM:
+ st = "VPPCOM_ENOMEM";
+ break;
+
case VPPCOM_EINVAL:
st = "VPPCOM_EINVAL";
break;
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;
return st;
}
+/**
+ * User registered callback for when connection arrives on listener created
+ * with vppcom_session_register_listener()
+ * @param uint32_t - newly accepted session_index
+ * @param vppcom_endpt_t* - ip/port information of remote
+ * @param void* - user passed arg to pass back
+ */
+typedef void (*vppcom_session_listener_cb) (uint32_t, vppcom_endpt_t *,
+ void *);
+
+/**
+ * User registered callback for IO events (rx/tx)
+ * @param vppcom_ioevent_t* -
+ * @param void* - user passed arg to pass back
+ */
+typedef void (*vppcom_session_ioevent_cb) (vppcom_ioevent_t *, void *);
+
+/**
+ * @brief vppcom_session_register_listener accepts a bound session_index, and
+ * listens for connections.
+ *
+ * On successful connection, calls registered callback (cb) with new
+ * session_index.
+ *
+ * On error, calls registered error callback (errcb).
+ *
+ * @param session_index - bound session_index to create listener on
+ * @param cb - on new accepted session callback
+ * @param errcb - on failure callback
+ * @param flags - placeholder for future use. Must be ZERO
+ * @param q_len - max listener connection backlog
+ * @param ptr - user data
+ * @return
+ */
+extern int vppcom_session_register_ioevent_cb (uint32_t session_index,
+ vppcom_session_ioevent_cb cb,
+ uint8_t rx, void *ptr);
+
+/**
+ * User registered ERROR callback for any errors associated with
+ * handling vppcom_session_register_listener() and connections
+ * @param void* - user passed arg to pass back
+ */
+typedef void (*vppcom_session_listener_errcb) (void *);
+
+/**
+ * @brief vppcom_session_register_listener accepts a bound session_index, and
+ * listens for connections.
+ *
+ * On successful connection, calls registered callback (cb) with new
+ * session_index.
+ *
+ * On error, calls registered error callback (errcb).
+ *
+ * @param session_index - bound session_index to create listener on
+ * @param cb - on new accepted session callback
+ * @param errcb - on failure callback
+ * @param flags - placeholder for future use. Must be ZERO
+ * @param q_len - max listener connection backlog
+ * @param ptr - user data
+ * @return
+ */
+extern int vppcom_session_register_listener (uint32_t session_index,
+ vppcom_session_listener_cb cb,
+ vppcom_session_listener_errcb
+ errcb, uint8_t flags, int q_len,
+ void *ptr);
+
/* TBD: make these constructor/destructor function */
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_create (uint8_t proto, uint8_t is_nonblocking);
extern int vppcom_session_close (uint32_t session_index);
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,
- double wait_for_time);
+ vppcom_endpt_t * client_ep, uint32_t flags);
extern int vppcom_session_connect (uint32_t session_index,
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_index, void *buf, size_t n);
+extern int vppcom_session_write (uint32_t session_index, void *buf, size_t n);
extern int vppcom_select (unsigned long n_bits,
unsigned long *read_map,
int maxevents, double wait_for_time);
extern int vppcom_session_attr (uint32_t session_index, uint32_t op,
void *buffer, uint32_t * buflen);
+extern int vppcom_session_recvfrom (uint32_t session_index, void *buffer,
+ uint32_t buflen, int flags,
+ vppcom_endpt_t * ep);
+extern int vppcom_session_sendto (uint32_t session_index, 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);
+
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+}
+#endif
+/* *INDENT-ON* */
#endif /* included_vppcom_h */
Code Review / vpp.git / blobdiff