STATE_APP_ADDING_TLS_DATA,
STATE_APP_FAILED,
STATE_APP_READY
-} app_state_t;
-
-typedef enum
-{
- STATE_START = 0,
- STATE_CONNECT = 0x01,
- STATE_LISTEN = 0x02,
- STATE_ACCEPT = 0x04,
- STATE_VPP_CLOSING = 0x08,
- STATE_DISCONNECT = 0x10,
- STATE_FAILED = 0x20,
- STATE_UPDATED = 0x40,
- STATE_LISTEN_NO_MQ = 0x80,
+} vcl_bapi_app_state_t;
+
+typedef enum vcl_session_state_
+{
+ VCL_STATE_CLOSED,
+ VCL_STATE_LISTEN,
+ VCL_STATE_READY,
+ VCL_STATE_VPP_CLOSING,
+ VCL_STATE_DISCONNECT,
+ VCL_STATE_DETACHED,
+ VCL_STATE_UPDATED,
+ VCL_STATE_LISTEN_NO_MQ,
} vcl_session_state_t;
-#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;
typedef struct
#define VEP_DEFAULT_ET_MASK (EPOLLIN|EPOLLOUT)
#define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
u32 et_mask;
+ u32 lt_next;
+ u32 lt_prev;
} vppcom_epoll_t;
/* Select uses the vcl_si_set as if a clib_bitmap. Make sure they are the
typedef struct vcl_session_msg
{
- u32 next;
union
{
session_accepted_msg_t accepted_msg;
VCL_SESS_ATTR_CUT_THRU,
VCL_SESS_ATTR_VEP,
VCL_SESS_ATTR_VEP_SESSION,
- VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN
- VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK
- VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR
- VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT
- VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST
- VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY
- VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE
- VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY
- VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE
- VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL
- VCL_SESS_ATTR_SHUT_RD,
- VCL_SESS_ATTR_SHUT_WR,
+ VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN
+ VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK
+ VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR
+ VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT
+ VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST
+ VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY
+ VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE
+ VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY
+ VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE
+ VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL
+ VCL_SESS_ATTR_IP_PKTINFO, /* IPPROTO_IP, IP_PKTINFO */
VCL_SESS_ATTR_MAX
} vppcom_session_attr_t;
-#define VCL_SESS_ATTR_SET(ATTR, VAL) \
-do { \
- (ATTR) |= 1 << (VAL); \
- } while (0)
-
-#define VCL_SESS_ATTR_CLR(ATTR, VAL) \
-do { \
- (ATTR) &= ~(1 << (VAL)); \
- } while (0)
-
-#define VCL_SESS_ATTR_TEST(ATTR, VAL) \
- ((ATTR) & (1 << (VAL)) ? 1 : 0)
+typedef enum vcl_session_flags_
+{
+ VCL_SESSION_F_CONNECTED = 1 << 0,
+ VCL_SESSION_F_IS_VEP = 1 << 1,
+ VCL_SESSION_F_IS_VEP_SESSION = 1 << 2,
+ VCL_SESSION_F_HAS_RX_EVT = 1 << 3,
+ VCL_SESSION_F_RD_SHUTDOWN = 1 << 4,
+ VCL_SESSION_F_WR_SHUTDOWN = 1 << 5,
+ VCL_SESSION_F_PENDING_DISCONNECT = 1 << 6,
+ VCL_SESSION_F_PENDING_FREE = 1 << 7,
+ VCL_SESSION_F_PENDING_LISTEN = 1 << 8,
+} __clib_packed vcl_session_flags_t;
-typedef struct
+typedef struct vcl_session_
{
CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
+
#define _(type, name) type name;
foreach_app_session_field
#undef _
- u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
- u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
- u32 user_mss; // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
- u64 vpp_handle;
- u32 vpp_thread_index;
+ vcl_session_flags_t flags; /**< see @ref vcl_session_flags_t */
+ u32 rx_bytes_pending; /**< bytes rx-ed as segs but not yet freed */
svm_fifo_t *ct_rx_fifo;
svm_fifo_t *ct_tx_fifo;
+ vcl_session_msg_t *accept_evts_fifo;
- /* Socket configuration state */
- u8 is_vep;
- u8 is_vep_session;
- /* VCL session index of the listening session (if any) */
- u32 listener_index;
- /* Accepted sessions on this listener */
- int n_accepted_sessions;
- u8 has_rx_evt;
- u32 attr;
+ u64 vpp_handle;
u64 parent_handle;
+ u32 listener_index; /**< index of parent listener (if any) */
+ int n_accepted_sessions; /**< sessions accepted by this listener */
vppcom_epoll_t vep;
+ u32 attributes; /**< see @ref vppcom_session_attr_t */
int libc_epfd;
- svm_msg_q_t *our_evt_q;
- vcl_session_msg_t *accept_evts_fifo;
+ u32 vrf;
+ u16 gso_size;
+
+ u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
+ u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
+
+ transport_endpt_ext_cfg_t *ext_config;
+ u8 dscp;
+
+ i32 vpp_error;
+
#if VCL_ELOG
elog_track_t elog_track;
#endif
{
uword heapsize;
u32 max_workers;
- u32 vpp_api_q_length;
uword segment_baseva;
- u32 segment_size;
- u32 add_segment_size;
+ uword segment_size;
+ uword add_segment_size;
u32 preallocated_fifo_pairs;
u32 rx_fifo_size;
u32 tx_fifo_size;
u32 event_queue_size;
- u32 listen_queue_size;
u8 app_proxy_transport_tcp;
u8 app_proxy_transport_udp;
u8 app_scope_local;
u8 use_mq_eventfd;
f64 app_timeout;
f64 session_timeout;
- f64 accept_timeout;
- u32 event_ring_size;
char *event_log_path;
- u8 *vpp_api_filename;
- u8 *vpp_api_socket_name;
+ u8 *vpp_app_socket_api; /**< app socket api socket file name */
+ u8 *vpp_bapi_socket_name; /**< bapi socket transport socket name */
+ u32 tls_engine;
+ u8 mt_wrk_supported;
+ u8 huge_page;
} vppcom_cfg_t;
void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
/** 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;
+ /**
+ * Generic api client handle. When binary api is in used, it stores
+ * the "client_index" and when socket api is use, it stores the sapi
+ * client handle */
+ u32 api_client_handle;
/** VPP binary api input queue */
svm_queue_t *vl_input_queue;
/** Per worker buffer for receiving mq epoll events */
struct epoll_event *mq_events;
+ /** Next session to be lt polled */
+ u32 ep_lt_current;
+
/** Hash table for disconnect processing */
uword *session_index_by_vpp_handles;
/** Our event message queue */
svm_msg_q_t *app_event_queue;
- /** VPP workers event message queues */
- svm_msg_q_t **vpp_event_queues;
-
/** For deadman timers */
clib_time_t clib_time;
u32 forked_child;
+ clib_socket_t app_api_sock;
+ socket_client_main_t bapi_sock_ctx;
+ api_main_t bapi_api_ctx;
+ memory_client_main_t bapi_mem_ctx;
+
+ /* State of the connection, shared between msg RX thread and main thread */
+ volatile vcl_bapi_app_state_t bapi_app_state;
+ volatile uword bapi_return;
+
+ u8 session_attr_op;
+ int session_attr_op_rv;
+ transport_endpt_attr_t session_attr_rv;
+
+ /** vcl needs next epoll_create to go to libc_epoll */
+ u8 vcl_needs_real_epoll;
+ volatile int rpc_done;
} vcl_worker_t;
+STATIC_ASSERT (sizeof (session_disconnected_msg_t) <= 16,
+ "disconnected must fit in session_event_t");
+STATIC_ASSERT (sizeof (session_reset_msg_t) <= 16,
+ "disconnected must fit in session_event_t");
+
+typedef void (vcl_rpc_fn_t) (void *args);
+
typedef struct vppcom_main_t_
{
u8 is_init;
/** 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 */
/** Lock to protect worker registrations */
clib_spinlock_t workers_lock;
+ /** Counter to determine order of execution of `vcl_api_retry_attach`
+ * function by multiple workers */
+ int reattach_count;
+
/** Lock to protect segment hash table */
clib_rwlock_t segment_table_lock;
fifo_segment_main_t segment_main;
+ vcl_rpc_fn_t *wrk_rpc_fn;
+
+ /*
+ * Binary api context
+ */
+
+ /* VNET_API_ERROR_FOO -> "Foo" hash table */
+ uword *error_string_by_error_number;
+
#ifdef VCL_ELOG
/* VPP Event-logger */
elog_main_t elog_main;
elog_track_t elog_track;
#endif
- /* VNET_API_ERROR_FOO -> "Foo" hash table */
- uword *error_string_by_error_number;
-
} vppcom_main_t;
extern vppcom_main_t *vcm;
+extern vppcom_main_t _vppcom_main;
#define VCL_INVALID_SESSION_INDEX ((u32)~0)
#define VCL_INVALID_SESSION_HANDLE ((u64)~0)
#define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
#define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
+void vcl_session_detach_fifos (vcl_session_t *s);
+
static inline vcl_session_t *
vcl_session_alloc (vcl_worker_t * wrk)
{
static inline void
vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
{
+ /* Debug level set to 1 to avoid debug messages while ldp is cleaning up */
+ VDBG (1, "session %u [0x%llx] removed", s->session_index, s->vpp_handle);
+ vcl_session_detach_fifos (s);
+ if (s->ext_config)
+ clib_mem_free (s->ext_config);
pool_put (wrk->sessions, s);
}
return pool_elt_at_index (wrk->sessions, session_index);
}
+static inline vcl_session_handle_t
+vcl_session_handle_from_wrk_session_index (u32 session_index, u32 wrk_index)
+{
+ ASSERT (session_index < 2 << 24);
+ return (wrk_index << 24 | session_index);
+}
+
static inline vcl_session_handle_t
vcl_session_handle_from_index (u32 session_index)
{
if (session->session_type != VPPCOM_PROTO_QUIC)
return 0;
if (session->listener_index == VCL_INVALID_SESSION_INDEX)
- return !(session->session_state & STATE_LISTEN);
+ return !(session->session_state == VCL_STATE_LISTEN);
ls = vcl_session_get_w_handle (wrk, session->listener_index);
if (!ls)
return VPPCOM_EBADFD;
- return ls->session_state & STATE_LISTEN;
+ return ls->session_state == VCL_STATE_LISTEN;
}
static inline vcl_session_t *
vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
{
uword *p;
- vcl_session_t *session;
+ vcl_session_t *s;
p = hash_get (wrk->session_index_by_vpp_handles, handle);
if (!p)
" %llx", handle);
return 0;
}
- session = vcl_session_get (wrk, p[0]);
- if (!session)
+ s = vcl_session_get (wrk, p[0]);
+ if (!s)
{
VDBG (1, "invalid listen session index (%u)", p[0]);
return 0;
}
- ASSERT ((session->session_state & (STATE_LISTEN | STATE_LISTEN_NO_MQ)) ||
- vcl_session_is_connectable_listener (wrk, session));
- return session;
-}
+ if (s->session_state == VCL_STATE_DISCONNECT)
+ {
+ VDBG (0, "listen session [0x%llx] is closing", s->vpp_handle);
+ return 0;
+ }
-const char *vppcom_session_state_str (vcl_session_state_t state);
+ ASSERT (s->session_state == VCL_STATE_LISTEN
+ || s->session_state == VCL_STATE_LISTEN_NO_MQ
+ || vcl_session_is_connectable_listener (wrk, s));
+ return s;
+}
static inline u8
vcl_session_is_ct (vcl_session_t * s)
return (s->ct_tx_fifo != 0);
}
+static inline u8
+vcl_session_is_cl (vcl_session_t * s)
+{
+ if (s->session_type == VPPCOM_PROTO_UDP)
+ return !(s->flags & VCL_SESSION_F_CONNECTED);
+ return 0;
+}
+
+static inline u8
+vcl_session_has_crypto (vcl_session_t *s)
+{
+ return (s->session_type == VPPCOM_PROTO_TLS ||
+ s->session_type == VPPCOM_PROTO_QUIC ||
+ s->session_type == VPPCOM_PROTO_DTLS);
+}
+
+static inline u8
+vcl_session_is_ready (vcl_session_t * s)
+{
+ return (s->session_state == VCL_STATE_READY
+ || s->session_state == VCL_STATE_VPP_CLOSING);
+}
+
static inline u8
vcl_session_is_open (vcl_session_t * s)
{
- return ((s->session_state & STATE_OPEN)
- || (s->session_state == STATE_LISTEN
- && s->session_type == VPPCOM_PROTO_UDP));
+ return ((vcl_session_is_ready (s))
+ || (s->session_state == VCL_STATE_LISTEN && vcl_session_is_cl (s)));
}
static inline u8
vcl_session_is_closing (vcl_session_t * s)
{
- return (s->session_state == STATE_VPP_CLOSING
- || s->session_state == STATE_DISCONNECT);
+ return (s->session_state == VCL_STATE_VPP_CLOSING
+ || s->session_state == VCL_STATE_DISCONNECT);
+}
+
+static inline u8
+vcl_session_is_closed (vcl_session_t * s)
+{
+ return (!s || (s->session_state == VCL_STATE_CLOSED));
}
static inline int
vcl_session_closing_error (vcl_session_t * s)
{
- return s->session_state == STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
+ /* Return 0 on closing sockets */
+ return s->session_state == VCL_STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
}
static inline int
vcl_session_closed_error (vcl_session_t * s)
{
- return s->session_state == STATE_DISCONNECT
+ return s->session_state == VCL_STATE_DISCONNECT
? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
}
+static inline void
+vcl_ip_copy_from_ep (ip46_address_t * ip, vppcom_endpt_t * ep)
+{
+ if (ep->is_ip4)
+ clib_memcpy_fast (&ip->ip4, ep->ip, sizeof (ip4_address_t));
+ else
+ clib_memcpy_fast (&ip->ip6, ep->ip, sizeof (ip6_address_t));
+}
+
+static inline void
+vcl_ip_copy_to_ep (ip46_address_t * ip, vppcom_endpt_t * ep, u8 is_ip4)
+{
+ ep->is_ip4 = is_ip4;
+ if (is_ip4)
+ clib_memcpy_fast (ep->ip, &ip->ip4, sizeof (ip4_address_t));
+ else
+ clib_memcpy_fast (ep->ip, &ip->ip6, sizeof (ip6_address_t));
+}
+
+static inline int
+vcl_proto_is_dgram (uint8_t proto)
+{
+ return proto == VPPCOM_PROTO_UDP || proto == VPPCOM_PROTO_DTLS ||
+ proto == VPPCOM_PROTO_SRTP;
+}
+
+static inline u8
+vcl_session_has_attr (vcl_session_t * s, u8 attr)
+{
+ return (s->attributes & (1 << attr)) ? 1 : 0;
+}
+
+static inline void
+vcl_session_set_attr (vcl_session_t * s, u8 attr)
+{
+ s->attributes |= 1 << attr;
+}
+
+static inline void
+vcl_session_clear_attr (vcl_session_t * s, u8 attr)
+{
+ s->attributes &= ~(1 << attr);
+}
+
+static inline session_evt_type_t
+vcl_session_dgram_tx_evt (vcl_session_t *s, session_evt_type_t et)
+{
+ return (s->flags & VCL_SESSION_F_CONNECTED) ? et : SESSION_IO_EVT_TX_MAIN;
+}
+
/*
* Helpers
*/
-int vcl_wait_for_app_state_change (app_state_t app_state);
vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
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);
svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
void vcl_flush_mq_events (void);
-void vcl_cleanup_bapi (void);
int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
vcl_session_handle_t sh, u8 do_disconnect);
int vcl_session_read_ready (vcl_session_t * session);
int vcl_session_write_ready (vcl_session_t * session);
+int vcl_session_alloc_ext_cfg (vcl_session_t *s,
+ transport_endpt_ext_cfg_type_t type, u32 len);
static inline vcl_worker_t *
vcl_worker_get (u32 wrk_index)
return pool_elts (vcm->workers);
}
-static inline svm_msg_q_t *
-vcl_session_vpp_evt_q (vcl_worker_t * wrk, vcl_session_t * s)
+static inline u64
+vcl_vpp_worker_segment_handle (u32 wrk_index)
{
- return wrk->vpp_event_queues[s->vpp_thread_index];
+ return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
}
void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
u32 wrk_index);
+int vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len);
+
+int vcl_segment_attach (u64 segment_handle, char *name,
+ ssvm_segment_type_t type, int fd);
+void vcl_segment_detach (u64 segment_handle);
+void vcl_segment_detach_segments (u32 *seg_indices);
+void vcl_send_session_listen (vcl_worker_t *wrk, vcl_session_t *s);
+void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
+
+int vcl_segment_attach_session (uword segment_handle, uword rxf_offset,
+ uword txf_offset, uword mq_offset,
+ u32 mq_index, u8 is_ct, vcl_session_t *s);
+int vcl_segment_attach_mq (uword segment_handle, uword mq_offset, u32 mq_index,
+ svm_msg_q_t **mq);
+int vcl_segment_discover_mqs (uword segment_handle, int *fds, u32 n_fds);
+svm_fifo_chunk_t *vcl_segment_alloc_chunk (uword segment_handle,
+ u32 slice_index, u32 size,
+ uword *offset);
+int vcl_session_share_fifos (vcl_session_t *s, svm_fifo_t *rxf,
+ svm_fifo_t *txf);
+void vcl_worker_detach_sessions (vcl_worker_t *wrk);
+
/*
* VCL Binary API
*/
-int vppcom_connect_to_vpp (char *app_name);
-void vppcom_disconnect_from_vpp (void);
-void vppcom_init_error_string_table (void);
-void vppcom_send_session_enable_disable (u8 is_enable);
-void vppcom_app_send_attach (void);
-void vppcom_app_send_detach (void);
-void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
-void vppcom_send_disconnect_session (u64 vpp_handle);
-void vppcom_api_hookup (void);
-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);
+int vcl_bapi_attach (void);
+int vcl_bapi_app_worker_add (void);
+void vcl_bapi_app_worker_del (vcl_worker_t * wrk);
+void vcl_bapi_disconnect_from_vpp (void);
+int vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
+int vcl_bapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
+int vcl_bapi_del_cert_key_pair (u32 ckpair_index);
+u32 vcl_bapi_max_nsid_len (void);
+int vcl_bapi_worker_set (void);
-u32 vcl_max_nsid_len (void);
+/*
+ * VCL Socket API
+ */
+int vcl_sapi_attach (void);
+int vcl_sapi_app_worker_add (void);
+void vcl_sapi_app_worker_del (vcl_worker_t * wrk);
+void vcl_sapi_detach (vcl_worker_t * wrk);
+int vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
+int vcl_sapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
+int vcl_sapi_del_cert_key_pair (u32 ckpair_index);
-u8 *format_api_error (u8 * s, va_list * args);
+/*
+ * Utility functions
+ */
+const char *vcl_session_state_str (vcl_session_state_t state);
+u8 *vcl_format_ip4_address (u8 *s, va_list *args);
+u8 *vcl_format_ip6_address (u8 *s, va_list *args);
+u8 *vcl_format_ip46_address (u8 *s, va_list *args);
-void vls_init ();
#endif /* SRC_VCL_VCL_PRIVATE_H_ */
/*