X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvcl%2Fvppcom.h;h=641946be55a4a1c0485c7dc20bea4cff89ab9365;hb=34a3a08d993cbbb3846b83b69b5338d452463e15;hp=8d414f6cc77b628b33ed1aeed5d25f46736f09ec;hpb=54693d23307ce8944a4d97379efd3bd4dcf0485c;p=vpp.git diff --git a/src/vcl/vppcom.h b/src/vcl/vppcom.h index 8d414f6cc77..641946be55a 100644 --- a/src/vcl/vppcom.h +++ b/src/vcl/vppcom.h @@ -31,22 +31,27 @@ extern "C" /* * 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 (~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_t; static inline char * @@ -57,10 +62,19 @@ vppcom_proto_str (vppcom_proto_t proto) 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; default: proto_str = "UNKNOWN"; @@ -98,6 +112,7 @@ typedef enum VPPCOM_ENOTCONN = -ENOTCONN, VPPCOM_ECONNREFUSED = -ECONNREFUSED, VPPCOM_ETIMEDOUT = -ETIMEDOUT, + VPPCOM_EEXIST = -EEXIST } vppcom_error_t; typedef enum @@ -135,6 +150,7 @@ typedef enum VPPCOM_ATTR_SET_TCP_KEEPINTVL, VPPCOM_ATTR_GET_TCP_USER_MSS, VPPCOM_ATTR_SET_TCP_USER_MSS, + VPPCOM_ATTR_GET_REFCNT, } vppcom_attr_op_t; typedef struct _vcl_poll @@ -142,9 +158,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 */ @@ -216,18 +240,20 @@ extern int vppcom_app_create (char *app_name); 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_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 (unsigned long n_bits, unsigned long *read_map, @@ -235,26 +261,48 @@ 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_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); + +/** + * 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 +/** + * Retrieve current worker index */ -extern void vce_poll_wait_connect_request_handler_fn (void *arg); +extern int vppcom_worker_index (void); /* *INDENT-OFF* */ #ifdef __cplusplus