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_API_PREFIX "VCL_API_PREFIX"
40 #define VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP "VCL_APP_PROXY_TRANSPORT_TCP"
41 #define VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP "VCL_APP_PROXY_TRANSPORT_UDP"
42 #define VPPCOM_ENV_APP_NAMESPACE_ID "VCL_APP_NAMESPACE_ID"
43 #define VPPCOM_ENV_APP_NAMESPACE_SECRET "VCL_APP_NAMESPACE_SECRET"
44 #define VPPCOM_ENV_APP_SCOPE_LOCAL "VCL_APP_SCOPE_LOCAL"
45 #define VPPCOM_ENV_APP_SCOPE_GLOBAL "VCL_APP_SCOPE_GLOBAL"
46 #define VPPCOM_ENV_VPP_API_SOCKET "VCL_VPP_API_SOCKET"
63 typedef struct vppcom_endpt_t_
69 uint64_t parent_handle;
72 typedef uint32_t vcl_session_handle_t;
77 VPPCOM_EAGAIN = -EAGAIN,
78 VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
79 VPPCOM_EINPROGRESS = -EINPROGRESS,
80 VPPCOM_EFAULT = -EFAULT,
81 VPPCOM_ENOMEM = -ENOMEM,
82 VPPCOM_EINVAL = -EINVAL,
83 VPPCOM_EBADFD = -EBADFD,
84 VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
85 VPPCOM_ECONNABORTED = -ECONNABORTED,
86 VPPCOM_ECONNRESET = -ECONNRESET,
87 VPPCOM_ENOTCONN = -ENOTCONN,
88 VPPCOM_ECONNREFUSED = -ECONNREFUSED,
89 VPPCOM_ETIMEDOUT = -ETIMEDOUT,
90 VPPCOM_EEXIST = -EEXIST
95 VPPCOM_ATTR_GET_NREAD,
96 VPPCOM_ATTR_GET_NWRITE,
97 VPPCOM_ATTR_GET_FLAGS,
98 VPPCOM_ATTR_SET_FLAGS,
99 VPPCOM_ATTR_GET_LCL_ADDR,
100 VPPCOM_ATTR_SET_LCL_ADDR,
101 VPPCOM_ATTR_GET_PEER_ADDR,
102 VPPCOM_ATTR_GET_LIBC_EPFD,
103 VPPCOM_ATTR_SET_LIBC_EPFD,
104 VPPCOM_ATTR_GET_PROTOCOL,
105 VPPCOM_ATTR_GET_LISTEN,
106 VPPCOM_ATTR_GET_ERROR,
107 VPPCOM_ATTR_GET_TX_FIFO_LEN,
108 VPPCOM_ATTR_SET_TX_FIFO_LEN,
109 VPPCOM_ATTR_GET_RX_FIFO_LEN,
110 VPPCOM_ATTR_SET_RX_FIFO_LEN,
111 VPPCOM_ATTR_GET_REUSEADDR,
112 VPPCOM_ATTR_SET_REUSEADDR,
113 VPPCOM_ATTR_GET_REUSEPORT,
114 VPPCOM_ATTR_SET_REUSEPORT,
115 VPPCOM_ATTR_GET_BROADCAST,
116 VPPCOM_ATTR_SET_BROADCAST,
117 VPPCOM_ATTR_GET_V6ONLY,
118 VPPCOM_ATTR_SET_V6ONLY,
119 VPPCOM_ATTR_GET_KEEPALIVE,
120 VPPCOM_ATTR_SET_KEEPALIVE,
121 VPPCOM_ATTR_GET_TCP_NODELAY,
122 VPPCOM_ATTR_SET_TCP_NODELAY,
123 VPPCOM_ATTR_GET_TCP_KEEPIDLE,
124 VPPCOM_ATTR_SET_TCP_KEEPIDLE,
125 VPPCOM_ATTR_GET_TCP_KEEPINTVL,
126 VPPCOM_ATTR_SET_TCP_KEEPINTVL,
127 VPPCOM_ATTR_GET_TCP_USER_MSS,
128 VPPCOM_ATTR_SET_TCP_USER_MSS,
129 VPPCOM_ATTR_SET_SHUT,
130 VPPCOM_ATTR_GET_SHUT,
131 VPPCOM_ATTR_SET_CONNECTED,
134 typedef struct _vcl_poll
137 vcl_session_handle_t sh;
142 typedef struct vppcom_data_segment_
146 } vppcom_data_segment_t;
148 typedef vppcom_data_segment_t vppcom_data_segments_t[2];
150 typedef unsigned long vcl_si_set;
153 * VPPCOM Public API Functions
156 extern int vppcom_app_create (const char *app_name);
157 extern void vppcom_app_destroy (void);
159 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
160 extern int vppcom_session_close (uint32_t session_handle);
161 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
162 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
164 extern int vppcom_session_accept (uint32_t session_handle,
165 vppcom_endpt_t * client_ep, uint32_t flags);
167 extern int vppcom_session_connect (uint32_t session_handle,
168 vppcom_endpt_t * server_ep);
169 extern int vppcom_session_stream_connect (uint32_t session_handle,
170 uint32_t parent_session_handle);
171 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
172 extern int vppcom_session_write (uint32_t session_handle, void *buf,
174 extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
177 extern int vppcom_select (int n_bits, vcl_si_set * read_map,
178 vcl_si_set * write_map, vcl_si_set * except_map,
179 double wait_for_time);
181 extern int vppcom_epoll_create (void);
182 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
183 uint32_t session_handle,
184 struct epoll_event *event);
185 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
186 int maxevents, double wait_for_time);
187 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
188 void *buffer, uint32_t * buflen);
189 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
190 uint32_t buflen, int flags,
191 vppcom_endpt_t * ep);
192 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
193 uint32_t buflen, int flags,
194 vppcom_endpt_t * ep);
195 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
196 double wait_for_time);
197 extern int vppcom_mq_epoll_fd (void);
198 extern int vppcom_session_index (vcl_session_handle_t session_handle);
199 extern int vppcom_session_worker (vcl_session_handle_t session_handle);
201 extern int vppcom_session_read_segments (uint32_t session_handle,
202 vppcom_data_segments_t ds);
203 extern void vppcom_session_free_segments (uint32_t session_handle,
204 vppcom_data_segments_t ds);
205 extern int vppcom_session_tls_add_cert (uint32_t session_handle, char *cert,
207 extern int vppcom_session_tls_add_key (uint32_t session_handle, char *key,
209 extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
211 extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str);
212 extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
213 extern int vppcom_session_listener (uint32_t session_handle);
214 extern int vppcom_session_n_accepted (uint32_t session_handle);
216 extern const char *vppcom_proto_str (vppcom_proto_t proto);
217 extern const char *vppcom_retval_str (int retval);
220 * Request from application to register a new worker
222 * Expectation is that applications will make use of this after a new pthread
225 extern int vppcom_worker_register (void);
228 * Unregister current worker
230 extern void vppcom_worker_unregister (void);
233 * Retrieve current worker index
235 extern int vppcom_worker_index (void);
238 * Set current worker index
240 extern void vppcom_worker_index_set (int);
243 * Returns the current worker's message queues epoll fd
245 * This only works if vcl is configured to do eventfd based message queue
248 extern int vppcom_worker_mqs_epfd (void);
256 #endif /* included_vppcom_h */
259 * fd.io coding-style-patch-verification: ON
262 * eval: (c-set-style "gnu")