X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvcl%2Fvppcom.h;h=c9f7b8b94034980080947d6e6e83979ee5b6aecf;hb=243a0433ff05a37113d6890bbeb163bbea033687;hp=d2a5a103f8dfa441b2feb0e310f23d6d1471752b;hpb=07063b8ea39b05d5d7bb00ad2a2363b11792c571;p=vpp.git diff --git a/src/vcl/vppcom.h b/src/vcl/vppcom.h index d2a5a103f8d..c9f7b8b9403 100644 --- a/src/vcl/vppcom.h +++ b/src/vcl/vppcom.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017-2019 Cisco and/or its affiliates. + * Copyright (c) 2017-2020 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: @@ -36,76 +36,69 @@ extern "C" #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_APP_USE_MQ_EVENTFD "VCL_APP_USE_MQ_EVENTFD" #define VPPCOM_ENV_VPP_API_SOCKET "VCL_VPP_API_SOCKET" - -typedef enum -{ - VPPCOM_PROTO_TCP = 0, - VPPCOM_PROTO_UDP, - VPPCOM_PROTO_NONE, - VPPCOM_PROTO_TLS, - VPPCOM_PROTO_UDPC, - VPPCOM_PROTO_QUIC, -} vppcom_proto_t; - -static inline char * -vppcom_proto_str (vppcom_proto_t proto) -{ - char *proto_str; - - switch (proto) +#define VPPCOM_ENV_VPP_SAPI_SOCKET "VCL_VPP_SAPI_SOCKET" + + typedef enum + { + 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 + { + VPPCOM_IS_IP6 = 0, + VPPCOM_IS_IP4, + } vppcom_is_ip4_t; + +#define VCL_UDP_OPTS_BASE (VPPCOM_PROTO_UDP << 16) +#define VCL_UDP_SEGMENT (VCL_UDP_OPTS_BASE + 0) + + typedef struct vppcom_endpt_tlv_t_ + { + uint32_t data_type; + uint32_t data_len; + union { - case VPPCOM_PROTO_TCP: - proto_str = "TCP"; - break; - case VPPCOM_PROTO_UDP: - proto_str = "UDP"; - 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"; - break; - } - return proto_str; -} + /* data */ + uint64_t value; + uint32_t as_u32[2]; + uint16_t as_u16[4]; + uint8_t as_u8[8]; + }; + } 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; + vppcom_endpt_tlv_t app_data; + } vppcom_endpt_t; -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, - VPPCOM_IS_IP4, -} vppcom_is_ip4_t; +typedef uint32_t vcl_session_handle_t; -typedef struct vppcom_endpt_t_ +typedef struct vppcom_cert_key_pair_ { - uint8_t is_cut_thru; - uint8_t is_ip4; - uint8_t *ip; - uint16_t port; - uint64_t parent_handle; -} vppcom_endpt_t; - -typedef uint32_t vcl_session_handle_t; + char *cert; + char *key; + uint32_t cert_len; + uint32_t key_len; +} vppcom_cert_key_pair_t; typedef enum { @@ -123,7 +116,12 @@ typedef enum 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 @@ -162,8 +160,13 @@ 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_op_t; typedef struct _vcl_poll @@ -187,74 +190,12 @@ typedef unsigned long vcl_si_set; /* * VPPCOM Public API Functions */ -static inline const char * -vppcom_retval_str (int retval) -{ - char *st; - - switch (retval) - { - case VPPCOM_OK: - st = "VPPCOM_OK"; - break; - - case VPPCOM_EAGAIN: - 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; - - case VPPCOM_EBADFD: - st = "VPPCOM_EBADFD"; - break; - case VPPCOM_EAFNOSUPPORT: - 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; - - case VPPCOM_ETIMEDOUT: - st = "VPPCOM_ETIMEDOUT"; - break; - - default: - st = "UNKNOWN_STATE"; - break; - } - - return st; -} - -/* TBD: make these constructor/destructor function */ -extern int vppcom_app_create (char *app_name); +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); @@ -297,20 +238,21 @@ 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); + vppcom_data_segment_t * ds, + uint32_t n_segments, + uint32_t max_bytes); 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); + uint32_t n_bytes); +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); extern int vppcom_session_n_accepted (uint32_t session_handle); +extern const char *vppcom_proto_str (vppcom_proto_t proto); +extern const char *vppcom_retval_str (int retval); + /** * Request from application to register a new worker * @@ -329,6 +271,11 @@ extern void vppcom_worker_unregister (void); */ extern int vppcom_worker_index (void); +/** + * Set current worker index + */ +extern void vppcom_worker_index_set (int); + /** * Returns the current worker's message queues epoll fd * @@ -337,6 +284,21 @@ extern int vppcom_worker_index (void); */ extern int vppcom_worker_mqs_epfd (void); +/** + * 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); + /* *INDENT-OFF* */ #ifdef __cplusplus }