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:
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"
58 vppcom_proto_str (vppcom_proto_t proto)
64 case VPPCOM_PROTO_TCP:
67 case VPPCOM_PROTO_UDP:
70 case VPPCOM_PROTO_SCTP:
73 case VPPCOM_PROTO_TLS:
76 case VPPCOM_PROTO_UDPC:
80 proto_str = "UNKNOWN";
92 typedef struct vppcom_endpt_t_
100 typedef uint32_t vcl_session_handle_t;
105 VPPCOM_EAGAIN = -EAGAIN,
106 VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
107 VPPCOM_EFAULT = -EFAULT,
108 VPPCOM_ENOMEM = -ENOMEM,
109 VPPCOM_EINVAL = -EINVAL,
110 VPPCOM_EBADFD = -EBADFD,
111 VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
112 VPPCOM_ECONNABORTED = -ECONNABORTED,
113 VPPCOM_ECONNRESET = -ECONNRESET,
114 VPPCOM_ENOTCONN = -ENOTCONN,
115 VPPCOM_ECONNREFUSED = -ECONNREFUSED,
116 VPPCOM_ETIMEDOUT = -ETIMEDOUT,
117 VPPCOM_EEXIST = -EEXIST
122 VPPCOM_ATTR_GET_NREAD,
123 VPPCOM_ATTR_GET_NWRITE,
124 VPPCOM_ATTR_GET_FLAGS,
125 VPPCOM_ATTR_SET_FLAGS,
126 VPPCOM_ATTR_GET_LCL_ADDR,
127 VPPCOM_ATTR_GET_PEER_ADDR,
128 VPPCOM_ATTR_GET_LIBC_EPFD,
129 VPPCOM_ATTR_SET_LIBC_EPFD,
130 VPPCOM_ATTR_GET_PROTOCOL,
131 VPPCOM_ATTR_GET_LISTEN,
132 VPPCOM_ATTR_GET_ERROR,
133 VPPCOM_ATTR_GET_TX_FIFO_LEN,
134 VPPCOM_ATTR_SET_TX_FIFO_LEN,
135 VPPCOM_ATTR_GET_RX_FIFO_LEN,
136 VPPCOM_ATTR_SET_RX_FIFO_LEN,
137 VPPCOM_ATTR_GET_REUSEADDR,
138 VPPCOM_ATTR_SET_REUSEADDR,
139 VPPCOM_ATTR_GET_REUSEPORT,
140 VPPCOM_ATTR_SET_REUSEPORT,
141 VPPCOM_ATTR_GET_BROADCAST,
142 VPPCOM_ATTR_SET_BROADCAST,
143 VPPCOM_ATTR_GET_V6ONLY,
144 VPPCOM_ATTR_SET_V6ONLY,
145 VPPCOM_ATTR_GET_KEEPALIVE,
146 VPPCOM_ATTR_SET_KEEPALIVE,
147 VPPCOM_ATTR_GET_TCP_NODELAY,
148 VPPCOM_ATTR_SET_TCP_NODELAY,
149 VPPCOM_ATTR_GET_TCP_KEEPIDLE,
150 VPPCOM_ATTR_SET_TCP_KEEPIDLE,
151 VPPCOM_ATTR_GET_TCP_KEEPINTVL,
152 VPPCOM_ATTR_SET_TCP_KEEPINTVL,
153 VPPCOM_ATTR_GET_TCP_USER_MSS,
154 VPPCOM_ATTR_SET_TCP_USER_MSS,
155 VPPCOM_ATTR_SET_SHUT,
156 VPPCOM_ATTR_GET_SHUT,
159 typedef struct _vcl_poll
162 vcl_session_handle_t sh;
167 typedef struct vppcom_data_segment_
171 } vppcom_data_segment_t;
173 typedef vppcom_data_segment_t vppcom_data_segments_t[2];
175 typedef unsigned long vcl_si_set;
178 * VPPCOM Public API Functions
180 static inline const char *
181 vppcom_retval_str (int retval)
192 st = "VPPCOM_EAGAIN";
196 st = "VPPCOM_EFAULT";
200 st = "VPPCOM_ENOMEM";
204 st = "VPPCOM_EINVAL";
208 st = "VPPCOM_EBADFD";
211 case VPPCOM_EAFNOSUPPORT:
212 st = "VPPCOM_EAFNOSUPPORT";
215 case VPPCOM_ECONNABORTED:
216 st = "VPPCOM_ECONNABORTED";
219 case VPPCOM_ECONNRESET:
220 st = "VPPCOM_ECONNRESET";
223 case VPPCOM_ENOTCONN:
224 st = "VPPCOM_ENOTCONN";
227 case VPPCOM_ECONNREFUSED:
228 st = "VPPCOM_ECONNREFUSED";
231 case VPPCOM_ETIMEDOUT:
232 st = "VPPCOM_ETIMEDOUT";
236 st = "UNKNOWN_STATE";
243 /* TBD: make these constructor/destructor function */
244 extern int vppcom_app_create (char *app_name);
245 extern void vppcom_app_destroy (void);
247 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
248 extern int vppcom_session_close (uint32_t session_handle);
249 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
250 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
252 extern int vppcom_session_accept (uint32_t session_handle,
253 vppcom_endpt_t * client_ep, uint32_t flags);
255 extern int vppcom_session_connect (uint32_t session_handle,
256 vppcom_endpt_t * server_ep);
257 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
258 extern int vppcom_session_write (uint32_t session_handle, void *buf,
260 extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
263 extern int vppcom_select (int n_bits, vcl_si_set * read_map,
264 vcl_si_set * write_map, vcl_si_set * except_map,
265 double wait_for_time);
267 extern int vppcom_epoll_create (void);
268 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
269 uint32_t session_handle,
270 struct epoll_event *event);
271 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
272 int maxevents, double wait_for_time);
273 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
274 void *buffer, uint32_t * buflen);
275 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
276 uint32_t buflen, int flags,
277 vppcom_endpt_t * ep);
278 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
279 uint32_t buflen, int flags,
280 vppcom_endpt_t * ep);
281 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
282 double wait_for_time);
283 extern int vppcom_mq_epoll_fd (void);
284 extern int vppcom_session_index (vcl_session_handle_t session_handle);
285 extern int vppcom_session_worker (vcl_session_handle_t session_handle);
287 extern int vppcom_session_read_segments (uint32_t session_handle,
288 vppcom_data_segments_t ds);
289 extern void vppcom_session_free_segments (uint32_t session_handle,
290 vppcom_data_segments_t ds);
291 extern int vppcom_session_tls_add_cert (uint32_t session_handle, char *cert,
293 extern int vppcom_session_tls_add_key (uint32_t session_handle, char *key,
295 extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
299 * Request from application to register a new worker
301 * Expectation is that applications will make use of this after a new pthread
304 extern int vppcom_worker_register (void);
307 * Retrieve current worker index
309 extern int vppcom_worker_index (void);
312 * Returns the current worker's message queues epoll fd
314 * This only works if vcl is configured to do eventfd based message queue
317 extern int vppcom_worker_mqs_epfd (void);
325 #endif /* included_vppcom_h */
328 * fd.io coding-style-patch-verification: ON
331 * eval: (c-set-style "gnu")