2 * Copyright (c) 2017-2019 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #ifndef included_vppcom_h
17 #define included_vppcom_h
22 #include <sys/epoll.h>
32 * VPPCOM Public API Definitions, Enums, and Data Structures
34 #define INVALID_SESSION_ID ((u32)~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 #define VPPCOM_ENV_VPP_API_SOCKET "VCL_VPP_API_SOCKET"
59 vppcom_proto_str (vppcom_proto_t proto)
65 case VPPCOM_PROTO_TCP:
68 case VPPCOM_PROTO_UDP:
71 case VPPCOM_PROTO_SCTP:
74 case VPPCOM_PROTO_TLS:
77 case VPPCOM_PROTO_UDPC:
80 case VPPCOM_PROTO_QUIC:
84 proto_str = "UNKNOWN";
91 vcl_proto_is_dgram (uint8_t proto)
93 return proto == VPPCOM_PROTO_UDP || proto == VPPCOM_PROTO_UDPC;
102 typedef struct vppcom_endpt_t_
108 uint64_t parent_handle;
111 typedef uint32_t vcl_session_handle_t;
116 VPPCOM_EAGAIN = -EAGAIN,
117 VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
118 VPPCOM_EFAULT = -EFAULT,
119 VPPCOM_ENOMEM = -ENOMEM,
120 VPPCOM_EINVAL = -EINVAL,
121 VPPCOM_EBADFD = -EBADFD,
122 VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
123 VPPCOM_ECONNABORTED = -ECONNABORTED,
124 VPPCOM_ECONNRESET = -ECONNRESET,
125 VPPCOM_ENOTCONN = -ENOTCONN,
126 VPPCOM_ECONNREFUSED = -ECONNREFUSED,
127 VPPCOM_ETIMEDOUT = -ETIMEDOUT,
128 VPPCOM_EEXIST = -EEXIST
133 VPPCOM_ATTR_GET_NREAD,
134 VPPCOM_ATTR_GET_NWRITE,
135 VPPCOM_ATTR_GET_FLAGS,
136 VPPCOM_ATTR_SET_FLAGS,
137 VPPCOM_ATTR_GET_LCL_ADDR,
138 VPPCOM_ATTR_GET_PEER_ADDR,
139 VPPCOM_ATTR_GET_LIBC_EPFD,
140 VPPCOM_ATTR_SET_LIBC_EPFD,
141 VPPCOM_ATTR_GET_PROTOCOL,
142 VPPCOM_ATTR_GET_LISTEN,
143 VPPCOM_ATTR_GET_ERROR,
144 VPPCOM_ATTR_GET_TX_FIFO_LEN,
145 VPPCOM_ATTR_SET_TX_FIFO_LEN,
146 VPPCOM_ATTR_GET_RX_FIFO_LEN,
147 VPPCOM_ATTR_SET_RX_FIFO_LEN,
148 VPPCOM_ATTR_GET_REUSEADDR,
149 VPPCOM_ATTR_SET_REUSEADDR,
150 VPPCOM_ATTR_GET_REUSEPORT,
151 VPPCOM_ATTR_SET_REUSEPORT,
152 VPPCOM_ATTR_GET_BROADCAST,
153 VPPCOM_ATTR_SET_BROADCAST,
154 VPPCOM_ATTR_GET_V6ONLY,
155 VPPCOM_ATTR_SET_V6ONLY,
156 VPPCOM_ATTR_GET_KEEPALIVE,
157 VPPCOM_ATTR_SET_KEEPALIVE,
158 VPPCOM_ATTR_GET_TCP_NODELAY,
159 VPPCOM_ATTR_SET_TCP_NODELAY,
160 VPPCOM_ATTR_GET_TCP_KEEPIDLE,
161 VPPCOM_ATTR_SET_TCP_KEEPIDLE,
162 VPPCOM_ATTR_GET_TCP_KEEPINTVL,
163 VPPCOM_ATTR_SET_TCP_KEEPINTVL,
164 VPPCOM_ATTR_GET_TCP_USER_MSS,
165 VPPCOM_ATTR_SET_TCP_USER_MSS,
166 VPPCOM_ATTR_SET_SHUT,
167 VPPCOM_ATTR_GET_SHUT,
170 typedef struct _vcl_poll
173 vcl_session_handle_t sh;
178 typedef struct vppcom_data_segment_
182 } vppcom_data_segment_t;
184 typedef vppcom_data_segment_t vppcom_data_segments_t[2];
186 typedef unsigned long vcl_si_set;
189 * VPPCOM Public API Functions
191 static inline const char *
192 vppcom_retval_str (int retval)
203 st = "VPPCOM_EAGAIN";
207 st = "VPPCOM_EFAULT";
211 st = "VPPCOM_ENOMEM";
215 st = "VPPCOM_EINVAL";
219 st = "VPPCOM_EBADFD";
222 case VPPCOM_EAFNOSUPPORT:
223 st = "VPPCOM_EAFNOSUPPORT";
226 case VPPCOM_ECONNABORTED:
227 st = "VPPCOM_ECONNABORTED";
230 case VPPCOM_ECONNRESET:
231 st = "VPPCOM_ECONNRESET";
234 case VPPCOM_ENOTCONN:
235 st = "VPPCOM_ENOTCONN";
238 case VPPCOM_ECONNREFUSED:
239 st = "VPPCOM_ECONNREFUSED";
242 case VPPCOM_ETIMEDOUT:
243 st = "VPPCOM_ETIMEDOUT";
247 st = "UNKNOWN_STATE";
254 /* TBD: make these constructor/destructor function */
255 extern int vppcom_app_create (char *app_name);
256 extern void vppcom_app_destroy (void);
258 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
259 extern int vppcom_session_close (uint32_t session_handle);
260 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
261 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
263 extern int vppcom_session_accept (uint32_t session_handle,
264 vppcom_endpt_t * client_ep, uint32_t flags);
266 extern int vppcom_session_connect (uint32_t session_handle,
267 vppcom_endpt_t * server_ep);
268 extern int vppcom_session_stream_connect (uint32_t session_handle,
269 uint32_t parent_session_handle);
270 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
271 extern int vppcom_session_write (uint32_t session_handle, void *buf,
273 extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
276 extern int vppcom_select (int n_bits, vcl_si_set * read_map,
277 vcl_si_set * write_map, vcl_si_set * except_map,
278 double wait_for_time);
280 extern int vppcom_epoll_create (void);
281 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
282 uint32_t session_handle,
283 struct epoll_event *event);
284 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
285 int maxevents, double wait_for_time);
286 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
287 void *buffer, uint32_t * buflen);
288 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
289 uint32_t buflen, int flags,
290 vppcom_endpt_t * ep);
291 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
292 uint32_t buflen, int flags,
293 vppcom_endpt_t * ep);
294 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
295 double wait_for_time);
296 extern int vppcom_mq_epoll_fd (void);
297 extern int vppcom_session_index (vcl_session_handle_t session_handle);
298 extern int vppcom_session_worker (vcl_session_handle_t session_handle);
300 extern int vppcom_session_read_segments (uint32_t session_handle,
301 vppcom_data_segments_t ds);
302 extern void vppcom_session_free_segments (uint32_t session_handle,
303 vppcom_data_segments_t ds);
304 extern int vppcom_session_tls_add_cert (uint32_t session_handle, char *cert,
306 extern int vppcom_session_tls_add_key (uint32_t session_handle, char *key,
308 extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
310 extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str);
311 extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
312 extern int vppcom_session_listener (uint32_t session_handle);
313 extern int vppcom_session_n_accepted (uint32_t session_handle);
316 * Request from application to register a new worker
318 * Expectation is that applications will make use of this after a new pthread
321 extern int vppcom_worker_register (void);
324 * Unregister current worker
326 extern void vppcom_worker_unregister (void);
329 * Retrieve current worker index
331 extern int vppcom_worker_index (void);
334 * Returns the current worker's message queues epoll fd
336 * This only works if vcl is configured to do eventfd based message queue
339 extern int vppcom_worker_mqs_epfd (void);
347 #endif /* included_vppcom_h */
350 * fd.io coding-style-patch-verification: ON
353 * eval: (c-set-style "gnu")