1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
|
/*
* Copyright (c) 2017-2019 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef included_vppcom_h
#define included_vppcom_h
#include <netdb.h>
#include <errno.h>
#include <sys/poll.h>
#include <sys/epoll.h>
/* *INDENT-OFF* */
#ifdef __cplusplus
extern "C"
{
#endif
/* *INDENT-ON* */
/*
* VPPCOM Public API Definitions, Enums, and Data Structures
*/
#define INVALID_SESSION_ID ((u32)~0)
#define VPPCOM_CONF_DEFAULT "/etc/vpp/vcl.conf"
#define VPPCOM_ENV_CONF "VCL_CONFIG"
#define VPPCOM_ENV_DEBUG "VCL_DEBUG"
#define VPPCOM_ENV_API_PREFIX "VCL_API_PREFIX"
#define VPPCOM_ENV_APP_PROXY_TRANSPORT_TCP "VCL_APP_PROXY_TRANSPORT_TCP"
#define VPPCOM_ENV_APP_PROXY_TRANSPORT_UDP "VCL_APP_PROXY_TRANSPORT_UDP"
#define VPPCOM_ENV_APP_NAMESPACE_ID "VCL_APP_NAMESPACE_ID"
#define VPPCOM_ENV_APP_NAMESPACE_SECRET "VCL_APP_NAMESPACE_SECRET"
#define VPPCOM_ENV_APP_SCOPE_LOCAL "VCL_APP_SCOPE_LOCAL"
#define VPPCOM_ENV_APP_SCOPE_GLOBAL "VCL_APP_SCOPE_GLOBAL"
#define VPPCOM_ENV_VPP_API_SOCKET "VCL_VPP_API_SOCKET"
typedef enum
{
VPPCOM_PROTO_TCP = 0,
VPPCOM_PROTO_UDP,
VPPCOM_PROTO_SCTP,
VPPCOM_PROTO_NONE,
VPPCOM_PROTO_TLS,
VPPCOM_PROTO_UDPC,
VPPCOM_PROTO_QUIC,
} vppcom_proto_t;
static inline char *
vppcom_proto_str (vppcom_proto_t proto)
{
char *proto_str;
switch (proto)
{
case VPPCOM_PROTO_TCP:
proto_str = "TCP";
break;
case VPPCOM_PROTO_UDP:
proto_str = "UDP";
break;
case VPPCOM_PROTO_SCTP:
proto_str = "SCTP";
break;
case VPPCOM_PROTO_TLS:
proto_str = "TLS";
break;
case VPPCOM_PROTO_UDPC:
proto_str = "UDPC";
break;
case VPPCOM_PROTO_QUIC:
proto_str = "QUIC";
break;
default:
proto_str = "UNKNOWN";
break;
}
return proto_str;
}
static inline int
vcl_proto_is_dgram (uint8_t proto)
{
return proto == VPPCOM_PROTO_UDP || proto == VPPCOM_PROTO_UDPC;
}
typedef enum
{
VPPCOM_IS_IP6 = 0,
VPPCOM_IS_IP4,
} vppcom_is_ip4_t;
typedef struct vppcom_endpt_t_
{
uint8_t is_cut_thru;
uint8_t is_ip4;
uint8_t *ip;
uint16_t port;
uint64_t transport_opts;
} vppcom_endpt_t;
typedef uint32_t vcl_session_handle_t;
typedef enum
{
VPPCOM_OK = 0,
VPPCOM_EAGAIN = -EAGAIN,
VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
VPPCOM_EFAULT = -EFAULT,
VPPCOM_ENOMEM = -ENOMEM,
VPPCOM_EINVAL = -EINVAL,
VPPCOM_EBADFD = -EBADFD,
VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
VPPCOM_ECONNABORTED = -ECONNABORTED,
VPPCOM_ECONNRESET = -ECONNRESET,
VPPCOM_ENOTCONN = -ENOTCONN,
VPPCOM_ECONNREFUSED = -ECONNREFUSED,
VPPCOM_ETIMEDOUT = -ETIMEDOUT,
VPPCOM_EEXIST = -EEXIST
} vppcom_error_t;
typedef enum
{
VPPCOM_ATTR_GET_NREAD,
VPPCOM_ATTR_GET_NWRITE,
VPPCOM_ATTR_GET_FLAGS,
VPPCOM_ATTR_SET_FLAGS,
VPPCOM_ATTR_GET_LCL_ADDR,
VPPCOM_ATTR_GET_PEER_ADDR,
VPPCOM_ATTR_GET_LIBC_EPFD,
VPPCOM_ATTR_SET_LIBC_EPFD,
VPPCOM_ATTR_GET_PROTOCOL,
VPPCOM_ATTR_GET_LISTEN,
VPPCOM_ATTR_GET_ERROR,
VPPCOM_ATTR_GET_TX_FIFO_LEN,
VPPCOM_ATTR_SET_TX_FIFO_LEN,
VPPCOM_ATTR_GET_RX_FIFO_LEN,
VPPCOM_ATTR_SET_RX_FIFO_LEN,
VPPCOM_ATTR_GET_REUSEADDR,
VPPCOM_ATTR_SET_REUSEADDR,
VPPCOM_ATTR_GET_REUSEPORT,
VPPCOM_ATTR_SET_REUSEPORT,
VPPCOM_ATTR_GET_BROADCAST,
VPPCOM_ATTR_SET_BROADCAST,
VPPCOM_ATTR_GET_V6ONLY,
VPPCOM_ATTR_SET_V6ONLY,
VPPCOM_ATTR_GET_KEEPALIVE,
VPPCOM_ATTR_SET_KEEPALIVE,
VPPCOM_ATTR_GET_TCP_NODELAY,
VPPCOM_ATTR_SET_TCP_NODELAY,
VPPCOM_ATTR_GET_TCP_KEEPIDLE,
VPPCOM_ATTR_SET_TCP_KEEPIDLE,
VPPCOM_ATTR_GET_TCP_KEEPINTVL,
VPPCOM_ATTR_SET_TCP_KEEPINTVL,
VPPCOM_ATTR_GET_TCP_USER_MSS,
VPPCOM_ATTR_SET_TCP_USER_MSS,
VPPCOM_ATTR_SET_SHUT,
VPPCOM_ATTR_GET_SHUT,
} vppcom_attr_op_t;
typedef struct _vcl_poll
{
uint32_t fds_ndx;
vcl_session_handle_t sh;
short events;
short revents;
} vcl_poll_t;
typedef struct vppcom_data_segment_
{
unsigned char *data;
uint32_t len;
} vppcom_data_segment_t;
typedef vppcom_data_segment_t vppcom_data_segments_t[2];
typedef unsigned long vcl_si_set;
/*
* VPPCOM Public API Functions
*/
static inline const char *
vppcom_retval_str (int retval)
{
char *st;
switch (retval)
{
case VPPCOM_OK:
st = "VPPCOM_OK";
break;
case VPPCOM_EAGAIN:
st = "VPPCOM_EAGAIN";
break;
case VPPCOM_EFAULT:
st = "VPPCOM_EFAULT";
break;
case VPPCOM_ENOMEM:
st = "VPPCOM_ENOMEM";
break;
case VPPCOM_EINVAL:
st = "VPPCOM_EINVAL";
break;
case VPPCOM_EBADFD:
st = "VPPCOM_EBADFD";
break;
case VPPCOM_EAFNOSUPPORT:
st = "VPPCOM_EAFNOSUPPORT";
break;
case VPPCOM_ECONNABORTED:
st = "VPPCOM_ECONNABORTED";
break;
case VPPCOM_ECONNRESET:
st = "VPPCOM_ECONNRESET";
break;
case VPPCOM_ENOTCONN:
st = "VPPCOM_ENOTCONN";
break;
case VPPCOM_ECONNREFUSED:
st = "VPPCOM_ECONNREFUSED";
break;
case VPPCOM_ETIMEDOUT:
st = "VPPCOM_ETIMEDOUT";
break;
default:
st = "UNKNOWN_STATE";
break;
}
return st;
}
/* TBD: make these constructor/destructor function */
extern int vppcom_app_create (char *app_name);
extern void vppcom_app_destroy (void);
extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
extern int vppcom_session_close (uint32_t session_handle);
extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
extern int vppcom_session_accept (uint32_t session_handle,
vppcom_endpt_t * client_ep, uint32_t flags);
extern int vppcom_session_connect (uint32_t session_handle,
vppcom_endpt_t * server_ep);
extern int vppcom_session_stream_connect (uint32_t session_handle,
uint32_t parent_session_handle);
extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
extern int vppcom_session_write (uint32_t session_handle, void *buf,
size_t n);
extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
size_t n);
extern int vppcom_select (int n_bits, vcl_si_set * read_map,
vcl_si_set * write_map, vcl_si_set * except_map,
double wait_for_time);
extern int vppcom_epoll_create (void);
extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
uint32_t session_handle,
struct epoll_event *event);
extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
int maxevents, double wait_for_time);
extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
void *buffer, uint32_t * buflen);
extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
uint32_t buflen, int flags,
vppcom_endpt_t * ep);
extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
uint32_t buflen, int flags,
vppcom_endpt_t * ep);
extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
double wait_for_time);
extern int vppcom_mq_epoll_fd (void);
extern int vppcom_session_index (vcl_session_handle_t session_handle);
extern int vppcom_session_worker (vcl_session_handle_t session_handle);
extern int vppcom_session_read_segments (uint32_t session_handle,
vppcom_data_segments_t ds);
extern void vppcom_session_free_segments (uint32_t session_handle,
vppcom_data_segments_t ds);
extern int vppcom_session_tls_add_cert (uint32_t session_handle, char *cert,
uint32_t cert_len);
extern int vppcom_session_tls_add_key (uint32_t session_handle, char *key,
uint32_t key_len);
extern int vppcom_data_segment_copy (void *buf, vppcom_data_segments_t ds,
uint32_t max_bytes);
extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str);
extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
extern int vppcom_session_listener (uint32_t session_handle);
extern int vppcom_session_n_accepted (uint32_t session_handle);
/**
* Request from application to register a new worker
*
* Expectation is that applications will make use of this after a new pthread
* is spawned.
*/
extern int vppcom_worker_register (void);
/**
* Unregister current worker
*/
extern void vppcom_worker_unregister (void);
/**
* Retrieve current worker index
*/
extern int vppcom_worker_index (void);
/**
* Returns the current worker's message queues epoll fd
*
* This only works if vcl is configured to do eventfd based message queue
* notifications.
*/
extern int vppcom_worker_mqs_epfd (void);
/* *INDENT-OFF* */
#ifdef __cplusplus
}
#endif
/* *INDENT-ON* */
#endif /* included_vppcom_h */
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
|
