X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvcl%2Fvppcom.h;h=386d7d0c3f728cb57f241c1fe485c48c6dd4d645;hb=8ae63db02066a2b5ac18a89fd63dc0dd2a811ab3;hp=09303008870febfab021544a01f96d3f285da530;hpb=165f3ae9670c98259677155bd04e92fe5830daa7;p=vpp.git diff --git a/src/vcl/vppcom.h b/src/vcl/vppcom.h index 09303008870..386d7d0c3f7 100644 --- a/src/vcl/vppcom.h +++ b/src/vcl/vppcom.h @@ -16,18 +16,21 @@ #ifndef included_vppcom_h #define included_vppcom_h +#ifdef __FreeBSD__ +#include +#endif /* __FreeBSD__ */ #include #include -#include -#include +#include +#include #include -/* *INDENT-OFF* */ +/* clang-format off */ + #ifdef __cplusplus extern "C" { #endif -/* *INDENT-ON* */ /* * VPPCOM Public API Definitions, Enums, and Data Structures @@ -42,16 +45,19 @@ extern "C" #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_APP_USE_MQ_EVENTFD "VCL_APP_USE_MQ_EVENTFD" #define VPPCOM_ENV_VPP_API_SOCKET "VCL_VPP_API_SOCKET" #define VPPCOM_ENV_VPP_SAPI_SOCKET "VCL_VPP_SAPI_SOCKET" -typedef enum +typedef enum vppcom_proto_ { VPPCOM_PROTO_TCP = 0, VPPCOM_PROTO_UDP, VPPCOM_PROTO_NONE, VPPCOM_PROTO_TLS, VPPCOM_PROTO_QUIC, + VPPCOM_PROTO_DTLS, + VPPCOM_PROTO_SRTP, } vppcom_proto_t; typedef enum @@ -60,17 +66,50 @@ typedef enum VPPCOM_IS_IP4, } vppcom_is_ip4_t; +typedef struct vppcom_endpt_tlv_t_ +{ + uint32_t data_type; + uint32_t data_len; + uint8_t data[0]; +} vppcom_endpt_tlv_t; + typedef struct vppcom_endpt_t_ { - uint8_t is_cut_thru; - uint8_t is_ip4; - uint8_t *ip; - uint16_t port; - uint64_t parent_handle; + uint8_t unused; /**< unused */ + uint8_t is_ip4; /**< flag set if if ip is ipv4 */ + uint8_t *ip; /**< pointer to ip address */ + uint16_t port; /**< transport port */ + uint64_t unused2; /**< unused */ + uint32_t app_tlv_len; /**< length of app provided tlvs */ + vppcom_endpt_tlv_t *app_tlvs; /**< array of app provided tlvs */ } vppcom_endpt_t; +#define VCL_UDP_OPTS_BASE (VPPCOM_PROTO_UDP << 16) +#define VCL_UDP_SEGMENT (VCL_UDP_OPTS_BASE + 0) + +/* By convention we'll use 127 for IP since we don't support IP as protocol */ +#define VCL_IP_OPTS_BASE (127 << 16) +#define VCL_IP_PKTINFO (VCL_IP_OPTS_BASE + 1) + +#define VCL_EP_APP_TLV_LEN(tlv_) (sizeof (vppcom_endpt_tlv_t) + tlv->data_len) +#define VCL_EP_APP_TLV_POS(ep_, tlv_) ((void *)ep_->app_tlvs - (void *)tlv_) +#define VCL_EP_APP_TLV_LEN_LEFT(ep_, tlv_) \ + (ep_->app_tlv_len - VCL_EP_APP_TLV_POS (ep_, tlv_)) +#define VCL_EP_NEXT_APP_TLV(ep_, tlv_) \ + (VCL_EP_APP_TLV_LEN (tlv_) < VCL_EP_APP_TLV_POS (ep_, tlv_) ? ( \ + (vppcom_endpt_tlv_t *)((uint8_t *)tlv_ + VCL_EP_APP_TLV_LEN (tlv_))) \ + : 0) + typedef uint32_t vcl_session_handle_t; +typedef struct vppcom_cert_key_pair_ +{ + char *cert; + char *key; + uint32_t cert_len; + uint32_t key_len; +} vppcom_cert_key_pair_t; + typedef enum { VPPCOM_OK = 0, @@ -80,14 +119,23 @@ typedef enum VPPCOM_EFAULT = -EFAULT, VPPCOM_ENOMEM = -ENOMEM, VPPCOM_EINVAL = -EINVAL, +#ifdef __linux__ VPPCOM_EBADFD = -EBADFD, +#else + VPPCOM_EBADFD = -EBADF, +#endif /* __linux__ */ VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT, VPPCOM_ECONNABORTED = -ECONNABORTED, VPPCOM_ECONNRESET = -ECONNRESET, VPPCOM_ENOTCONN = -ENOTCONN, VPPCOM_ECONNREFUSED = -ECONNREFUSED, VPPCOM_ETIMEDOUT = -ETIMEDOUT, - VPPCOM_EEXIST = -EEXIST + VPPCOM_EEXIST = -EEXIST, + VPPCOM_ENOPROTOOPT = -ENOPROTOOPT, + VPPCOM_EPIPE = -EPIPE, + VPPCOM_ENOENT = -ENOENT, + VPPCOM_EADDRINUSE = -EADDRINUSE, + VPPCOM_ENOTSUP = -ENOTSUP } vppcom_error_t; typedef enum @@ -126,9 +174,17 @@ typedef enum 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_SET_CONNECTED, + VPPCOM_ATTR_SET_CKPAIR, + VPPCOM_ATTR_SET_VRF, + VPPCOM_ATTR_GET_VRF, + VPPCOM_ATTR_GET_DOMAIN, + VPPCOM_ATTR_SET_ENDPT_EXT_CFG, + VPPCOM_ATTR_SET_DSCP, + VPPCOM_ATTR_SET_IP_PKTINFO, + VPPCOM_ATTR_GET_IP_PKTINFO, + VPPCOM_ATTR_GET_ORIGINAL_DST, + VPPCOM_ATTR_GET_NWRITEQ, } vppcom_attr_op_t; typedef struct _vcl_poll @@ -157,6 +213,7 @@ extern int vppcom_app_create (const 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_shutdown (uint32_t session_handle, int how); 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); @@ -204,10 +261,8 @@ extern int vppcom_session_read_segments (uint32_t session_handle, uint32_t max_bytes); extern void vppcom_session_free_segments (uint32_t session_handle, uint32_t n_bytes); -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_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair); +extern int vppcom_del_cert_key_pair (uint32_t ckpair_index); 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); @@ -247,11 +302,25 @@ extern void vppcom_worker_index_set (int); */ extern int vppcom_worker_mqs_epfd (void); -/* *INDENT-OFF* */ +/** + * Returns Session error + * + * Application can use this API to find the detailed session error + */ +extern int vppcom_session_get_error (uint32_t session_handle); + +/** + * Returns true if current worker is disconnected from vpp + * + * Application can use this API to check if VPP is disconnected + * as long as `use-mq-eventfd` is being set + */ +extern int vppcom_worker_is_detached (void); + #ifdef __cplusplus } #endif -/* *INDENT-ON* */ +/* clang-format on */ #endif /* included_vppcom_h */