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/poll.h>
  22 #include <sys/epoll.h>
  23
  24 /* *INDENT-OFF* */
  25 #ifdef __cplusplus
  26 extern "C"
  27 {
  28 #endif
  29 /* *INDENT-ON* */
  30
  31 /*
  32  * VPPCOM Public API Definitions, Enums, and Data Structures
  33  */
  34 #define INVALID_SESSION_ID                      ((u32)~0)
  35 #define VPPCOM_CONF_DEFAULT                     "/etc/vpp/vcl.conf"
  36 #define VPPCOM_ENV_CONF                         "VCL_CONFIG"
  37 #define VPPCOM_ENV_DEBUG                        "VCL_DEBUG"
  38 #define VPPCOM_ENV_API_PREFIX                   "VCL_API_PREFIX"
  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_VPP_API_SOCKET               "VCL_VPP_API_SOCKET"
  46
  47 typedef enum
  48 {
  49   VPPCOM_PROTO_TCP = 0,
  50   VPPCOM_PROTO_UDP,
  51   VPPCOM_PROTO_SCTP,
  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_SCTP:
  72       proto_str = "SCTP";
  73       break;
  74     case VPPCOM_PROTO_TLS:
  75       proto_str = "TLS";
  76       break;
  77     case VPPCOM_PROTO_UDPC:
  78       proto_str = "UDPC";
  79       break;
  80     case VPPCOM_PROTO_QUIC:
  81       proto_str = "QUIC";
  82       break;
  83     default:
  84       proto_str = "UNKNOWN";
  85       break;
  86     }
  87   return proto_str;
  88 }
  89
  90 static inline int
  91 vcl_proto_is_dgram (uint8_t proto)
  92 {
  93   return proto == VPPCOM_PROTO_UDP || proto == VPPCOM_PROTO_UDPC;
  94 }
  95
  96 typedef enum
  97 {
  98   VPPCOM_IS_IP6 = 0,
  99   VPPCOM_IS_IP4,
 100 } vppcom_is_ip4_t;
 101
 102 typedef struct vppcom_endpt_t_
 103 {
 104   uint8_t is_cut_thru;
 105   uint8_t is_ip4;
 106   uint8_t *ip;
 107   uint16_t port;
 108   uint64_t transport_opts;
 109 } vppcom_endpt_t;
 110
 111 typedef uint32_t vcl_session_handle_t;
 112
 113 typedef enum
 114 {
 115   VPPCOM_OK = 0,
 116   VPPCOM_EAGAIN = -EAGAIN,
 117   VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
 118   VPPCOM_EFAULT = -EFAULT,
 119   VPPCOM_ENOMEM = -ENOMEM,
 120   VPPCOM_EINVAL = -EINVAL,
 121   VPPCOM_EBADFD = -EBADFD,
 122   VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
 123   VPPCOM_ECONNABORTED = -ECONNABORTED,
 124   VPPCOM_ECONNRESET = -ECONNRESET,
 125   VPPCOM_ENOTCONN = -ENOTCONN,
 126   VPPCOM_ECONNREFUSED = -ECONNREFUSED,
 127   VPPCOM_ETIMEDOUT = -ETIMEDOUT,
 128   VPPCOM_EEXIST = -EEXIST
 129 } vppcom_error_t;
 130
 131 typedef enum
 132 {
 133   VPPCOM_ATTR_GET_NREAD,
 134   VPPCOM_ATTR_GET_NWRITE,
 135   VPPCOM_ATTR_GET_FLAGS,
 136   VPPCOM_ATTR_SET_FLAGS,
 137   VPPCOM_ATTR_GET_LCL_ADDR,
 138   VPPCOM_ATTR_GET_PEER_ADDR,
 139   VPPCOM_ATTR_GET_LIBC_EPFD,
 140   VPPCOM_ATTR_SET_LIBC_EPFD,
 141   VPPCOM_ATTR_GET_PROTOCOL,
 142   VPPCOM_ATTR_GET_LISTEN,
 143   VPPCOM_ATTR_GET_ERROR,
 144   VPPCOM_ATTR_GET_TX_FIFO_LEN,
 145   VPPCOM_ATTR_SET_TX_FIFO_LEN,
 146   VPPCOM_ATTR_GET_RX_FIFO_LEN,
 147   VPPCOM_ATTR_SET_RX_FIFO_LEN,
 148   VPPCOM_ATTR_GET_REUSEADDR,
 149   VPPCOM_ATTR_SET_REUSEADDR,
 150   VPPCOM_ATTR_GET_REUSEPORT,
 151   VPPCOM_ATTR_SET_REUSEPORT,
 152   VPPCOM_ATTR_GET_BROADCAST,
 153   VPPCOM_ATTR_SET_BROADCAST,
 154   VPPCOM_ATTR_GET_V6ONLY,
 155   VPPCOM_ATTR_SET_V6ONLY,
 156   VPPCOM_ATTR_GET_KEEPALIVE,
 157   VPPCOM_ATTR_SET_KEEPALIVE,
 158   VPPCOM_ATTR_GET_TCP_NODELAY,
 159   VPPCOM_ATTR_SET_TCP_NODELAY,
 160   VPPCOM_ATTR_GET_TCP_KEEPIDLE,
 161   VPPCOM_ATTR_SET_TCP_KEEPIDLE,
 162   VPPCOM_ATTR_GET_TCP_KEEPINTVL,
 163   VPPCOM_ATTR_SET_TCP_KEEPINTVL,
 164   VPPCOM_ATTR_GET_TCP_USER_MSS,
 165   VPPCOM_ATTR_SET_TCP_USER_MSS,
 166   VPPCOM_ATTR_SET_SHUT,
 167   VPPCOM_ATTR_GET_SHUT,
 168 } vppcom_attr_op_t;
 169
 170 typedef struct _vcl_poll
 171 {
 172   uint32_t fds_ndx;
 173   vcl_session_handle_t sh;
 174   short events;
 175   short revents;
 176 } vcl_poll_t;
 177
 178 typedef struct vppcom_data_segment_
 179 {
 180   unsigned char *data;
 181   uint32_t len;
 182 } vppcom_data_segment_t;
 183
 184 typedef vppcom_data_segment_t vppcom_data_segments_t[2];
 185
 186 typedef unsigned long vcl_si_set;
 187
 188 /*
 189  * VPPCOM Public API Functions
 190  */
 191 static inline const char *
 192 vppcom_retval_str (int retval)
 193 {
 194   char *st;
 195
 196   switch (retval)
 197     {
 198     case VPPCOM_OK:
 199       st = "VPPCOM_OK";
 200       break;
 201
 202     case VPPCOM_EAGAIN:
 203       st = "VPPCOM_EAGAIN";
 204       break;
 205
 206     case VPPCOM_EFAULT:
 207       st = "VPPCOM_EFAULT";
 208       break;
 209
 210     case VPPCOM_ENOMEM:
 211       st = "VPPCOM_ENOMEM";
 212       break;
 213
 214     case VPPCOM_EINVAL:
 215       st = "VPPCOM_EINVAL";
 216       break;
 217
 218     case VPPCOM_EBADFD:
 219       st = "VPPCOM_EBADFD";
 220       break;
 221
 222     case VPPCOM_EAFNOSUPPORT:
 223       st = "VPPCOM_EAFNOSUPPORT";
 224       break;
 225
 226     case VPPCOM_ECONNABORTED:
 227       st = "VPPCOM_ECONNABORTED";
 228       break;
 229
 230     case VPPCOM_ECONNRESET:
 231       st = "VPPCOM_ECONNRESET";
 232       break;
 233
 234     case VPPCOM_ENOTCONN:
 235       st = "VPPCOM_ENOTCONN";
 236       break;
 237
 238     case VPPCOM_ECONNREFUSED:
 239       st = "VPPCOM_ECONNREFUSED";
 240       break;
 241
 242     case VPPCOM_ETIMEDOUT:
 243       st = "VPPCOM_ETIMEDOUT";
 244       break;
 245
 246     default:
 247       st = "UNKNOWN_STATE";
 248       break;
 249     }
 250
 251   return st;
 252 }
 253
 254 /* TBD: make these constructor/destructor function */
 255 extern int vppcom_app_create (char *app_name);
 256 extern void vppcom_app_destroy (void);
 257
 258 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
 259 extern int vppcom_session_close (uint32_t session_handle);
 260 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
 261 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
 262
 263 extern int vppcom_session_accept (uint32_t session_handle,
 264                                   vppcom_endpt_t * client_ep, uint32_t flags);
 265
 266 extern int vppcom_session_connect (uint32_t session_handle,
 267                                    vppcom_endpt_t * server_ep);
 268 extern int vppcom_session_stream_connect (uint32_t session_handle,
 269                                           uint32_t parent_session_handle);
 270 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
 271 extern int vppcom_session_write (uint32_t session_handle, void *buf,
 272                                  size_t n);
 273 extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
 274                                      size_t n);
 275
 276 extern int vppcom_select (int n_bits, vcl_si_set * read_map,
 277                           vcl_si_set * write_map, vcl_si_set * except_map,
 278                           double wait_for_time);
 279
 280 extern int vppcom_epoll_create (void);
 281 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
 282                              uint32_t session_handle,
 283                              struct epoll_event *event);
 284 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
 285                               int maxevents, double wait_for_time);
 286 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
 287                                 void *buffer, uint32_t * buflen);
 288 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
 289                                     uint32_t buflen, int flags,
 290                                     vppcom_endpt_t * ep);
 291 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
 292                                   uint32_t buflen, int flags,
 293                                   vppcom_endpt_t * ep);
 294 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
 295                         double wait_for_time);
 296 extern int vppcom_mq_epoll_fd (void);
 297 extern int vppcom_session_index (vcl_session_handle_t session_handle);
 298 extern int vppcom_session_worker (vcl_session_handle_t session_handle);
 299
 300 extern int vppcom_session_read_segments (uint32_t session_handle,
 301                                          vppcom_data_segments_t ds);
 302 extern void vppcom_session_free_segments (uint32_t session_handle,
 303                                           vppcom_data_segments_t ds);
 304 extern int vppcom_session_tls_add_cert (uint32_t session_handle, char *cert,
 305                                         uint32_t cert_len);
 306 extern int vppcom_session_tls_add_key (uint32_t session_handle, char *key,
 307                                        uint32_t key_len);
 308 extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
 309                                      uint32_t max_bytes);
 310 extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str);
 311 extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
 312 extern int vppcom_session_listener (uint32_t session_handle);
 313 extern int vppcom_session_n_accepted (uint32_t session_handle);
 314
 315 /**
 316  * Request from application to register a new worker
 317  *
 318  * Expectation is that applications will make use of this after a new pthread
 319  * is spawned.
 320  */
 321 extern int vppcom_worker_register (void);
 322
 323 /**
 324  * Unregister current worker
 325  */
 326 extern void vppcom_worker_unregister (void);
 327
 328 /**
 329  * Retrieve current worker index
 330  */
 331 extern int vppcom_worker_index (void);
 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  */