src/vcl/vppcom.h

   1 /*
   2  * Copyright (c) 2017-2020 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/fcntl.h>
  22 #include <sys/poll.h>
  23 #include <sys/epoll.h>
  24
  25 /* *INDENT-OFF* */
  26 #ifdef __cplusplus
  27 extern "C"
  28 {
  29 #endif
  30 /* *INDENT-ON* */
  31
  32 /*
  33  * VPPCOM Public API Definitions, Enums, and Data Structures
  34  */
  35 #define INVALID_SESSION_ID                      ((u32)~0)
  36 #define VPPCOM_CONF_DEFAULT                     "/etc/vpp/vcl.conf"
  37 #define VPPCOM_ENV_CONF                         "VCL_CONFIG"
  38 #define VPPCOM_ENV_DEBUG                        "VCL_DEBUG"
  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_APP_USE_MQ_EVENTFD           "VCL_APP_USE_MQ_EVENTFD"
  46 #define VPPCOM_ENV_VPP_API_SOCKET               "VCL_VPP_API_SOCKET"
  47 #define VPPCOM_ENV_VPP_SAPI_SOCKET              "VCL_VPP_SAPI_SOCKET"
  48
  49   typedef enum
  50   {
  51     VPPCOM_PROTO_TCP = 0,
  52     VPPCOM_PROTO_UDP,
  53     VPPCOM_PROTO_NONE,
  54     VPPCOM_PROTO_TLS,
  55     VPPCOM_PROTO_QUIC,
  56     VPPCOM_PROTO_DTLS,
  57     VPPCOM_PROTO_SRTP,
  58   } vppcom_proto_t;
  59
  60   typedef enum
  61   {
  62     VPPCOM_IS_IP6 = 0,
  63     VPPCOM_IS_IP4,
  64   } vppcom_is_ip4_t;
  65
  66   typedef struct vppcom_endpt_t_
  67   {
  68     uint8_t is_cut_thru;
  69     uint8_t is_ip4;
  70     uint8_t *ip;
  71     uint16_t port;
  72     uint64_t parent_handle;
  73   } vppcom_endpt_t;
  74
  75 typedef uint32_t vcl_session_handle_t;
  76
  77 typedef struct vppcom_cert_key_pair_
  78 {
  79   char *cert;
  80   char *key;
  81   uint32_t cert_len;
  82   uint32_t key_len;
  83 } vppcom_cert_key_pair_t;
  84
  85 typedef enum
  86 {
  87   VPPCOM_OK = 0,
  88   VPPCOM_EAGAIN = -EAGAIN,
  89   VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
  90   VPPCOM_EINPROGRESS = -EINPROGRESS,
  91   VPPCOM_EFAULT = -EFAULT,
  92   VPPCOM_ENOMEM = -ENOMEM,
  93   VPPCOM_EINVAL = -EINVAL,
  94   VPPCOM_EBADFD = -EBADFD,
  95   VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
  96   VPPCOM_ECONNABORTED = -ECONNABORTED,
  97   VPPCOM_ECONNRESET = -ECONNRESET,
  98   VPPCOM_ENOTCONN = -ENOTCONN,
  99   VPPCOM_ECONNREFUSED = -ECONNREFUSED,
 100   VPPCOM_ETIMEDOUT = -ETIMEDOUT,
 101   VPPCOM_EEXIST = -EEXIST,
 102   VPPCOM_ENOPROTOOPT = -ENOPROTOOPT,
 103   VPPCOM_EPIPE = -EPIPE,
 104   VPPCOM_ENOENT = -ENOENT,
 105   VPPCOM_EADDRINUSE = -EADDRINUSE,
 106   VPPCOM_ENOTSUP = -ENOTSUP
 107 } vppcom_error_t;
 108
 109 typedef enum
 110 {
 111   VPPCOM_ATTR_GET_NREAD,
 112   VPPCOM_ATTR_GET_NWRITE,
 113   VPPCOM_ATTR_GET_FLAGS,
 114   VPPCOM_ATTR_SET_FLAGS,
 115   VPPCOM_ATTR_GET_LCL_ADDR,
 116   VPPCOM_ATTR_SET_LCL_ADDR,
 117   VPPCOM_ATTR_GET_PEER_ADDR,
 118   VPPCOM_ATTR_GET_LIBC_EPFD,
 119   VPPCOM_ATTR_SET_LIBC_EPFD,
 120   VPPCOM_ATTR_GET_PROTOCOL,
 121   VPPCOM_ATTR_GET_LISTEN,
 122   VPPCOM_ATTR_GET_ERROR,
 123   VPPCOM_ATTR_GET_TX_FIFO_LEN,
 124   VPPCOM_ATTR_SET_TX_FIFO_LEN,
 125   VPPCOM_ATTR_GET_RX_FIFO_LEN,
 126   VPPCOM_ATTR_SET_RX_FIFO_LEN,
 127   VPPCOM_ATTR_GET_REUSEADDR,
 128   VPPCOM_ATTR_SET_REUSEADDR,
 129   VPPCOM_ATTR_GET_REUSEPORT,
 130   VPPCOM_ATTR_SET_REUSEPORT,
 131   VPPCOM_ATTR_GET_BROADCAST,
 132   VPPCOM_ATTR_SET_BROADCAST,
 133   VPPCOM_ATTR_GET_V6ONLY,
 134   VPPCOM_ATTR_SET_V6ONLY,
 135   VPPCOM_ATTR_GET_KEEPALIVE,
 136   VPPCOM_ATTR_SET_KEEPALIVE,
 137   VPPCOM_ATTR_GET_TCP_NODELAY,
 138   VPPCOM_ATTR_SET_TCP_NODELAY,
 139   VPPCOM_ATTR_GET_TCP_KEEPIDLE,
 140   VPPCOM_ATTR_SET_TCP_KEEPIDLE,
 141   VPPCOM_ATTR_GET_TCP_KEEPINTVL,
 142   VPPCOM_ATTR_SET_TCP_KEEPINTVL,
 143   VPPCOM_ATTR_GET_TCP_USER_MSS,
 144   VPPCOM_ATTR_SET_TCP_USER_MSS,
 145   VPPCOM_ATTR_SET_CONNECTED,
 146   VPPCOM_ATTR_SET_CKPAIR,
 147   VPPCOM_ATTR_SET_VRF,
 148   VPPCOM_ATTR_GET_VRF,
 149   VPPCOM_ATTR_GET_DOMAIN,
 150   VPPCOM_ATTR_SET_ENDPT_EXT_CFG,
 151   VPPCOM_ATTR_SET_DSCP,
 152 } vppcom_attr_op_t;
 153
 154 typedef struct _vcl_poll
 155 {
 156   uint32_t fds_ndx;
 157   vcl_session_handle_t sh;
 158   short events;
 159   short revents;
 160 } vcl_poll_t;
 161
 162 typedef struct vppcom_data_segment_
 163 {
 164   unsigned char *data;
 165   uint32_t len;
 166 } vppcom_data_segment_t;
 167
 168 typedef vppcom_data_segment_t vppcom_data_segments_t[2];
 169
 170 typedef unsigned long vcl_si_set;
 171
 172 /*
 173  * VPPCOM Public API Functions
 174  */
 175
 176 extern int vppcom_app_create (const char *app_name);
 177 extern void vppcom_app_destroy (void);
 178
 179 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
 180 extern int vppcom_session_shutdown (uint32_t session_handle, int how);
 181 extern int vppcom_session_close (uint32_t session_handle);
 182 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
 183 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
 184
 185 extern int vppcom_session_accept (uint32_t session_handle,
 186                                   vppcom_endpt_t * client_ep, uint32_t flags);
 187
 188 extern int vppcom_session_connect (uint32_t session_handle,
 189                                    vppcom_endpt_t * server_ep);
 190 extern int vppcom_session_stream_connect (uint32_t session_handle,
 191                                           uint32_t parent_session_handle);
 192 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
 193 extern int vppcom_session_write (uint32_t session_handle, void *buf,
 194                                  size_t n);
 195 extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
 196                                      size_t n);
 197
 198 extern int vppcom_select (int n_bits, vcl_si_set * read_map,
 199                           vcl_si_set * write_map, vcl_si_set * except_map,
 200                           double wait_for_time);
 201
 202 extern int vppcom_epoll_create (void);
 203 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
 204                              uint32_t session_handle,
 205                              struct epoll_event *event);
 206 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
 207                               int maxevents, double wait_for_time);
 208 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
 209                                 void *buffer, uint32_t * buflen);
 210 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
 211                                     uint32_t buflen, int flags,
 212                                     vppcom_endpt_t * ep);
 213 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
 214                                   uint32_t buflen, int flags,
 215                                   vppcom_endpt_t * ep);
 216 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
 217                         double wait_for_time);
 218 extern int vppcom_mq_epoll_fd (void);
 219 extern int vppcom_session_index (vcl_session_handle_t session_handle);
 220 extern int vppcom_session_worker (vcl_session_handle_t session_handle);
 221
 222 extern int vppcom_session_read_segments (uint32_t session_handle,
 223                                          vppcom_data_segment_t * ds,
 224                                          uint32_t n_segments,
 225                                          uint32_t max_bytes);
 226 extern void vppcom_session_free_segments (uint32_t session_handle,
 227                                           uint32_t n_bytes);
 228 extern int vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
 229 extern int vppcom_del_cert_key_pair (uint32_t ckpair_index);
 230 extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str);
 231 extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
 232 extern int vppcom_session_listener (uint32_t session_handle);
 233 extern int vppcom_session_n_accepted (uint32_t session_handle);
 234
 235 extern const char *vppcom_proto_str (vppcom_proto_t proto);
 236 extern const char *vppcom_retval_str (int retval);
 237
 238 /**
 239  * Request from application to register a new worker
 240  *
 241  * Expectation is that applications will make use of this after a new pthread
 242  * is spawned.
 243  */
 244 extern int vppcom_worker_register (void);
 245
 246 /**
 247  * Unregister current worker
 248  */
 249 extern void vppcom_worker_unregister (void);
 250
 251 /**
 252  * Retrieve current worker index
 253  */
 254 extern int vppcom_worker_index (void);
 255
 256 /**
 257  * Set current worker index
 258  */
 259 extern void vppcom_worker_index_set (int);
 260
 261 /**
 262  * Returns the current worker's message queues epoll fd
 263  *
 264  * This only works if vcl is configured to do eventfd based message queue
 265  * notifications.
 266  */
 267 extern int vppcom_worker_mqs_epfd (void);
 268
 269 /**
 270  * Returns Session error
 271  *
 272  * Application can use this API to find the detailed session error
 273  */
 274 extern int vppcom_session_get_error (uint32_t session_handle);
 275
 276 /**
 277  * Returns true if current worker is disconnected from vpp
 278  *
 279  * Application can use this API to check if VPP is disconnected
 280  * as long as `use-mq-eventfd` is being set
 281  */
 282 extern int vppcom_worker_is_detached (void);
 283
 284 /* *INDENT-OFF* */
 285 #ifdef __cplusplus
 286 }
 287 #endif
 288 /* *INDENT-ON* */
 289
 290 #endif /* included_vppcom_h */
 291
 292 /*
 293  * fd.io coding-style-patch-verification: ON
 294  *
 295  * Local Variables:
 296  * eval: (c-set-style "gnu")
 297  * End:
 298  */