src/vcl/vppcom.h

   1 /*
   2  * Copyright (c) 2017-2020 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef included_vppcom_h
  17 #define included_vppcom_h
  18
  19 #include <netdb.h>
  20 #include <errno.h>
  21 #include <sys/fcntl.h>
  22 #include <sys/poll.h>
  23 #include <sys/epoll.h>
  24
  25 /* *INDENT-OFF* */
  26 #ifdef __cplusplus
  27 extern "C"
  28 {
  29 #endif
  30 /* *INDENT-ON* */
  31
  32 /*
  33  * VPPCOM Public API Definitions, Enums, and Data Structures
  34  */
  35 #define INVALID_SESSION_ID                      ((u32)~0)
  36 #define VPPCOM_CONF_DEFAULT                     "/etc/vpp/vcl.conf"
  37 #define VPPCOM_ENV_CONF                         "VCL_CONFIG"
  38 #define VPPCOM_ENV_DEBUG                        "VCL_DEBUG"
  39 #define VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP      "VCL_APP_PROXY_TRANSPORT_TCP"
  40 #define VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP      "VCL_APP_PROXY_TRANSPORT_UDP"
  41 #define VPPCOM_ENV_APP_NAMESPACE_ID             "VCL_APP_NAMESPACE_ID"
  42 #define VPPCOM_ENV_APP_NAMESPACE_SECRET         "VCL_APP_NAMESPACE_SECRET"
  43 #define VPPCOM_ENV_APP_SCOPE_LOCAL              "VCL_APP_SCOPE_LOCAL"
  44 #define VPPCOM_ENV_APP_SCOPE_GLOBAL             "VCL_APP_SCOPE_GLOBAL"
  45 #define VPPCOM_ENV_APP_USE_MQ_EVENTFD           "VCL_APP_USE_MQ_EVENTFD"
  46 #define VPPCOM_ENV_VPP_API_SOCKET               "VCL_VPP_API_SOCKET"
  47 #define VPPCOM_ENV_VPP_SAPI_SOCKET              "VCL_VPP_SAPI_SOCKET"
  48
  49   typedef enum
  50   {
  51     VPPCOM_PROTO_TCP = 0,
  52     VPPCOM_PROTO_UDP,
  53     VPPCOM_PROTO_NONE,
  54     VPPCOM_PROTO_TLS,
  55     VPPCOM_PROTO_QUIC,
  56     VPPCOM_PROTO_DTLS,
  57     VPPCOM_PROTO_SRTP,
  58   } vppcom_proto_t;
  59
  60   typedef enum
  61   {
  62     VPPCOM_IS_IP6 = 0,
  63     VPPCOM_IS_IP4,
  64   } vppcom_is_ip4_t;
  65
  66 #define VCL_UDP_OPTS_BASE (VPPCOM_PROTO_UDP << 16)
  67 #define VCL_UDP_SEGMENT   (VCL_UDP_OPTS_BASE + 0)
  68
  69   typedef struct vppcom_endpt_tlv_t_
  70   {
  71     uint32_t data_type;
  72     uint32_t data_len;
  73     union
  74     {
  75       /* data */
  76       uint64_t value;
  77       uint32_t as_u32[2];
  78       uint16_t as_u16[4];
  79       uint8_t as_u8[8];
  80     };
  81   } vppcom_endpt_tlv_t;
  82
  83   typedef struct vppcom_endpt_t_
  84   {
  85     uint8_t is_cut_thru;
  86     uint8_t is_ip4;
  87     uint8_t *ip;
  88     uint16_t port;
  89     uint64_t parent_handle;
  90     vppcom_endpt_tlv_t app_data;
  91   } vppcom_endpt_t;
  92
  93 typedef uint32_t vcl_session_handle_t;
  94
  95 typedef struct vppcom_cert_key_pair_
  96 {
  97   char *cert;
  98   char *key;
  99   uint32_t cert_len;
 100   uint32_t key_len;
 101 } vppcom_cert_key_pair_t;
 102
 103 typedef enum
 104 {
 105   VPPCOM_OK = 0,
 106   VPPCOM_EAGAIN = -EAGAIN,
 107   VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
 108   VPPCOM_EINPROGRESS = -EINPROGRESS,
 109   VPPCOM_EFAULT = -EFAULT,
 110   VPPCOM_ENOMEM = -ENOMEM,
 111   VPPCOM_EINVAL = -EINVAL,
 112   VPPCOM_EBADFD = -EBADFD,
 113   VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
 114   VPPCOM_ECONNABORTED = -ECONNABORTED,
 115   VPPCOM_ECONNRESET = -ECONNRESET,
 116   VPPCOM_ENOTCONN = -ENOTCONN,
 117   VPPCOM_ECONNREFUSED = -ECONNREFUSED,
 118   VPPCOM_ETIMEDOUT = -ETIMEDOUT,
 119   VPPCOM_EEXIST = -EEXIST,
 120   VPPCOM_ENOPROTOOPT = -ENOPROTOOPT,
 121   VPPCOM_EPIPE = -EPIPE,
 122   VPPCOM_ENOENT = -ENOENT,
 123   VPPCOM_EADDRINUSE = -EADDRINUSE,
 124   VPPCOM_ENOTSUP = -ENOTSUP
 125 } vppcom_error_t;
 126
 127 typedef enum
 128 {
 129   VPPCOM_ATTR_GET_NREAD,
 130   VPPCOM_ATTR_GET_NWRITE,
 131   VPPCOM_ATTR_GET_FLAGS,
 132   VPPCOM_ATTR_SET_FLAGS,
 133   VPPCOM_ATTR_GET_LCL_ADDR,
 134   VPPCOM_ATTR_SET_LCL_ADDR,
 135   VPPCOM_ATTR_GET_PEER_ADDR,
 136   VPPCOM_ATTR_GET_LIBC_EPFD,
 137   VPPCOM_ATTR_SET_LIBC_EPFD,
 138   VPPCOM_ATTR_GET_PROTOCOL,
 139   VPPCOM_ATTR_GET_LISTEN,
 140   VPPCOM_ATTR_GET_ERROR,
 141   VPPCOM_ATTR_GET_TX_FIFO_LEN,
 142   VPPCOM_ATTR_SET_TX_FIFO_LEN,
 143   VPPCOM_ATTR_GET_RX_FIFO_LEN,
 144   VPPCOM_ATTR_SET_RX_FIFO_LEN,
 145   VPPCOM_ATTR_GET_REUSEADDR,
 146   VPPCOM_ATTR_SET_REUSEADDR,
 147   VPPCOM_ATTR_GET_REUSEPORT,
 148   VPPCOM_ATTR_SET_REUSEPORT,
 149   VPPCOM_ATTR_GET_BROADCAST,
 150   VPPCOM_ATTR_SET_BROADCAST,
 151   VPPCOM_ATTR_GET_V6ONLY,
 152   VPPCOM_ATTR_SET_V6ONLY,
 153   VPPCOM_ATTR_GET_KEEPALIVE,
 154   VPPCOM_ATTR_SET_KEEPALIVE,
 155   VPPCOM_ATTR_GET_TCP_NODELAY,
 156   VPPCOM_ATTR_SET_TCP_NODELAY,
 157   VPPCOM_ATTR_GET_TCP_KEEPIDLE,
 158   VPPCOM_ATTR_SET_TCP_KEEPIDLE,
 159   VPPCOM_ATTR_GET_TCP_KEEPINTVL,
 160   VPPCOM_ATTR_SET_TCP_KEEPINTVL,
 161   VPPCOM_ATTR_GET_TCP_USER_MSS,
 162   VPPCOM_ATTR_SET_TCP_USER_MSS,
 163   VPPCOM_ATTR_SET_CONNECTED,
 164   VPPCOM_ATTR_SET_CKPAIR,
 165   VPPCOM_ATTR_SET_VRF,
 166   VPPCOM_ATTR_GET_VRF,
 167   VPPCOM_ATTR_GET_DOMAIN,
 168   VPPCOM_ATTR_SET_ENDPT_EXT_CFG,
 169   VPPCOM_ATTR_SET_DSCP,
 170 } vppcom_attr_op_t;
 171
 172 typedef struct _vcl_poll
 173 {
 174   uint32_t fds_ndx;
 175   vcl_session_handle_t sh;
 176   short events;
 177   short revents;
 178 } vcl_poll_t;
 179
 180 typedef struct vppcom_data_segment_
 181 {
 182   unsigned char *data;
 183   uint32_t len;
 184 } vppcom_data_segment_t;
 185
 186 typedef vppcom_data_segment_t vppcom_data_segments_t[2];
 187
 188 typedef unsigned long vcl_si_set;
 189
 190 /*
 191  * VPPCOM Public API Functions
 192  */
 193
 194 extern int vppcom_app_create (const char *app_name);
 195 extern void vppcom_app_destroy (void);
 196
 197 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
 198 extern int vppcom_session_shutdown (uint32_t session_handle, int how);
 199 extern int vppcom_session_close (uint32_t session_handle);
 200 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
 201 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
 202
 203 extern int vppcom_session_accept (uint32_t session_handle,
 204                                   vppcom_endpt_t * client_ep, uint32_t flags);
 205
 206 extern int vppcom_session_connect (uint32_t session_handle,
 207                                    vppcom_endpt_t * server_ep);
 208 extern int vppcom_session_stream_connect (uint32_t session_handle,
 209                                           uint32_t parent_session_handle);
 210 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
 211 extern int vppcom_session_write (uint32_t session_handle, void *buf,
 212                                  size_t n);
 213 extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
 214                                      size_t n);
 215
 216 extern int vppcom_select (int n_bits, vcl_si_set * read_map,
 217                           vcl_si_set * write_map, vcl_si_set * except_map,
 218                           double wait_for_time);
 219
 220 extern int vppcom_epoll_create (void);
 221 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
 222                              uint32_t session_handle,
 223                              struct epoll_event *event);
 224 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
 225                               int maxevents, double wait_for_time);
 226 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
 227                                 void *buffer, uint32_t * buflen);
 228 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
 229                                     uint32_t buflen, int flags,
 230                                     vppcom_endpt_t * ep);
 231 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
 232                                   uint32_t buflen, int flags,
 233                                   vppcom_endpt_t * ep);
 234 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
 235                         double wait_for_time);
 236 extern int vppcom_mq_epoll_fd (void);
 237 extern int vppcom_session_index (vcl_session_handle_t session_handle);
 238 extern int vppcom_session_worker (vcl_session_handle_t session_handle);
 239
 240 extern int vppcom_session_read_segments (uint32_t session_handle,
 241                                          vppcom_data_segment_t * ds,
 242                                          uint32_t n_segments,
 243                                          uint32_t max_bytes);
 244 extern void vppcom_session_free_segments (uint32_t session_handle,
 245                                           uint32_t n_bytes);
 246 extern int vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
 247 extern int vppcom_del_cert_key_pair (uint32_t ckpair_index);
 248 extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str);
 249 extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
 250 extern int vppcom_session_listener (uint32_t session_handle);
 251 extern int vppcom_session_n_accepted (uint32_t session_handle);
 252
 253 extern const char *vppcom_proto_str (vppcom_proto_t proto);
 254 extern const char *vppcom_retval_str (int retval);
 255
 256 /**
 257  * Request from application to register a new worker
 258  *
 259  * Expectation is that applications will make use of this after a new pthread
 260  * is spawned.
 261  */
 262 extern int vppcom_worker_register (void);
 263
 264 /**
 265  * Unregister current worker
 266  */
 267 extern void vppcom_worker_unregister (void);
 268
 269 /**
 270  * Retrieve current worker index
 271  */
 272 extern int vppcom_worker_index (void);
 273
 274 /**
 275  * Set current worker index
 276  */
 277 extern void vppcom_worker_index_set (int);
 278
 279 /**
 280  * Returns the current worker's message queues epoll fd
 281  *
 282  * This only works if vcl is configured to do eventfd based message queue
 283  * notifications.
 284  */
 285 extern int vppcom_worker_mqs_epfd (void);
 286
 287 /**
 288  * Returns Session error
 289  *
 290  * Application can use this API to find the detailed session error
 291  */
 292 extern int vppcom_session_get_error (uint32_t session_handle);
 293
 294 /**
 295  * Returns true if current worker is disconnected from vpp
 296  *
 297  * Application can use this API to check if VPP is disconnected
 298  * as long as `use-mq-eventfd` is being set
 299  */
 300 extern int vppcom_worker_is_detached (void);
 301
 302 /* *INDENT-OFF* */
 303 #ifdef __cplusplus
 304 }
 305 #endif
 306 /* *INDENT-ON* */
 307
 308 #endif /* included_vppcom_h */
 309
 310 /*
 311  * fd.io coding-style-patch-verification: ON
 312  *
 313  * Local Variables:
 314  * eval: (c-set-style "gnu")
 315  * End:
 316  */