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