X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvcl%2Fvppcom.h;h=6e15cd17cd4b32912be9909ccac5494fb2102d63;hb=dd92bdeb0735dac940d32f651c0b0b9ed65a6d7d;hp=34a69b2c2eced75be9157add4dec0e669cc8bdf6;hpb=0d2b0d5497b61afb5c964373c7bed974d78762a0;p=vpp.git diff --git a/src/vcl/vppcom.h b/src/vcl/vppcom.h index 34a69b2c2ec..6e15cd17cd4 100644 --- a/src/vcl/vppcom.h +++ b/src/vcl/vppcom.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017 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: @@ -18,6 +18,7 @@ #include #include +#include #include #include @@ -31,62 +32,62 @@ 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" - -typedef enum -{ - VPPCOM_PROTO_TCP = 0, - VPPCOM_PROTO_UDP, -} vppcom_proto_t; - -static inline char * -vppcom_proto_str (vppcom_proto_t proto) +#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_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" +#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; + + 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_t; + +typedef uint32_t vcl_session_handle_t; + +typedef struct vppcom_cert_key_pair_ { - char *proto_str; - - switch (proto) - { - case VPPCOM_PROTO_TCP: - proto_str = "VPPCOM_PROTO_TCP"; - break; - case VPPCOM_PROTO_UDP: - proto_str = "VPPCOM_PROTO_UDP"; - break; - default: - proto_str = "UNKNOWN"; - break; - } - return proto_str; -} - -typedef enum -{ - VPPCOM_IS_IP6 = 0, - VPPCOM_IS_IP4, -} vppcom_is_ip4_t; - -typedef struct vppcom_endpt_t_ -{ - uint8_t is_cut_thru; - uint8_t is_ip4; - uint8_t *ip; - uint16_t port; -} vppcom_endpt_t; + char *cert; + char *key; + uint32_t cert_len; + uint32_t key_len; +} vppcom_cert_key_pair_t; typedef enum { VPPCOM_OK = 0, VPPCOM_EAGAIN = -EAGAIN, + VPPCOM_EWOULDBLOCK = -EWOULDBLOCK, + VPPCOM_EINPROGRESS = -EINPROGRESS, VPPCOM_EFAULT = -EFAULT, VPPCOM_ENOMEM = -ENOMEM, VPPCOM_EINVAL = -EINVAL, @@ -97,6 +98,11 @@ typedef enum VPPCOM_ENOTCONN = -ENOTCONN, VPPCOM_ECONNREFUSED = -ECONNREFUSED, VPPCOM_ETIMEDOUT = -ETIMEDOUT, + VPPCOM_EEXIST = -EEXIST, + VPPCOM_ENOPROTOOPT = -ENOPROTOOPT, + VPPCOM_EPIPE = -EPIPE, + VPPCOM_ENOENT = -ENOENT, + VPPCOM_EADDRINUSE = -EADDRINUSE } vppcom_error_t; typedef enum @@ -106,6 +112,7 @@ 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, @@ -134,161 +141,136 @@ typedef enum VPPCOM_ATTR_SET_TCP_KEEPINTVL, VPPCOM_ATTR_GET_TCP_USER_MSS, VPPCOM_ATTR_SET_TCP_USER_MSS, + 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 { uint32_t fds_ndx; - uint32_t sid; + vcl_session_handle_t sh; short events; - short *revents; + short revents; } vcl_poll_t; -/* - * VPPCOM Public API Functions - */ -static inline const char * -vppcom_retval_str (int retval) +typedef struct vppcom_data_segment_ { - char *st; - - switch (retval) - { - case VPPCOM_OK: - st = "VPPCOM_OK"; - break; - - case VPPCOM_EAGAIN: - st = "VPPCOM_EAGAIN"; - break; + unsigned char *data; + uint32_t len; +} vppcom_data_segment_t; - case VPPCOM_EFAULT: - st = "VPPCOM_EFAULT"; - break; +typedef vppcom_data_segment_t vppcom_data_segments_t[2]; - case VPPCOM_ENOMEM: - st = "VPPCOM_ENOMEM"; - break; +typedef unsigned long vcl_si_set; - 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; -} - -/** - * User registered callback for when connection arrives on listener created - * with vppcom_session_register_listener() - * @param uint32_t - newly accepted session_index - * @param vppcom_endpt_t* - ip/port information of remote - * @param void* - user passed arg to pass back - */ -typedef void (*vppcom_session_listener_cb) (uint32_t, vppcom_endpt_t *, - void *); - -/** - * User registered ERROR callback for any errors associated with - * handling vppcom_session_register_listener() and connections - * @param void* - user passed arg to pass back +/* + * VPPCOM Public API Functions */ -typedef void (*vppcom_session_listener_errcb) (void *); -/** - * @brief vppcom_session_register_listener accepts a bound session_index, and - * listens for connections. - * - * On successful connection, calls registered callback (cb) with new - * session_index. - * - * On error, calls registered error callback (errcb). - * - * @param session_index - bound session_index to create listener on - * @param cb - on new accepted session callback - * @param errcb - on failure callback - * @param flags - placeholder for future use. Must be ZERO - * @param q_len - max listener connection backlog - * @param ptr - user data - * @return - */ -extern int vppcom_session_register_listener (uint32_t session_index, - vppcom_session_listener_cb cb, - vppcom_session_listener_errcb - errcb, uint8_t flags, int q_len, - void *ptr); - -/* 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_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_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); -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_segment_t * ds, + uint32_t n_segments, + uint32_t max_bytes); +extern void vppcom_session_free_segments (uint32_t session_handle, + 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 + * + * Expectation is that applications will make use of this after a new pthread + * is spawned. + */ +extern int vppcom_worker_register (void); + +/** + * Unregister current worker + */ +extern void vppcom_worker_unregister (void); + +/** + * Retrieve current worker index + */ +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 + * + * This only works if vcl is configured to do eventfd based message queue + * notifications. + */ +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); /* *INDENT-OFF* */ #ifdef __cplusplus