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 (~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"
54 vppcom_proto_str (vppcom_proto_t proto)
60 case VPPCOM_PROTO_TCP:
61 proto_str = "VPPCOM_PROTO_TCP";
63 case VPPCOM_PROTO_UDP:
64 proto_str = "VPPCOM_PROTO_UDP";
67 proto_str = "UNKNOWN";
79 typedef struct vppcom_endpt_t_
90 VPPCOM_EAGAIN = -EAGAIN,
91 VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
92 VPPCOM_EFAULT = -EFAULT,
93 VPPCOM_ENOMEM = -ENOMEM,
94 VPPCOM_EINVAL = -EINVAL,
95 VPPCOM_EBADFD = -EBADFD,
96 VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
97 VPPCOM_ECONNABORTED = -ECONNABORTED,
98 VPPCOM_ECONNRESET = -ECONNRESET,
99 VPPCOM_ENOTCONN = -ENOTCONN,
100 VPPCOM_ECONNREFUSED = -ECONNREFUSED,
101 VPPCOM_ETIMEDOUT = -ETIMEDOUT,
102 VPPCOM_EEXIST = -EEXIST
107 VPPCOM_ATTR_GET_NREAD,
108 VPPCOM_ATTR_GET_NWRITE,
109 VPPCOM_ATTR_GET_FLAGS,
110 VPPCOM_ATTR_SET_FLAGS,
111 VPPCOM_ATTR_GET_LCL_ADDR,
112 VPPCOM_ATTR_GET_PEER_ADDR,
113 VPPCOM_ATTR_GET_LIBC_EPFD,
114 VPPCOM_ATTR_SET_LIBC_EPFD,
115 VPPCOM_ATTR_GET_PROTOCOL,
116 VPPCOM_ATTR_GET_LISTEN,
117 VPPCOM_ATTR_GET_ERROR,
118 VPPCOM_ATTR_GET_TX_FIFO_LEN,
119 VPPCOM_ATTR_SET_TX_FIFO_LEN,
120 VPPCOM_ATTR_GET_RX_FIFO_LEN,
121 VPPCOM_ATTR_SET_RX_FIFO_LEN,
122 VPPCOM_ATTR_GET_REUSEADDR,
123 VPPCOM_ATTR_SET_REUSEADDR,
124 VPPCOM_ATTR_GET_REUSEPORT,
125 VPPCOM_ATTR_SET_REUSEPORT,
126 VPPCOM_ATTR_GET_BROADCAST,
127 VPPCOM_ATTR_SET_BROADCAST,
128 VPPCOM_ATTR_GET_V6ONLY,
129 VPPCOM_ATTR_SET_V6ONLY,
130 VPPCOM_ATTR_GET_KEEPALIVE,
131 VPPCOM_ATTR_SET_KEEPALIVE,
132 VPPCOM_ATTR_GET_TCP_NODELAY,
133 VPPCOM_ATTR_SET_TCP_NODELAY,
134 VPPCOM_ATTR_GET_TCP_KEEPIDLE,
135 VPPCOM_ATTR_SET_TCP_KEEPIDLE,
136 VPPCOM_ATTR_GET_TCP_KEEPINTVL,
137 VPPCOM_ATTR_SET_TCP_KEEPINTVL,
138 VPPCOM_ATTR_GET_TCP_USER_MSS,
139 VPPCOM_ATTR_SET_TCP_USER_MSS,
140 VPPCOM_ATTR_GET_REFCNT,
143 typedef struct _vcl_poll
151 typedef struct vppcom_data_segment_
155 } vppcom_data_segment_t;
157 typedef vppcom_data_segment_t vppcom_data_segments_t[2];
160 * VPPCOM Public API Functions
162 static inline const char *
163 vppcom_retval_str (int retval)
174 st = "VPPCOM_EAGAIN";
178 st = "VPPCOM_EFAULT";
182 st = "VPPCOM_ENOMEM";
186 st = "VPPCOM_EINVAL";
190 st = "VPPCOM_EBADFD";
193 case VPPCOM_EAFNOSUPPORT:
194 st = "VPPCOM_EAFNOSUPPORT";
197 case VPPCOM_ECONNABORTED:
198 st = "VPPCOM_ECONNABORTED";
201 case VPPCOM_ECONNRESET:
202 st = "VPPCOM_ECONNRESET";
205 case VPPCOM_ENOTCONN:
206 st = "VPPCOM_ENOTCONN";
209 case VPPCOM_ECONNREFUSED:
210 st = "VPPCOM_ECONNREFUSED";
213 case VPPCOM_ETIMEDOUT:
214 st = "VPPCOM_ETIMEDOUT";
218 st = "UNKNOWN_STATE";
225 /* TBD: make these constructor/destructor function */
226 extern int vppcom_app_create (char *app_name);
227 extern void vppcom_app_destroy (void);
229 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
230 extern int vppcom_session_close (uint32_t session_handle);
231 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
232 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
234 extern int vppcom_session_accept (uint32_t session_handle,
235 vppcom_endpt_t * client_ep, uint32_t flags);
237 extern int vppcom_session_connect (uint32_t session_handle,
238 vppcom_endpt_t * server_ep);
239 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
240 extern int vppcom_session_write (uint32_t session_handle, void *buf,
243 extern int vppcom_select (unsigned long n_bits,
244 unsigned long *read_map,
245 unsigned long *write_map,
246 unsigned long *except_map, double wait_for_time);
248 extern int vppcom_epoll_create (void);
249 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
250 uint32_t session_handle,
251 struct epoll_event *event);
252 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
253 int maxevents, double wait_for_time);
254 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
255 void *buffer, uint32_t * buflen);
256 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
257 uint32_t buflen, int flags,
258 vppcom_endpt_t * ep);
259 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
260 uint32_t buflen, int flags,
261 vppcom_endpt_t * ep);
262 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
263 double wait_for_time);
264 extern int vppcom_mq_epoll_fd (void);
265 extern int vppcom_session_index (uint32_t session_handle);
266 extern int vppcom_session_handle (uint32_t session_index);
268 extern int vppcom_session_read_segments (uint32_t session_handle,
269 vppcom_data_segments_t ds);
270 extern void vppcom_session_free_segments (uint32_t session_handle,
271 vppcom_data_segments_t ds);
272 extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
276 * Request from application to register a new worker
278 * Expectation is that applications will make use of this after a new pthread
281 extern int vppcom_worker_register (void);
284 * Retrieve current worker index
286 extern int vppcom_worker_index (void);
294 #endif /* included_vppcom_h */
297 * fd.io coding-style-patch-verification: ON
300 * eval: (c-set-style "gnu")