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_APP_PROXY_TRANSPORT_TCP   "VCL_APP_PROXY_TRANSPORT_TCP"
  39 #define VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP   "VCL_APP_PROXY_TRANSPORT_UDP"
  40 #define VPPCOM_ENV_APP_NAMESPACE_ID          "VCL_APP_NAMESPACE_ID"
  41 #define VPPCOM_ENV_APP_NAMESPACE_SECRET      "VCL_APP_NAMESPACE_SECRET"
  42 #define VPPCOM_ENV_APP_SCOPE_LOCAL           "VCL_APP_SCOPE_LOCAL"
  43 #define VPPCOM_ENV_APP_SCOPE_GLOBAL          "VCL_APP_SCOPE_GLOBAL"
  44
  45 typedef enum
  46 {
  47   VPPCOM_PROTO_TCP = 0,
  48   VPPCOM_PROTO_UDP,
  49 } vppcom_proto_t;
  50
  51 static inline char *
  52 vppcom_proto_str (vppcom_proto_t proto)
  53 {
  54   char *proto_str;
  55
  56   switch (proto)
  57     {
  58     case VPPCOM_PROTO_TCP:
  59       proto_str = "VPPCOM_PROTO_TCP";
  60       break;
  61     case VPPCOM_PROTO_UDP:
  62       proto_str = "VPPCOM_PROTO_UDP";
  63       break;
  64     default:
  65       proto_str = "UNKNOWN";
  66       break;
  67     }
  68   return proto_str;
  69 }
  70
  71 typedef enum
  72 {
  73   VPPCOM_IS_IP6 = 0,
  74   VPPCOM_IS_IP4,
  75 } vppcom_is_ip4_t;
  76
  77 typedef struct vppcom_endpt_t_
  78 {
  79   uint8_t is_cut_thru;
  80   uint8_t is_ip4;
  81   uint8_t *ip;
  82   uint16_t port;
  83 } vppcom_endpt_t;
  84
  85 typedef enum
  86 {
  87   VPPCOM_OK = 0,
  88   VPPCOM_EAGAIN = -EAGAIN,
  89   VPPCOM_EFAULT = -EFAULT,
  90   VPPCOM_ENOMEM = -ENOMEM,
  91   VPPCOM_EINVAL = -EINVAL,
  92   VPPCOM_EBADFD = -EBADFD,
  93   VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
  94   VPPCOM_ECONNABORTED = -ECONNABORTED,
  95   VPPCOM_ECONNRESET = -ECONNRESET,
  96   VPPCOM_ENOTCONN = -ENOTCONN,
  97   VPPCOM_ECONNREFUSED = -ECONNREFUSED,
  98   VPPCOM_ETIMEDOUT = -ETIMEDOUT,
  99 } vppcom_error_t;
 100
 101 typedef enum
 102 {
 103   VPPCOM_ATTR_GET_NREAD,
 104   VPPCOM_ATTR_GET_NWRITE,
 105   VPPCOM_ATTR_GET_FLAGS,
 106   VPPCOM_ATTR_SET_FLAGS,
 107   VPPCOM_ATTR_GET_LCL_ADDR,
 108   VPPCOM_ATTR_GET_PEER_ADDR,
 109   VPPCOM_ATTR_GET_LIBC_EPFD,
 110   VPPCOM_ATTR_SET_LIBC_EPFD,
 111   VPPCOM_ATTR_GET_PROTOCOL,
 112   VPPCOM_ATTR_GET_LISTEN,
 113   VPPCOM_ATTR_GET_ERROR,
 114   VPPCOM_ATTR_GET_TX_FIFO_LEN,
 115   VPPCOM_ATTR_SET_TX_FIFO_LEN,
 116   VPPCOM_ATTR_GET_RX_FIFO_LEN,
 117   VPPCOM_ATTR_SET_RX_FIFO_LEN,
 118   VPPCOM_ATTR_GET_REUSEADDR,
 119   VPPCOM_ATTR_SET_REUSEADDR,
 120   VPPCOM_ATTR_GET_REUSEPORT,
 121   VPPCOM_ATTR_SET_REUSEPORT,
 122   VPPCOM_ATTR_GET_BROADCAST,
 123   VPPCOM_ATTR_SET_BROADCAST,
 124   VPPCOM_ATTR_GET_V6ONLY,
 125   VPPCOM_ATTR_SET_V6ONLY,
 126   VPPCOM_ATTR_GET_KEEPALIVE,
 127   VPPCOM_ATTR_SET_KEEPALIVE,
 128   VPPCOM_ATTR_GET_TCP_NODELAY,
 129   VPPCOM_ATTR_SET_TCP_NODELAY,
 130   VPPCOM_ATTR_GET_TCP_KEEPIDLE,
 131   VPPCOM_ATTR_SET_TCP_KEEPIDLE,
 132   VPPCOM_ATTR_GET_TCP_KEEPINTVL,
 133   VPPCOM_ATTR_SET_TCP_KEEPINTVL,
 134   VPPCOM_ATTR_GET_TCP_USER_MSS,
 135   VPPCOM_ATTR_SET_TCP_USER_MSS,
 136 } vppcom_attr_op_t;
 137
 138 typedef struct _vcl_poll
 139 {
 140   uint32_t fds_ndx;
 141   uint32_t sid;
 142   short events;
 143   short *revents;
 144 } vcl_poll_t;
 145
 146 /*
 147  * VPPCOM Public API Functions
 148  */
 149 static inline const char *
 150 vppcom_retval_str (int retval)
 151 {
 152   char *st;
 153
 154   switch (retval)
 155     {
 156     case VPPCOM_OK:
 157       st = "VPPCOM_OK";
 158       break;
 159
 160     case VPPCOM_EAGAIN:
 161       st = "VPPCOM_EAGAIN";
 162       break;
 163
 164     case VPPCOM_EFAULT:
 165       st = "VPPCOM_EFAULT";
 166       break;
 167
 168     case VPPCOM_ENOMEM:
 169       st = "VPPCOM_ENOMEM";
 170       break;
 171
 172     case VPPCOM_EINVAL:
 173       st = "VPPCOM_EINVAL";
 174       break;
 175
 176     case VPPCOM_EBADFD:
 177       st = "VPPCOM_EBADFD";
 178       break;
 179
 180     case VPPCOM_EAFNOSUPPORT:
 181       st = "VPPCOM_EAFNOSUPPORT";
 182       break;
 183
 184     case VPPCOM_ECONNABORTED:
 185       st = "VPPCOM_ECONNABORTED";
 186       break;
 187
 188     case VPPCOM_ECONNRESET:
 189       st = "VPPCOM_ECONNRESET";
 190       break;
 191
 192     case VPPCOM_ENOTCONN:
 193       st = "VPPCOM_ENOTCONN";
 194       break;
 195
 196     case VPPCOM_ECONNREFUSED:
 197       st = "VPPCOM_ECONNREFUSED";
 198       break;
 199
 200     case VPPCOM_ETIMEDOUT:
 201       st = "VPPCOM_ETIMEDOUT";
 202       break;
 203
 204     default:
 205       st = "UNKNOWN_STATE";
 206       break;
 207     }
 208
 209   return st;
 210 }
 211
 212 /* TBD: make these constructor/destructor function */
 213 extern int vppcom_app_create (char *app_name);
 214 extern void vppcom_app_destroy (void);
 215
 216 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
 217 extern int vppcom_session_close (uint32_t session_index);
 218
 219 extern int vppcom_session_bind (uint32_t session_index, vppcom_endpt_t * ep);
 220 extern int vppcom_session_listen (uint32_t session_index, uint32_t q_len);
 221 extern int vppcom_session_accept (uint32_t session_index,
 222                                   vppcom_endpt_t * client_ep, uint32_t flags);
 223
 224 extern int vppcom_session_connect (uint32_t session_index,
 225                                    vppcom_endpt_t * server_ep);
 226 extern int vppcom_session_read (uint32_t session_index, void *buf, size_t n);
 227 extern int vppcom_session_write (uint32_t session_index, void *buf, size_t n);
 228
 229 extern int vppcom_select (unsigned long n_bits,
 230                           unsigned long *read_map,
 231                           unsigned long *write_map,
 232                           unsigned long *except_map, double wait_for_time);
 233
 234 extern int vppcom_epoll_create (void);
 235 extern int vppcom_epoll_ctl (uint32_t vep_idx, int op,
 236                              uint32_t session_index,
 237                              struct epoll_event *event);
 238 extern int vppcom_epoll_wait (uint32_t vep_idx, struct epoll_event *events,
 239                               int maxevents, double wait_for_time);
 240 extern int vppcom_session_attr (uint32_t session_index, uint32_t op,
 241                                 void *buffer, uint32_t * buflen);
 242 extern int vppcom_session_recvfrom (uint32_t session_index, void *buffer,
 243                                     uint32_t buflen, int flags,
 244                                     vppcom_endpt_t * ep);
 245 extern int vppcom_session_sendto (uint32_t session_index, void *buffer,
 246                                   uint32_t buflen, int flags,
 247                                   vppcom_endpt_t * ep);
 248 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
 249                         double wait_for_time);
 250
 251 /* *INDENT-OFF* */
 252 #ifdef __cplusplus
 253 }
 254 #endif
 255 /* *INDENT-ON* */
 256
 257 #endif /* included_vppcom_h */
 258
 259 /*
 260  * fd.io coding-style-patch-verification: ON
 261  *
 262  * Local Variables:
 263  * eval: (c-set-style "gnu")
 264  * End:
 265  */