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
148 * VPPCOM Public API Functions
150 static inline const char *
151 vppcom_retval_str (int retval)
162 st = "VPPCOM_EAGAIN";
166 st = "VPPCOM_EFAULT";
170 st = "VPPCOM_ENOMEM";
174 st = "VPPCOM_EINVAL";
178 st = "VPPCOM_EBADFD";
181 case VPPCOM_EAFNOSUPPORT:
182 st = "VPPCOM_EAFNOSUPPORT";
185 case VPPCOM_ECONNABORTED:
186 st = "VPPCOM_ECONNABORTED";
189 case VPPCOM_ECONNRESET:
190 st = "VPPCOM_ECONNRESET";
193 case VPPCOM_ENOTCONN:
194 st = "VPPCOM_ENOTCONN";
197 case VPPCOM_ECONNREFUSED:
198 st = "VPPCOM_ECONNREFUSED";
201 case VPPCOM_ETIMEDOUT:
202 st = "VPPCOM_ETIMEDOUT";
206 st = "UNKNOWN_STATE";
213 /* TBD: make these constructor/destructor function */
214 extern int vppcom_app_create (char *app_name);
215 extern void vppcom_app_destroy (void);
217 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
218 extern int vppcom_session_close (uint32_t session_index);
220 extern int vppcom_session_bind (uint32_t session_index, vppcom_endpt_t * ep);
221 extern int vppcom_session_listen (uint32_t session_index, uint32_t q_len);
223 extern int vppcom_session_accept (uint32_t session_index,
224 vppcom_endpt_t * client_ep, uint32_t flags);
226 extern int vppcom_session_connect (uint32_t session_index,
227 vppcom_endpt_t * server_ep);
228 extern int vppcom_session_read (uint32_t session_index, void *buf, size_t n);
229 extern int vppcom_session_write (uint32_t session_index, void *buf, size_t n);
231 extern int vppcom_select (unsigned long n_bits,
232 unsigned long *read_map,
233 unsigned long *write_map,
234 unsigned long *except_map, double wait_for_time);
236 extern int vppcom_epoll_create (void);
237 extern int vppcom_epoll_ctl (uint32_t vep_idx, int op,
238 uint32_t session_index,
239 struct epoll_event *event);
240 extern int vppcom_epoll_wait (uint32_t vep_idx, struct epoll_event *events,
241 int maxevents, double wait_for_time);
242 extern int vppcom_session_attr (uint32_t session_index, uint32_t op,
243 void *buffer, uint32_t * buflen);
244 extern int vppcom_session_recvfrom (uint32_t session_index, void *buffer,
245 uint32_t buflen, int flags,
246 vppcom_endpt_t * ep);
247 extern int vppcom_session_sendto (uint32_t session_index, void *buffer,
248 uint32_t buflen, int flags,
249 vppcom_endpt_t * ep);
250 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
251 double wait_for_time);
254 * VPPCOM Event Functions
256 extern void vce_poll_wait_connect_request_handler_fn (void *arg);
264 #endif /* included_vppcom_h */
267 * fd.io coding-style-patch-verification: ON
270 * eval: (c-set-style "gnu")