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,
142 typedef struct _vcl_poll
150 typedef struct vppcom_data_segment_
154 } vppcom_data_segment_t;
156 typedef vppcom_data_segment_t vppcom_data_segments_t[2];
159 * VPPCOM Public API Functions
161 static inline const char *
162 vppcom_retval_str (int retval)
173 st = "VPPCOM_EAGAIN";
177 st = "VPPCOM_EFAULT";
181 st = "VPPCOM_ENOMEM";
185 st = "VPPCOM_EINVAL";
189 st = "VPPCOM_EBADFD";
192 case VPPCOM_EAFNOSUPPORT:
193 st = "VPPCOM_EAFNOSUPPORT";
196 case VPPCOM_ECONNABORTED:
197 st = "VPPCOM_ECONNABORTED";
200 case VPPCOM_ECONNRESET:
201 st = "VPPCOM_ECONNRESET";
204 case VPPCOM_ENOTCONN:
205 st = "VPPCOM_ENOTCONN";
208 case VPPCOM_ECONNREFUSED:
209 st = "VPPCOM_ECONNREFUSED";
212 case VPPCOM_ETIMEDOUT:
213 st = "VPPCOM_ETIMEDOUT";
217 st = "UNKNOWN_STATE";
224 /* TBD: make these constructor/destructor function */
225 extern int vppcom_app_create (char *app_name);
226 extern void vppcom_app_destroy (void);
228 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
229 extern int vppcom_session_close (uint32_t session_handle);
230 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
231 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
233 extern int vppcom_session_accept (uint32_t session_handle,
234 vppcom_endpt_t * client_ep, uint32_t flags);
236 extern int vppcom_session_connect (uint32_t session_handle,
237 vppcom_endpt_t * server_ep);
238 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
239 extern int vppcom_session_write (uint32_t session_handle, void *buf,
242 extern int vppcom_select (unsigned long n_bits,
243 unsigned long *read_map,
244 unsigned long *write_map,
245 unsigned long *except_map, double wait_for_time);
247 extern int vppcom_epoll_create (void);
248 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
249 uint32_t session_handle,
250 struct epoll_event *event);
251 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
252 int maxevents, double wait_for_time);
253 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
254 void *buffer, uint32_t * buflen);
255 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
256 uint32_t buflen, int flags,
257 vppcom_endpt_t * ep);
258 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
259 uint32_t buflen, int flags,
260 vppcom_endpt_t * ep);
261 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
262 double wait_for_time);
263 extern int vppcom_mq_epoll_fd (void);
264 extern int vppcom_session_index (uint32_t session_handle);
266 extern int vppcom_session_read_segments (uint32_t session_handle,
267 vppcom_data_segments_t ds);
268 extern void vppcom_session_free_segments (uint32_t session_handle,
269 vppcom_data_segments_t ds);
270 extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
274 * Request from application to register a new worker
276 * Expectation is that applications will make use of this after a new pthread
279 extern int vppcom_worker_register (void);
282 * VPPCOM Event Functions
284 extern void vce_poll_wait_connect_request_handler_fn (void *arg);
292 #endif /* included_vppcom_h */
295 * fd.io coding-style-patch-verification: ON
298 * eval: (c-set-style "gnu")