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