2 * Copyright (c) 2017-2020 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
23 #include <sys/epoll.h>
33 * VPPCOM Public API Definitions, Enums, and Data Structures
35 #define INVALID_SESSION_ID ((u32)~0)
36 #define VPPCOM_CONF_DEFAULT "/etc/vpp/vcl.conf"
37 #define VPPCOM_ENV_CONF "VCL_CONFIG"
38 #define VPPCOM_ENV_DEBUG "VCL_DEBUG"
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_APP_USE_MQ_EVENTFD "VCL_APP_USE_MQ_EVENTFD"
46 #define VPPCOM_ENV_VPP_API_SOCKET "VCL_VPP_API_SOCKET"
47 #define VPPCOM_ENV_VPP_SAPI_SOCKET "VCL_VPP_SAPI_SOCKET"
66 #define VCL_UDP_OPTS_BASE (VPPCOM_PROTO_UDP << 16)
67 #define VCL_UDP_SEGMENT (VCL_UDP_OPTS_BASE + 0)
69 typedef struct vppcom_endpt_tlv_t_
83 typedef struct vppcom_endpt_t_
89 uint64_t parent_handle;
90 vppcom_endpt_tlv_t app_data;
93 typedef uint32_t vcl_session_handle_t;
95 typedef struct vppcom_cert_key_pair_
101 } vppcom_cert_key_pair_t;
106 VPPCOM_EAGAIN = -EAGAIN,
107 VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
108 VPPCOM_EINPROGRESS = -EINPROGRESS,
109 VPPCOM_EFAULT = -EFAULT,
110 VPPCOM_ENOMEM = -ENOMEM,
111 VPPCOM_EINVAL = -EINVAL,
112 VPPCOM_EBADFD = -EBADFD,
113 VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
114 VPPCOM_ECONNABORTED = -ECONNABORTED,
115 VPPCOM_ECONNRESET = -ECONNRESET,
116 VPPCOM_ENOTCONN = -ENOTCONN,
117 VPPCOM_ECONNREFUSED = -ECONNREFUSED,
118 VPPCOM_ETIMEDOUT = -ETIMEDOUT,
119 VPPCOM_EEXIST = -EEXIST,
120 VPPCOM_ENOPROTOOPT = -ENOPROTOOPT,
121 VPPCOM_EPIPE = -EPIPE,
122 VPPCOM_ENOENT = -ENOENT,
123 VPPCOM_EADDRINUSE = -EADDRINUSE,
124 VPPCOM_ENOTSUP = -ENOTSUP
129 VPPCOM_ATTR_GET_NREAD,
130 VPPCOM_ATTR_GET_NWRITE,
131 VPPCOM_ATTR_GET_FLAGS,
132 VPPCOM_ATTR_SET_FLAGS,
133 VPPCOM_ATTR_GET_LCL_ADDR,
134 VPPCOM_ATTR_SET_LCL_ADDR,
135 VPPCOM_ATTR_GET_PEER_ADDR,
136 VPPCOM_ATTR_GET_LIBC_EPFD,
137 VPPCOM_ATTR_SET_LIBC_EPFD,
138 VPPCOM_ATTR_GET_PROTOCOL,
139 VPPCOM_ATTR_GET_LISTEN,
140 VPPCOM_ATTR_GET_ERROR,
141 VPPCOM_ATTR_GET_TX_FIFO_LEN,
142 VPPCOM_ATTR_SET_TX_FIFO_LEN,
143 VPPCOM_ATTR_GET_RX_FIFO_LEN,
144 VPPCOM_ATTR_SET_RX_FIFO_LEN,
145 VPPCOM_ATTR_GET_REUSEADDR,
146 VPPCOM_ATTR_SET_REUSEADDR,
147 VPPCOM_ATTR_GET_REUSEPORT,
148 VPPCOM_ATTR_SET_REUSEPORT,
149 VPPCOM_ATTR_GET_BROADCAST,
150 VPPCOM_ATTR_SET_BROADCAST,
151 VPPCOM_ATTR_GET_V6ONLY,
152 VPPCOM_ATTR_SET_V6ONLY,
153 VPPCOM_ATTR_GET_KEEPALIVE,
154 VPPCOM_ATTR_SET_KEEPALIVE,
155 VPPCOM_ATTR_GET_TCP_NODELAY,
156 VPPCOM_ATTR_SET_TCP_NODELAY,
157 VPPCOM_ATTR_GET_TCP_KEEPIDLE,
158 VPPCOM_ATTR_SET_TCP_KEEPIDLE,
159 VPPCOM_ATTR_GET_TCP_KEEPINTVL,
160 VPPCOM_ATTR_SET_TCP_KEEPINTVL,
161 VPPCOM_ATTR_GET_TCP_USER_MSS,
162 VPPCOM_ATTR_SET_TCP_USER_MSS,
163 VPPCOM_ATTR_SET_CONNECTED,
164 VPPCOM_ATTR_SET_CKPAIR,
167 VPPCOM_ATTR_GET_DOMAIN,
168 VPPCOM_ATTR_SET_ENDPT_EXT_CFG,
169 VPPCOM_ATTR_SET_DSCP,
172 typedef struct _vcl_poll
175 vcl_session_handle_t sh;
180 typedef struct vppcom_data_segment_
184 } vppcom_data_segment_t;
186 typedef vppcom_data_segment_t vppcom_data_segments_t[2];
188 typedef unsigned long vcl_si_set;
191 * VPPCOM Public API Functions
194 extern int vppcom_app_create (const char *app_name);
195 extern void vppcom_app_destroy (void);
197 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
198 extern int vppcom_session_shutdown (uint32_t session_handle, int how);
199 extern int vppcom_session_close (uint32_t session_handle);
200 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
201 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
203 extern int vppcom_session_accept (uint32_t session_handle,
204 vppcom_endpt_t * client_ep, uint32_t flags);
206 extern int vppcom_session_connect (uint32_t session_handle,
207 vppcom_endpt_t * server_ep);
208 extern int vppcom_session_stream_connect (uint32_t session_handle,
209 uint32_t parent_session_handle);
210 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
211 extern int vppcom_session_write (uint32_t session_handle, void *buf,
213 extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
216 extern int vppcom_select (int n_bits, vcl_si_set * read_map,
217 vcl_si_set * write_map, vcl_si_set * except_map,
218 double wait_for_time);
220 extern int vppcom_epoll_create (void);
221 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
222 uint32_t session_handle,
223 struct epoll_event *event);
224 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
225 int maxevents, double wait_for_time);
226 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
227 void *buffer, uint32_t * buflen);
228 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
229 uint32_t buflen, int flags,
230 vppcom_endpt_t * ep);
231 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
232 uint32_t buflen, int flags,
233 vppcom_endpt_t * ep);
234 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
235 double wait_for_time);
236 extern int vppcom_mq_epoll_fd (void);
237 extern int vppcom_session_index (vcl_session_handle_t session_handle);
238 extern int vppcom_session_worker (vcl_session_handle_t session_handle);
240 extern int vppcom_session_read_segments (uint32_t session_handle,
241 vppcom_data_segment_t * ds,
244 extern void vppcom_session_free_segments (uint32_t session_handle,
246 extern int vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
247 extern int vppcom_del_cert_key_pair (uint32_t ckpair_index);
248 extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str);
249 extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
250 extern int vppcom_session_listener (uint32_t session_handle);
251 extern int vppcom_session_n_accepted (uint32_t session_handle);
253 extern const char *vppcom_proto_str (vppcom_proto_t proto);
254 extern const char *vppcom_retval_str (int retval);
257 * Request from application to register a new worker
259 * Expectation is that applications will make use of this after a new pthread
262 extern int vppcom_worker_register (void);
265 * Unregister current worker
267 extern void vppcom_worker_unregister (void);
270 * Retrieve current worker index
272 extern int vppcom_worker_index (void);
275 * Set current worker index
277 extern void vppcom_worker_index_set (int);
280 * Returns the current worker's message queues epoll fd
282 * This only works if vcl is configured to do eventfd based message queue
285 extern int vppcom_worker_mqs_epfd (void);
288 * Returns Session error
290 * Application can use this API to find the detailed session error
292 extern int vppcom_session_get_error (uint32_t session_handle);
295 * Returns true if current worker is disconnected from vpp
297 * Application can use this API to check if VPP is disconnected
298 * as long as `use-mq-eventfd` is being set
300 extern int vppcom_worker_is_detached (void);
308 #endif /* included_vppcom_h */
311 * fd.io coding-style-patch-verification: ON
314 * eval: (c-set-style "gnu")