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_VPP_API_SOCKET               "VCL_VPP_API_SOCKET"
  46 #define VPPCOM_ENV_VPP_SAPI_SOCKET              "VCL_VPP_SAPI_SOCKET"
  47
  48   typedef enum
  49   {
  50     VPPCOM_PROTO_TCP = 0,
  51     VPPCOM_PROTO_UDP,
  52     VPPCOM_PROTO_NONE,
  53     VPPCOM_PROTO_TLS,
  54     VPPCOM_PROTO_QUIC,
  55     VPPCOM_PROTO_DTLS,
  56   } vppcom_proto_t;
  57
  58   typedef enum
  59   {
  60     VPPCOM_IS_IP6 = 0,
  61     VPPCOM_IS_IP4,
  62   } vppcom_is_ip4_t;
  63
  64   typedef struct vppcom_endpt_t_
  65   {
  66     uint8_t is_cut_thru;
  67     uint8_t is_ip4;
  68     uint8_t *ip;
  69     uint16_t port;
  70     uint64_t parent_handle;
  71   } vppcom_endpt_t;
  72
  73 typedef uint32_t vcl_session_handle_t;
  74
  75 typedef struct vppcom_cert_key_pair_
  76 {
  77   char *cert;
  78   char *key;
  79   uint32_t cert_len;
  80   uint32_t key_len;
  81 } vppcom_cert_key_pair_t;
  82
  83 typedef enum
  84 {
  85   VPPCOM_OK = 0,
  86   VPPCOM_EAGAIN = -EAGAIN,
  87   VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
  88   VPPCOM_EINPROGRESS = -EINPROGRESS,
  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_EEXIST = -EEXIST,
 100   VPPCOM_ENOPROTOOPT = -ENOPROTOOPT
 101 } vppcom_error_t;
 102
 103 typedef enum
 104 {
 105   VPPCOM_ATTR_GET_NREAD,
 106   VPPCOM_ATTR_GET_NWRITE,
 107   VPPCOM_ATTR_GET_FLAGS,
 108   VPPCOM_ATTR_SET_FLAGS,
 109   VPPCOM_ATTR_GET_LCL_ADDR,
 110   VPPCOM_ATTR_SET_LCL_ADDR,
 111   VPPCOM_ATTR_GET_PEER_ADDR,
 112   VPPCOM_ATTR_GET_LIBC_EPFD,
 113   VPPCOM_ATTR_SET_LIBC_EPFD,
 114   VPPCOM_ATTR_GET_PROTOCOL,
 115   VPPCOM_ATTR_GET_LISTEN,
 116   VPPCOM_ATTR_GET_ERROR,
 117   VPPCOM_ATTR_GET_TX_FIFO_LEN,
 118   VPPCOM_ATTR_SET_TX_FIFO_LEN,
 119   VPPCOM_ATTR_GET_RX_FIFO_LEN,
 120   VPPCOM_ATTR_SET_RX_FIFO_LEN,
 121   VPPCOM_ATTR_GET_REUSEADDR,
 122   VPPCOM_ATTR_SET_REUSEADDR,
 123   VPPCOM_ATTR_GET_REUSEPORT,
 124   VPPCOM_ATTR_SET_REUSEPORT,
 125   VPPCOM_ATTR_GET_BROADCAST,
 126   VPPCOM_ATTR_SET_BROADCAST,
 127   VPPCOM_ATTR_GET_V6ONLY,
 128   VPPCOM_ATTR_SET_V6ONLY,
 129   VPPCOM_ATTR_GET_KEEPALIVE,
 130   VPPCOM_ATTR_SET_KEEPALIVE,
 131   VPPCOM_ATTR_GET_TCP_NODELAY,
 132   VPPCOM_ATTR_SET_TCP_NODELAY,
 133   VPPCOM_ATTR_GET_TCP_KEEPIDLE,
 134   VPPCOM_ATTR_SET_TCP_KEEPIDLE,
 135   VPPCOM_ATTR_GET_TCP_KEEPINTVL,
 136   VPPCOM_ATTR_SET_TCP_KEEPINTVL,
 137   VPPCOM_ATTR_GET_TCP_USER_MSS,
 138   VPPCOM_ATTR_SET_TCP_USER_MSS,
 139   VPPCOM_ATTR_SET_SHUT,
 140   VPPCOM_ATTR_GET_SHUT,
 141   VPPCOM_ATTR_SET_CONNECTED,
 142   VPPCOM_ATTR_SET_CKPAIR,
 143   VPPCOM_ATTR_SET_VRF,
 144   VPPCOM_ATTR_GET_VRF,
 145   VPPCOM_ATTR_GET_DOMAIN,
 146 } vppcom_attr_op_t;
 147
 148 typedef struct _vcl_poll
 149 {
 150   uint32_t fds_ndx;
 151   vcl_session_handle_t sh;
 152   short events;
 153   short revents;
 154 } vcl_poll_t;
 155
 156 typedef struct vppcom_data_segment_
 157 {
 158   unsigned char *data;
 159   uint32_t len;
 160 } vppcom_data_segment_t;
 161
 162 typedef vppcom_data_segment_t vppcom_data_segments_t[2];
 163
 164 typedef unsigned long vcl_si_set;
 165
 166 /*
 167  * VPPCOM Public API Functions
 168  */
 169
 170 extern int vppcom_app_create (const char *app_name);
 171 extern void vppcom_app_destroy (void);
 172
 173 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
 174 extern int vppcom_session_close (uint32_t session_handle);
 175 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
 176 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
 177
 178 extern int vppcom_session_accept (uint32_t session_handle,
 179                                   vppcom_endpt_t * client_ep, uint32_t flags);
 180
 181 extern int vppcom_session_connect (uint32_t session_handle,
 182                                    vppcom_endpt_t * server_ep);
 183 extern int vppcom_session_stream_connect (uint32_t session_handle,
 184                                           uint32_t parent_session_handle);
 185 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
 186 extern int vppcom_session_write (uint32_t session_handle, void *buf,
 187                                  size_t n);
 188 extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
 189                                      size_t n);
 190
 191 extern int vppcom_select (int n_bits, vcl_si_set * read_map,
 192                           vcl_si_set * write_map, vcl_si_set * except_map,
 193                           double wait_for_time);
 194
 195 extern int vppcom_epoll_create (void);
 196 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
 197                              uint32_t session_handle,
 198                              struct epoll_event *event);
 199 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
 200                               int maxevents, double wait_for_time);
 201 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
 202                                 void *buffer, uint32_t * buflen);
 203 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
 204                                     uint32_t buflen, int flags,
 205                                     vppcom_endpt_t * ep);
 206 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
 207                                   uint32_t buflen, int flags,
 208                                   vppcom_endpt_t * ep);
 209 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
 210                         double wait_for_time);
 211 extern int vppcom_mq_epoll_fd (void);
 212 extern int vppcom_session_index (vcl_session_handle_t session_handle);
 213 extern int vppcom_session_worker (vcl_session_handle_t session_handle);
 214
 215 extern int vppcom_session_read_segments (uint32_t session_handle,
 216                                          vppcom_data_segment_t * ds,
 217                                          uint32_t n_segments,
 218                                          uint32_t max_bytes);
 219 extern void vppcom_session_free_segments (uint32_t session_handle,
 220                                           uint32_t n_bytes);
 221 extern int vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
 222 extern int vppcom_del_cert_key_pair (uint32_t ckpair_index);
 223 extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str);
 224 extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
 225 extern int vppcom_session_listener (uint32_t session_handle);
 226 extern int vppcom_session_n_accepted (uint32_t session_handle);
 227
 228 extern const char *vppcom_proto_str (vppcom_proto_t proto);
 229 extern const char *vppcom_retval_str (int retval);
 230
 231 /**
 232  * Request from application to register a new worker
 233  *
 234  * Expectation is that applications will make use of this after a new pthread
 235  * is spawned.
 236  */
 237 extern int vppcom_worker_register (void);
 238
 239 /**
 240  * Unregister current worker
 241  */
 242 extern void vppcom_worker_unregister (void);
 243
 244 /**
 245  * Retrieve current worker index
 246  */
 247 extern int vppcom_worker_index (void);
 248
 249 /**
 250  * Set current worker index
 251  */
 252 extern void vppcom_worker_index_set (int);
 253
 254 /**
 255  * Returns the current worker's message queues epoll fd
 256  *
 257  * This only works if vcl is configured to do eventfd based message queue
 258  * notifications.
 259  */
 260 extern int vppcom_worker_mqs_epfd (void);
 261
 262 /* *INDENT-OFF* */
 263 #ifdef __cplusplus
 264 }
 265 #endif
 266 /* *INDENT-ON* */
 267
 268 #endif /* included_vppcom_h */
 269
 270 /*
 271  * fd.io coding-style-patch-verification: ON
 272  *
 273  * Local Variables:
 274  * eval: (c-set-style "gnu")
 275  * End:
 276  */