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