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