/*
- * Copyright (c) 2017 Cisco and/or its affiliates.
+ * Copyright (c) 2017-2019 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
#include <netdb.h>
#include <errno.h>
+#include <sys/fcntl.h>
#include <sys/poll.h>
#include <sys/epoll.h>
/*
* VPPCOM Public API Definitions, Enums, and Data Structures
*/
-#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 INVALID_SESSION_ID ((u32)~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
{
VPPCOM_PROTO_TCP = 0,
VPPCOM_PROTO_UDP,
+ VPPCOM_PROTO_SCTP,
+ VPPCOM_PROTO_NONE,
+ VPPCOM_PROTO_TLS,
+ VPPCOM_PROTO_UDPC,
+ VPPCOM_PROTO_QUIC,
} vppcom_proto_t;
static inline char *
switch (proto)
{
case VPPCOM_PROTO_TCP:
- proto_str = "VPPCOM_PROTO_TCP";
+ proto_str = "TCP";
break;
case VPPCOM_PROTO_UDP:
- proto_str = "VPPCOM_PROTO_UDP";
+ proto_str = "UDP";
+ break;
+ case VPPCOM_PROTO_SCTP:
+ proto_str = "SCTP";
+ break;
+ case VPPCOM_PROTO_TLS:
+ proto_str = "TLS";
+ break;
+ case VPPCOM_PROTO_UDPC:
+ proto_str = "UDPC";
+ break;
+ case VPPCOM_PROTO_QUIC:
+ proto_str = "QUIC";
break;
default:
proto_str = "UNKNOWN";
return proto_str;
}
+static inline int
+vcl_proto_is_dgram (uint8_t proto)
+{
+ return proto == VPPCOM_PROTO_UDP || proto == VPPCOM_PROTO_UDPC;
+}
+
typedef enum
{
VPPCOM_IS_IP6 = 0,
uint8_t is_ip4;
uint8_t *ip;
uint16_t port;
+ uint64_t parent_handle;
} vppcom_endpt_t;
+typedef uint32_t vcl_session_handle_t;
+
typedef enum
{
VPPCOM_OK = 0,
VPPCOM_EAGAIN = -EAGAIN,
+ VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
+ VPPCOM_EINPROGRESS = -EINPROGRESS,
VPPCOM_EFAULT = -EFAULT,
VPPCOM_ENOMEM = -ENOMEM,
VPPCOM_EINVAL = -EINVAL,
VPPCOM_ENOTCONN = -ENOTCONN,
VPPCOM_ECONNREFUSED = -ECONNREFUSED,
VPPCOM_ETIMEDOUT = -ETIMEDOUT,
+ VPPCOM_EEXIST = -EEXIST
} vppcom_error_t;
typedef enum
VPPCOM_ATTR_GET_FLAGS,
VPPCOM_ATTR_SET_FLAGS,
VPPCOM_ATTR_GET_LCL_ADDR,
+ VPPCOM_ATTR_SET_LCL_ADDR,
VPPCOM_ATTR_GET_PEER_ADDR,
VPPCOM_ATTR_GET_LIBC_EPFD,
VPPCOM_ATTR_SET_LIBC_EPFD,
VPPCOM_ATTR_SET_TCP_KEEPINTVL,
VPPCOM_ATTR_GET_TCP_USER_MSS,
VPPCOM_ATTR_SET_TCP_USER_MSS,
+ VPPCOM_ATTR_SET_SHUT,
+ VPPCOM_ATTR_GET_SHUT,
} vppcom_attr_op_t;
typedef struct _vcl_poll
{
uint32_t fds_ndx;
- uint32_t sid;
+ vcl_session_handle_t sh;
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];
+
+typedef unsigned long vcl_si_set;
+
/*
* VPPCOM Public API Functions
*/
extern void vppcom_app_destroy (void);
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_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_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_select (unsigned long n_bits,
- unsigned long *read_map,
- unsigned long *write_map,
- unsigned long *except_map, double wait_for_time);
+extern int vppcom_session_stream_connect (uint32_t session_handle,
+ uint32_t parent_session_handle);
+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_session_write_msg (uint32_t session_handle, void *buf,
+ size_t n);
+
+extern int vppcom_select (int n_bits, vcl_si_set * read_map,
+ vcl_si_set * write_map, vcl_si_set * 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 (vcl_session_handle_t session_handle);
+extern int vppcom_session_worker (vcl_session_handle_t session_handle);
+
+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_session_tls_add_cert (uint32_t session_handle, char *cert,
+ uint32_t cert_len);
+extern int vppcom_session_tls_add_key (uint32_t session_handle, char *key,
+ uint32_t key_len);
+extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
+ uint32_t max_bytes);
+extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str);
+extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
+extern int vppcom_session_listener (uint32_t session_handle);
+extern int vppcom_session_n_accepted (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
+/**
+ * Unregister current worker
+ */
+extern void vppcom_worker_unregister (void);
+
+/**
+ * Retrieve current worker index
+ */
+extern int vppcom_worker_index (void);
+
+/**
+ * Returns the current worker's message queues epoll fd
+ *
+ * This only works if vcl is configured to do eventfd based message queue
+ * notifications.
*/
-extern void vce_poll_wait_connect_request_handler_fn (void *arg);
+extern int vppcom_worker_mqs_epfd (void);
/* *INDENT-OFF* */
#ifdef __cplusplus