src/vcl/vppcom.h

   1 /*
   2  * Copyright (c) 2017-2019 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_API_PREFIX                   "VCL_API_PREFIX"
  40 #define VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP      "VCL_APP_PROXY_TRANSPORT_TCP"
  41 #define VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP      "VCL_APP_PROXY_TRANSPORT_UDP"
  42 #define VPPCOM_ENV_APP_NAMESPACE_ID             "VCL_APP_NAMESPACE_ID"
  43 #define VPPCOM_ENV_APP_NAMESPACE_SECRET         "VCL_APP_NAMESPACE_SECRET"
  44 #define VPPCOM_ENV_APP_SCOPE_LOCAL              "VCL_APP_SCOPE_LOCAL"
  45 #define VPPCOM_ENV_APP_SCOPE_GLOBAL             "VCL_APP_SCOPE_GLOBAL"
  46 #define VPPCOM_ENV_VPP_API_SOCKET               "VCL_VPP_API_SOCKET"
  47
  48 typedef enum
  49 {
  50   VPPCOM_PROTO_TCP = 0,
  51   VPPCOM_PROTO_UDP,
  52   VPPCOM_PROTO_NONE,
  53   VPPCOM_PROTO_TLS,
  54   VPPCOM_PROTO_UDPC,
  55   VPPCOM_PROTO_QUIC,
  56 } vppcom_proto_t;
  57
  58 static inline char *
  59 vppcom_proto_str (vppcom_proto_t proto)
  60 {
  61   char *proto_str;
  62
  63   switch (proto)
  64     {
  65     case VPPCOM_PROTO_TCP:
  66       proto_str = "TCP";
  67       break;
  68     case VPPCOM_PROTO_UDP:
  69       proto_str = "UDP";
  70       break;
  71     case VPPCOM_PROTO_TLS:
  72       proto_str = "TLS";
  73       break;
  74     case VPPCOM_PROTO_UDPC:
  75       proto_str = "UDPC";
  76       break;
  77     case VPPCOM_PROTO_QUIC:
  78       proto_str = "QUIC";
  79       break;
  80     default:
  81       proto_str = "UNKNOWN";
  82       break;
  83     }
  84   return proto_str;
  85 }
  86
  87 static inline int
  88 vcl_proto_is_dgram (uint8_t proto)
  89 {
  90   return proto == VPPCOM_PROTO_UDP || proto == VPPCOM_PROTO_UDPC;
  91 }
  92
  93 typedef enum
  94 {
  95   VPPCOM_IS_IP6 = 0,
  96   VPPCOM_IS_IP4,
  97 } vppcom_is_ip4_t;
  98
  99 typedef struct vppcom_endpt_t_
 100 {
 101   uint8_t is_cut_thru;
 102   uint8_t is_ip4;
 103   uint8_t *ip;
 104   uint16_t port;
 105   uint64_t parent_handle;
 106 } vppcom_endpt_t;
 107
 108 typedef uint32_t vcl_session_handle_t;
 109
 110 typedef enum
 111 {
 112   VPPCOM_OK = 0,
 113   VPPCOM_EAGAIN = -EAGAIN,
 114   VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
 115   VPPCOM_EINPROGRESS = -EINPROGRESS,
 116   VPPCOM_EFAULT = -EFAULT,
 117   VPPCOM_ENOMEM = -ENOMEM,
 118   VPPCOM_EINVAL = -EINVAL,
 119   VPPCOM_EBADFD = -EBADFD,
 120   VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
 121   VPPCOM_ECONNABORTED = -ECONNABORTED,
 122   VPPCOM_ECONNRESET = -ECONNRESET,
 123   VPPCOM_ENOTCONN = -ENOTCONN,
 124   VPPCOM_ECONNREFUSED = -ECONNREFUSED,
 125   VPPCOM_ETIMEDOUT = -ETIMEDOUT,
 126   VPPCOM_EEXIST = -EEXIST
 127 } vppcom_error_t;
 128
 129 typedef enum
 130 {
 131   VPPCOM_ATTR_GET_NREAD,
 132   VPPCOM_ATTR_GET_NWRITE,
 133   VPPCOM_ATTR_GET_FLAGS,
 134   VPPCOM_ATTR_SET_FLAGS,
 135   VPPCOM_ATTR_GET_LCL_ADDR,
 136   VPPCOM_ATTR_SET_LCL_ADDR,
 137   VPPCOM_ATTR_GET_PEER_ADDR,
 138   VPPCOM_ATTR_GET_LIBC_EPFD,
 139   VPPCOM_ATTR_SET_LIBC_EPFD,
 140   VPPCOM_ATTR_GET_PROTOCOL,
 141   VPPCOM_ATTR_GET_LISTEN,
 142   VPPCOM_ATTR_GET_ERROR,
 143   VPPCOM_ATTR_GET_TX_FIFO_LEN,
 144   VPPCOM_ATTR_SET_TX_FIFO_LEN,
 145   VPPCOM_ATTR_GET_RX_FIFO_LEN,
 146   VPPCOM_ATTR_SET_RX_FIFO_LEN,
 147   VPPCOM_ATTR_GET_REUSEADDR,
 148   VPPCOM_ATTR_SET_REUSEADDR,
 149   VPPCOM_ATTR_GET_REUSEPORT,
 150   VPPCOM_ATTR_SET_REUSEPORT,
 151   VPPCOM_ATTR_GET_BROADCAST,
 152   VPPCOM_ATTR_SET_BROADCAST,
 153   VPPCOM_ATTR_GET_V6ONLY,
 154   VPPCOM_ATTR_SET_V6ONLY,
 155   VPPCOM_ATTR_GET_KEEPALIVE,
 156   VPPCOM_ATTR_SET_KEEPALIVE,
 157   VPPCOM_ATTR_GET_TCP_NODELAY,
 158   VPPCOM_ATTR_SET_TCP_NODELAY,
 159   VPPCOM_ATTR_GET_TCP_KEEPIDLE,
 160   VPPCOM_ATTR_SET_TCP_KEEPIDLE,
 161   VPPCOM_ATTR_GET_TCP_KEEPINTVL,
 162   VPPCOM_ATTR_SET_TCP_KEEPINTVL,
 163   VPPCOM_ATTR_GET_TCP_USER_MSS,
 164   VPPCOM_ATTR_SET_TCP_USER_MSS,
 165   VPPCOM_ATTR_SET_SHUT,
 166   VPPCOM_ATTR_GET_SHUT,
 167 } vppcom_attr_op_t;
 168
 169 typedef struct _vcl_poll
 170 {
 171   uint32_t fds_ndx;
 172   vcl_session_handle_t sh;
 173   short events;
 174   short revents;
 175 } vcl_poll_t;
 176
 177 typedef struct vppcom_data_segment_
 178 {
 179   unsigned char *data;
 180   uint32_t len;
 181 } vppcom_data_segment_t;
 182
 183 typedef vppcom_data_segment_t vppcom_data_segments_t[2];
 184
 185 typedef unsigned long vcl_si_set;
 186
 187 /*
 188  * VPPCOM Public API Functions
 189  */
 190 static inline const char *
 191 vppcom_retval_str (int retval)
 192 {
 193   char *st;
 194
 195   switch (retval)
 196     {
 197     case VPPCOM_OK:
 198       st = "VPPCOM_OK";
 199       break;
 200
 201     case VPPCOM_EAGAIN:
 202       st = "VPPCOM_EAGAIN";
 203       break;
 204
 205     case VPPCOM_EFAULT:
 206       st = "VPPCOM_EFAULT";
 207       break;
 208
 209     case VPPCOM_ENOMEM:
 210       st = "VPPCOM_ENOMEM";
 211       break;
 212
 213     case VPPCOM_EINVAL:
 214       st = "VPPCOM_EINVAL";
 215       break;
 216
 217     case VPPCOM_EBADFD:
 218       st = "VPPCOM_EBADFD";
 219       break;
 220
 221     case VPPCOM_EAFNOSUPPORT:
 222       st = "VPPCOM_EAFNOSUPPORT";
 223       break;
 224
 225     case VPPCOM_ECONNABORTED:
 226       st = "VPPCOM_ECONNABORTED";
 227       break;
 228
 229     case VPPCOM_ECONNRESET:
 230       st = "VPPCOM_ECONNRESET";
 231       break;
 232
 233     case VPPCOM_ENOTCONN:
 234       st = "VPPCOM_ENOTCONN";
 235       break;
 236
 237     case VPPCOM_ECONNREFUSED:
 238       st = "VPPCOM_ECONNREFUSED";
 239       break;
 240
 241     case VPPCOM_ETIMEDOUT:
 242       st = "VPPCOM_ETIMEDOUT";
 243       break;
 244
 245     default:
 246       st = "UNKNOWN_STATE";
 247       break;
 248     }
 249
 250   return st;
 251 }
 252
 253 /* TBD: make these constructor/destructor function */
 254 extern int vppcom_app_create (char *app_name);
 255 extern void vppcom_app_destroy (void);
 256
 257 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
 258 extern int vppcom_session_close (uint32_t session_handle);
 259 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
 260 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
 261
 262 extern int vppcom_session_accept (uint32_t session_handle,
 263                                   vppcom_endpt_t * client_ep, uint32_t flags);
 264
 265 extern int vppcom_session_connect (uint32_t session_handle,
 266                                    vppcom_endpt_t * server_ep);
 267 extern int vppcom_session_stream_connect (uint32_t session_handle,
 268                                           uint32_t parent_session_handle);
 269 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
 270 extern int vppcom_session_write (uint32_t session_handle, void *buf,
 271                                  size_t n);
 272 extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
 273                                      size_t n);
 274
 275 extern int vppcom_select (int n_bits, vcl_si_set * read_map,
 276                           vcl_si_set * write_map, vcl_si_set * except_map,
 277                           double wait_for_time);
 278
 279 extern int vppcom_epoll_create (void);
 280 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
 281                              uint32_t session_handle,
 282                              struct epoll_event *event);
 283 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
 284                               int maxevents, double wait_for_time);
 285 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
 286                                 void *buffer, uint32_t * buflen);
 287 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
 288                                     uint32_t buflen, int flags,
 289                                     vppcom_endpt_t * ep);
 290 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
 291                                   uint32_t buflen, int flags,
 292                                   vppcom_endpt_t * ep);
 293 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
 294                         double wait_for_time);
 295 extern int vppcom_mq_epoll_fd (void);
 296 extern int vppcom_session_index (vcl_session_handle_t session_handle);
 297 extern int vppcom_session_worker (vcl_session_handle_t session_handle);
 298
 299 extern int vppcom_session_read_segments (uint32_t session_handle,
 300                                          vppcom_data_segments_t ds);
 301 extern void vppcom_session_free_segments (uint32_t session_handle,
 302                                           vppcom_data_segments_t ds);
 303 extern int vppcom_session_tls_add_cert (uint32_t session_handle, char *cert,
 304                                         uint32_t cert_len);
 305 extern int vppcom_session_tls_add_key (uint32_t session_handle, char *key,
 306                                        uint32_t key_len);
 307 extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
 308                                      uint32_t max_bytes);
 309 extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str);
 310 extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
 311 extern int vppcom_session_listener (uint32_t session_handle);
 312 extern int vppcom_session_n_accepted (uint32_t session_handle);
 313
 314 /**
 315  * Request from application to register a new worker
 316  *
 317  * Expectation is that applications will make use of this after a new pthread
 318  * is spawned.
 319  */
 320 extern int vppcom_worker_register (void);
 321
 322 /**
 323  * Unregister current worker
 324  */
 325 extern void vppcom_worker_unregister (void);
 326
 327 /**
 328  * Retrieve current worker index
 329  */
 330 extern int vppcom_worker_index (void);
 331
 332 /**
 333  * Returns the current worker's message queues epoll fd
 334  *
 335  * This only works if vcl is configured to do eventfd based message queue
 336  * notifications.
 337  */
 338 extern int vppcom_worker_mqs_epfd (void);
 339
 340 /* *INDENT-OFF* */
 341 #ifdef __cplusplus
 342 }
 343 #endif
 344 /* *INDENT-ON* */
 345
 346 #endif /* included_vppcom_h */
 347
 348 /*
 349  * fd.io coding-style-patch-verification: ON
 350  *
 351  * Local Variables:
 352  * eval: (c-set-style "gnu")
 353  * End:
 354  */