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
  46 typedef enum
  47 {
  48   VPPCOM_PROTO_TCP = 0,
  49   VPPCOM_PROTO_UDP,
  50 } vppcom_proto_t;
  51
  52 static inline char *
  53 vppcom_proto_str (vppcom_proto_t proto)
  54 {
  55   char *proto_str;
  56
  57   switch (proto)
  58     {
  59     case VPPCOM_PROTO_TCP:
  60       proto_str = "VPPCOM_PROTO_TCP";
  61       break;
  62     case VPPCOM_PROTO_UDP:
  63       proto_str = "VPPCOM_PROTO_UDP";
  64       break;
  65     default:
  66       proto_str = "UNKNOWN";
  67       break;
  68     }
  69   return proto_str;
  70 }
  71
  72 typedef enum
  73 {
  74   VPPCOM_IS_IP6 = 0,
  75   VPPCOM_IS_IP4,
  76 } vppcom_is_ip4_t;
  77
  78 typedef struct vppcom_endpt_t_
  79 {
  80   uint8_t is_cut_thru;
  81   uint8_t is_ip4;
  82   uint8_t *ip;
  83   uint16_t port;
  84 } vppcom_endpt_t;
  85
  86 typedef enum
  87 {
  88   VPPCOM_OK = 0,
  89   VPPCOM_EAGAIN = -EAGAIN,
  90   VPPCOM_EFAULT = -EFAULT,
  91   VPPCOM_ENOMEM = -ENOMEM,
  92   VPPCOM_EINVAL = -EINVAL,
  93   VPPCOM_EBADFD = -EBADFD,
  94   VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
  95   VPPCOM_ECONNABORTED = -ECONNABORTED,
  96   VPPCOM_ECONNRESET = -ECONNRESET,
  97   VPPCOM_ENOTCONN = -ENOTCONN,
  98   VPPCOM_ECONNREFUSED = -ECONNREFUSED,
  99   VPPCOM_ETIMEDOUT = -ETIMEDOUT,
 100 } vppcom_error_t;
 101
 102 typedef enum
 103 {
 104   VPPCOM_ATTR_GET_NREAD,
 105   VPPCOM_ATTR_GET_NWRITE,
 106   VPPCOM_ATTR_GET_FLAGS,
 107   VPPCOM_ATTR_SET_FLAGS,
 108   VPPCOM_ATTR_GET_LCL_ADDR,
 109   VPPCOM_ATTR_GET_PEER_ADDR,
 110   VPPCOM_ATTR_GET_LIBC_EPFD,
 111   VPPCOM_ATTR_SET_LIBC_EPFD,
 112   VPPCOM_ATTR_GET_PROTOCOL,
 113   VPPCOM_ATTR_GET_LISTEN,
 114   VPPCOM_ATTR_GET_ERROR,
 115   VPPCOM_ATTR_GET_TX_FIFO_LEN,
 116   VPPCOM_ATTR_SET_TX_FIFO_LEN,
 117   VPPCOM_ATTR_GET_RX_FIFO_LEN,
 118   VPPCOM_ATTR_SET_RX_FIFO_LEN,
 119   VPPCOM_ATTR_GET_REUSEADDR,
 120   VPPCOM_ATTR_SET_REUSEADDR,
 121   VPPCOM_ATTR_GET_REUSEPORT,
 122   VPPCOM_ATTR_SET_REUSEPORT,
 123   VPPCOM_ATTR_GET_BROADCAST,
 124   VPPCOM_ATTR_SET_BROADCAST,
 125   VPPCOM_ATTR_GET_V6ONLY,
 126   VPPCOM_ATTR_SET_V6ONLY,
 127   VPPCOM_ATTR_GET_KEEPALIVE,
 128   VPPCOM_ATTR_SET_KEEPALIVE,
 129   VPPCOM_ATTR_GET_TCP_NODELAY,
 130   VPPCOM_ATTR_SET_TCP_NODELAY,
 131   VPPCOM_ATTR_GET_TCP_KEEPIDLE,
 132   VPPCOM_ATTR_SET_TCP_KEEPIDLE,
 133   VPPCOM_ATTR_GET_TCP_KEEPINTVL,
 134   VPPCOM_ATTR_SET_TCP_KEEPINTVL,
 135   VPPCOM_ATTR_GET_TCP_USER_MSS,
 136   VPPCOM_ATTR_SET_TCP_USER_MSS,
 137 } vppcom_attr_op_t;
 138
 139 typedef struct _vcl_poll
 140 {
 141   uint32_t fds_ndx;
 142   uint32_t sid;
 143   short events;
 144   short *revents;
 145 } vcl_poll_t;
 146
 147 typedef struct vppcom_ioevent_
 148 {
 149   uint32_t session_index;
 150   size_t bytes;
 151 } vppcom_ioevent_t;
 152
 153
 154 /*
 155  * VPPCOM Public API Functions
 156  */
 157 static inline const char *
 158 vppcom_retval_str (int retval)
 159 {
 160   char *st;
 161
 162   switch (retval)
 163     {
 164     case VPPCOM_OK:
 165       st = "VPPCOM_OK";
 166       break;
 167
 168     case VPPCOM_EAGAIN:
 169       st = "VPPCOM_EAGAIN";
 170       break;
 171
 172     case VPPCOM_EFAULT:
 173       st = "VPPCOM_EFAULT";
 174       break;
 175
 176     case VPPCOM_ENOMEM:
 177       st = "VPPCOM_ENOMEM";
 178       break;
 179
 180     case VPPCOM_EINVAL:
 181       st = "VPPCOM_EINVAL";
 182       break;
 183
 184     case VPPCOM_EBADFD:
 185       st = "VPPCOM_EBADFD";
 186       break;
 187
 188     case VPPCOM_EAFNOSUPPORT:
 189       st = "VPPCOM_EAFNOSUPPORT";
 190       break;
 191
 192     case VPPCOM_ECONNABORTED:
 193       st = "VPPCOM_ECONNABORTED";
 194       break;
 195
 196     case VPPCOM_ECONNRESET:
 197       st = "VPPCOM_ECONNRESET";
 198       break;
 199
 200     case VPPCOM_ENOTCONN:
 201       st = "VPPCOM_ENOTCONN";
 202       break;
 203
 204     case VPPCOM_ECONNREFUSED:
 205       st = "VPPCOM_ECONNREFUSED";
 206       break;
 207
 208     case VPPCOM_ETIMEDOUT:
 209       st = "VPPCOM_ETIMEDOUT";
 210       break;
 211
 212     default:
 213       st = "UNKNOWN_STATE";
 214       break;
 215     }
 216
 217   return st;
 218 }
 219
 220 /**
 221  * User registered callback for when connection arrives on listener created
 222  * with vppcom_session_register_listener()
 223  * @param uint32_t - newly accepted session_index
 224  * @param vppcom_endpt_t* - ip/port information of remote
 225  * @param void* - user passed arg to pass back
 226  */
 227 typedef void (*vppcom_session_listener_cb) (uint32_t, vppcom_endpt_t *,
 228                                             void *);
 229
 230 /**
 231  * User registered callback for IO events (rx/tx)
 232  * @param vppcom_ioevent_t* -
 233  * @param void* - user passed arg to pass back
 234  */
 235 typedef void (*vppcom_session_ioevent_cb) (vppcom_ioevent_t *, void *);
 236
 237 /**
 238  * @brief vppcom_session_register_listener accepts a bound session_index, and
 239  * listens for connections.
 240  *
 241  * On successful connection, calls registered callback (cb) with new
 242  * session_index.
 243  *
 244  * On error, calls registered error callback (errcb).
 245  *
 246  * @param session_index - bound session_index to create listener on
 247  * @param cb  - on new accepted session callback
 248  * @param errcb  - on failure callback
 249  * @param flags - placeholder for future use. Must be ZERO
 250  * @param q_len - max listener connection backlog
 251  * @param ptr - user data
 252  * @return
 253  */
 254 extern int vppcom_session_register_ioevent_cb (uint32_t session_index,
 255                                                vppcom_session_ioevent_cb cb,
 256                                                uint8_t rx, void *ptr);
 257
 258 /**
 259  * User registered ERROR callback for any errors associated with
 260  * handling vppcom_session_register_listener() and connections
 261  * @param void* - user passed arg to pass back
 262  */
 263 typedef void (*vppcom_session_listener_errcb) (void *);
 264
 265 /**
 266  * @brief vppcom_session_register_listener accepts a bound session_index, and
 267  * listens for connections.
 268  *
 269  * On successful connection, calls registered callback (cb) with new
 270  * session_index.
 271  *
 272  * On error, calls registered error callback (errcb).
 273  *
 274  * @param session_index - bound session_index to create listener on
 275  * @param cb  - on new accepted session callback
 276  * @param errcb  - on failure callback
 277  * @param flags - placeholder for future use. Must be ZERO
 278  * @param q_len - max listener connection backlog
 279  * @param ptr - user data
 280  * @return
 281  */
 282 extern int vppcom_session_register_listener (uint32_t session_index,
 283                                              vppcom_session_listener_cb cb,
 284                                              vppcom_session_listener_errcb
 285                                              errcb, uint8_t flags, int q_len,
 286                                              void *ptr);
 287
 288 /* TBD: make these constructor/destructor function */
 289 extern int vppcom_app_create (char *app_name);
 290 extern void vppcom_app_destroy (void);
 291
 292 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
 293 extern int vppcom_session_close (uint32_t session_index);
 294
 295 extern int vppcom_session_bind (uint32_t session_index, vppcom_endpt_t * ep);
 296 extern int vppcom_session_listen (uint32_t session_index, uint32_t q_len);
 297
 298 extern int vppcom_session_accept (uint32_t session_index,
 299                                   vppcom_endpt_t * client_ep, uint32_t flags);
 300
 301 extern int vppcom_session_connect (uint32_t session_index,
 302                                    vppcom_endpt_t * server_ep);
 303 extern int vppcom_session_read (uint32_t session_index, void *buf, size_t n);
 304 extern int vppcom_session_write (uint32_t session_index, void *buf, size_t n);
 305
 306 extern int vppcom_select (unsigned long n_bits,
 307                           unsigned long *read_map,
 308                           unsigned long *write_map,
 309                           unsigned long *except_map, double wait_for_time);
 310
 311 extern int vppcom_epoll_create (void);
 312 extern int vppcom_epoll_ctl (uint32_t vep_idx, int op,
 313                              uint32_t session_index,
 314                              struct epoll_event *event);
 315 extern int vppcom_epoll_wait (uint32_t vep_idx, struct epoll_event *events,
 316                               int maxevents, double wait_for_time);
 317 extern int vppcom_session_attr (uint32_t session_index, uint32_t op,
 318                                 void *buffer, uint32_t * buflen);
 319 extern int vppcom_session_recvfrom (uint32_t session_index, void *buffer,
 320                                     uint32_t buflen, int flags,
 321                                     vppcom_endpt_t * ep);
 322 extern int vppcom_session_sendto (uint32_t session_index, void *buffer,
 323                                   uint32_t buflen, int flags,
 324                                   vppcom_endpt_t * ep);
 325 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
 326                         double wait_for_time);
 327
 328 /* *INDENT-OFF* */
 329 #ifdef __cplusplus
 330 }
 331 #endif
 332 /* *INDENT-ON* */
 333
 334 #endif /* included_vppcom_h */
 335
 336 /*
 337  * fd.io coding-style-patch-verification: ON
 338  *
 339  * Local Variables:
 340  * eval: (c-set-style "gnu")
 341  * End:
 342  */