src/vcl/vppcom.h

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