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
21 #include <sys/fcntl.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_VPP_API_SOCKET "VCL_VPP_API_SOCKET"
46 #define VPPCOM_ENV_VPP_SAPI_SOCKET "VCL_VPP_SAPI_SOCKET"
63 typedef struct vppcom_endpt_t_
69 uint64_t parent_handle;
72 typedef uint32_t vcl_session_handle_t;
74 typedef struct vppcom_cert_key_pair_
80 } vppcom_cert_key_pair_t;
85 VPPCOM_EAGAIN = -EAGAIN,
86 VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
87 VPPCOM_EINPROGRESS = -EINPROGRESS,
88 VPPCOM_EFAULT = -EFAULT,
89 VPPCOM_ENOMEM = -ENOMEM,
90 VPPCOM_EINVAL = -EINVAL,
91 VPPCOM_EBADFD = -EBADFD,
92 VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
93 VPPCOM_ECONNABORTED = -ECONNABORTED,
94 VPPCOM_ECONNRESET = -ECONNRESET,
95 VPPCOM_ENOTCONN = -ENOTCONN,
96 VPPCOM_ECONNREFUSED = -ECONNREFUSED,
97 VPPCOM_ETIMEDOUT = -ETIMEDOUT,
98 VPPCOM_EEXIST = -EEXIST
103 VPPCOM_ATTR_GET_NREAD,
104 VPPCOM_ATTR_GET_NWRITE,
105 VPPCOM_ATTR_GET_FLAGS,
106 VPPCOM_ATTR_SET_FLAGS,
107 VPPCOM_ATTR_GET_LCL_ADDR,
108 VPPCOM_ATTR_SET_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,
137 VPPCOM_ATTR_SET_SHUT,
138 VPPCOM_ATTR_GET_SHUT,
139 VPPCOM_ATTR_SET_CONNECTED,
140 VPPCOM_ATTR_SET_CKPAIR,
143 typedef struct _vcl_poll
146 vcl_session_handle_t sh;
151 typedef struct vppcom_data_segment_
155 } vppcom_data_segment_t;
157 typedef vppcom_data_segment_t vppcom_data_segments_t[2];
159 typedef unsigned long vcl_si_set;
162 * VPPCOM Public API Functions
165 extern int vppcom_app_create (const char *app_name);
166 extern void vppcom_app_destroy (void);
168 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
169 extern int vppcom_session_close (uint32_t session_handle);
170 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
171 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
173 extern int vppcom_session_accept (uint32_t session_handle,
174 vppcom_endpt_t * client_ep, uint32_t flags);
176 extern int vppcom_session_connect (uint32_t session_handle,
177 vppcom_endpt_t * server_ep);
178 extern int vppcom_session_stream_connect (uint32_t session_handle,
179 uint32_t parent_session_handle);
180 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
181 extern int vppcom_session_write (uint32_t session_handle, void *buf,
183 extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
186 extern int vppcom_select (int n_bits, vcl_si_set * read_map,
187 vcl_si_set * write_map, vcl_si_set * except_map,
188 double wait_for_time);
190 extern int vppcom_epoll_create (void);
191 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
192 uint32_t session_handle,
193 struct epoll_event *event);
194 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
195 int maxevents, double wait_for_time);
196 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
197 void *buffer, uint32_t * buflen);
198 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
199 uint32_t buflen, int flags,
200 vppcom_endpt_t * ep);
201 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
202 uint32_t buflen, int flags,
203 vppcom_endpt_t * ep);
204 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
205 double wait_for_time);
206 extern int vppcom_mq_epoll_fd (void);
207 extern int vppcom_session_index (vcl_session_handle_t session_handle);
208 extern int vppcom_session_worker (vcl_session_handle_t session_handle);
210 extern int vppcom_session_read_segments (uint32_t session_handle,
211 vppcom_data_segment_t * ds,
214 extern void vppcom_session_free_segments (uint32_t session_handle,
216 extern int vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
217 extern int vppcom_del_cert_key_pair (uint32_t ckpair_index);
218 extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str);
219 extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
220 extern int vppcom_session_listener (uint32_t session_handle);
221 extern int vppcom_session_n_accepted (uint32_t session_handle);
223 extern const char *vppcom_proto_str (vppcom_proto_t proto);
224 extern const char *vppcom_retval_str (int retval);
227 * Request from application to register a new worker
229 * Expectation is that applications will make use of this after a new pthread
232 extern int vppcom_worker_register (void);
235 * Unregister current worker
237 extern void vppcom_worker_unregister (void);
240 * Retrieve current worker index
242 extern int vppcom_worker_index (void);
245 * Set current worker index
247 extern void vppcom_worker_index_set (int);
250 * Returns the current worker's message queues epoll fd
252 * This only works if vcl is configured to do eventfd based message queue
255 extern int vppcom_worker_mqs_epfd (void);
263 #endif /* included_vppcom_h */
266 * fd.io coding-style-patch-verification: ON
269 * eval: (c-set-style "gnu")