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"
53 vppcom_proto_str (vppcom_proto_t proto)
59 case VPPCOM_PROTO_TCP:
60 proto_str = "VPPCOM_PROTO_TCP";
62 case VPPCOM_PROTO_UDP:
63 proto_str = "VPPCOM_PROTO_UDP";
66 proto_str = "UNKNOWN";
78 typedef struct vppcom_endpt_t_
89 VPPCOM_EAGAIN = -EAGAIN,
90 VPPCOM_EFAULT = -EFAULT,
91 VPPCOM_ENOMEM = -ENOMEM,
92 VPPCOM_EINVAL = -EINVAL,
93 VPPCOM_EBADFD = -EBADFD,
94 VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
95 VPPCOM_ECONNABORTED = -ECONNABORTED,
96 VPPCOM_ECONNRESET = -ECONNRESET,
97 VPPCOM_ENOTCONN = -ENOTCONN,
98 VPPCOM_ECONNREFUSED = -ECONNREFUSED,
99 VPPCOM_ETIMEDOUT = -ETIMEDOUT,
104 VPPCOM_ATTR_GET_NREAD,
105 VPPCOM_ATTR_GET_NWRITE,
106 VPPCOM_ATTR_GET_FLAGS,
107 VPPCOM_ATTR_SET_FLAGS,
108 VPPCOM_ATTR_GET_LCL_ADDR,
109 VPPCOM_ATTR_GET_PEER_ADDR,
110 VPPCOM_ATTR_GET_LIBC_EPFD,
111 VPPCOM_ATTR_SET_LIBC_EPFD,
112 VPPCOM_ATTR_GET_PROTOCOL,
113 VPPCOM_ATTR_GET_LISTEN,
114 VPPCOM_ATTR_GET_ERROR,
115 VPPCOM_ATTR_GET_TX_FIFO_LEN,
116 VPPCOM_ATTR_SET_TX_FIFO_LEN,
117 VPPCOM_ATTR_GET_RX_FIFO_LEN,
118 VPPCOM_ATTR_SET_RX_FIFO_LEN,
119 VPPCOM_ATTR_GET_REUSEADDR,
120 VPPCOM_ATTR_SET_REUSEADDR,
121 VPPCOM_ATTR_GET_REUSEPORT,
122 VPPCOM_ATTR_SET_REUSEPORT,
123 VPPCOM_ATTR_GET_BROADCAST,
124 VPPCOM_ATTR_SET_BROADCAST,
125 VPPCOM_ATTR_GET_V6ONLY,
126 VPPCOM_ATTR_SET_V6ONLY,
127 VPPCOM_ATTR_GET_KEEPALIVE,
128 VPPCOM_ATTR_SET_KEEPALIVE,
129 VPPCOM_ATTR_GET_TCP_NODELAY,
130 VPPCOM_ATTR_SET_TCP_NODELAY,
131 VPPCOM_ATTR_GET_TCP_KEEPIDLE,
132 VPPCOM_ATTR_SET_TCP_KEEPIDLE,
133 VPPCOM_ATTR_GET_TCP_KEEPINTVL,
134 VPPCOM_ATTR_SET_TCP_KEEPINTVL,
135 VPPCOM_ATTR_GET_TCP_USER_MSS,
136 VPPCOM_ATTR_SET_TCP_USER_MSS,
139 typedef struct _vcl_poll
147 typedef struct vppcom_ioevent_
149 uint32_t session_index;
155 * VPPCOM Public API Functions
157 static inline const char *
158 vppcom_retval_str (int retval)
169 st = "VPPCOM_EAGAIN";
173 st = "VPPCOM_EFAULT";
177 st = "VPPCOM_ENOMEM";
181 st = "VPPCOM_EINVAL";
185 st = "VPPCOM_EBADFD";
188 case VPPCOM_EAFNOSUPPORT:
189 st = "VPPCOM_EAFNOSUPPORT";
192 case VPPCOM_ECONNABORTED:
193 st = "VPPCOM_ECONNABORTED";
196 case VPPCOM_ECONNRESET:
197 st = "VPPCOM_ECONNRESET";
200 case VPPCOM_ENOTCONN:
201 st = "VPPCOM_ENOTCONN";
204 case VPPCOM_ECONNREFUSED:
205 st = "VPPCOM_ECONNREFUSED";
208 case VPPCOM_ETIMEDOUT:
209 st = "VPPCOM_ETIMEDOUT";
213 st = "UNKNOWN_STATE";
221 * User registered callback for when connection arrives on listener created
222 * with vppcom_session_register_listener()
223 * @param uint32_t - newly accepted session_index
224 * @param vppcom_endpt_t* - ip/port information of remote
225 * @param void* - user passed arg to pass back
227 typedef void (*vppcom_session_listener_cb) (uint32_t, vppcom_endpt_t *,
231 * User registered callback for IO events (rx/tx)
232 * @param vppcom_ioevent_t* -
233 * @param void* - user passed arg to pass back
235 typedef void (*vppcom_session_ioevent_cb) (vppcom_ioevent_t *, void *);
238 * @brief vppcom_session_register_listener accepts a bound session_index, and
239 * listens for connections.
241 * On successful connection, calls registered callback (cb) with new
244 * On error, calls registered error callback (errcb).
246 * @param session_index - bound session_index to create listener on
247 * @param cb - on new accepted session callback
248 * @param errcb - on failure callback
249 * @param flags - placeholder for future use. Must be ZERO
250 * @param q_len - max listener connection backlog
251 * @param ptr - user data
254 extern int vppcom_session_register_ioevent_cb (uint32_t session_index,
255 vppcom_session_ioevent_cb cb,
256 uint8_t rx, void *ptr);
259 * User registered ERROR callback for any errors associated with
260 * handling vppcom_session_register_listener() and connections
261 * @param void* - user passed arg to pass back
263 typedef void (*vppcom_session_listener_errcb) (void *);
266 * @brief vppcom_session_register_listener accepts a bound session_index, and
267 * listens for connections.
269 * On successful connection, calls registered callback (cb) with new
272 * On error, calls registered error callback (errcb).
274 * @param session_index - bound session_index to create listener on
275 * @param cb - on new accepted session callback
276 * @param errcb - on failure callback
277 * @param flags - placeholder for future use. Must be ZERO
278 * @param q_len - max listener connection backlog
279 * @param ptr - user data
282 extern int vppcom_session_register_listener (uint32_t session_index,
283 vppcom_session_listener_cb cb,
284 vppcom_session_listener_errcb
285 errcb, uint8_t flags, int q_len,
288 /* TBD: make these constructor/destructor function */
289 extern int vppcom_app_create (char *app_name);
290 extern void vppcom_app_destroy (void);
292 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
293 extern int vppcom_session_close (uint32_t session_index);
295 extern int vppcom_session_bind (uint32_t session_index, vppcom_endpt_t * ep);
296 extern int vppcom_session_listen (uint32_t session_index, uint32_t q_len);
298 extern int vppcom_session_accept (uint32_t session_index,
299 vppcom_endpt_t * client_ep, uint32_t flags);
301 extern int vppcom_session_connect (uint32_t session_index,
302 vppcom_endpt_t * server_ep);
303 extern int vppcom_session_read (uint32_t session_index, void *buf, size_t n);
304 extern int vppcom_session_write (uint32_t session_index, void *buf, size_t n);
306 extern int vppcom_select (unsigned long n_bits,
307 unsigned long *read_map,
308 unsigned long *write_map,
309 unsigned long *except_map, double wait_for_time);
311 extern int vppcom_epoll_create (void);
312 extern int vppcom_epoll_ctl (uint32_t vep_idx, int op,
313 uint32_t session_index,
314 struct epoll_event *event);
315 extern int vppcom_epoll_wait (uint32_t vep_idx, struct epoll_event *events,
316 int maxevents, double wait_for_time);
317 extern int vppcom_session_attr (uint32_t session_index, uint32_t op,
318 void *buffer, uint32_t * buflen);
319 extern int vppcom_session_recvfrom (uint32_t session_index, void *buffer,
320 uint32_t buflen, int flags,
321 vppcom_endpt_t * ep);
322 extern int vppcom_session_sendto (uint32_t session_index, void *buffer,
323 uint32_t buflen, int flags,
324 vppcom_endpt_t * ep);
325 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
326 double wait_for_time);
334 #endif /* included_vppcom_h */
337 * fd.io coding-style-patch-verification: ON
340 * eval: (c-set-style "gnu")