blob: 19a01c798b5988e067a449233d244a5bee09c6fc [file] [log] [blame]
Dave Wallace543852a2017-08-03 02:11:34 -04001/*
Florin Coras66ec4672020-06-15 07:59:40 -07002 * Copyright (c) 2017-2020 Cisco and/or its affiliates.
Dave Wallace543852a2017-08-03 02:11:34 -04003 * 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:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
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.
14 */
15
16#ifndef included_vppcom_h
17#define included_vppcom_h
18
19#include <netdb.h>
20#include <errno.h>
Florin Coras57c88932019-08-29 12:03:17 -070021#include <sys/fcntl.h>
Dave Wallace048b1d62018-01-03 22:24:41 -050022#include <sys/poll.h>
Dave Wallacef7f809c2017-10-03 01:48:42 -040023#include <sys/epoll.h>
Dave Wallace543852a2017-08-03 02:11:34 -040024
Keith Burns (alagalah)5a2946c2018-02-02 08:21:56 -080025/* *INDENT-OFF* */
26#ifdef __cplusplus
27extern "C"
28{
29#endif
30/* *INDENT-ON* */
31
Dave Wallace543852a2017-08-03 02:11:34 -040032/*
33 * VPPCOM Public API Definitions, Enums, and Data Structures
34 */
Florin Coras7baeb712019-01-04 17:05:43 -080035#define INVALID_SESSION_ID ((u32)~0)
Florin Coras99368312018-08-02 10:45:44 -070036#define VPPCOM_CONF_DEFAULT "/etc/vpp/vcl.conf"
37#define VPPCOM_ENV_CONF "VCL_CONFIG"
38#define VPPCOM_ENV_DEBUG "VCL_DEBUG"
Florin Coras99368312018-08-02 10:45:44 -070039#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"
Florin Coras165f3ae2020-11-08 18:04:33 -080046#define VPPCOM_ENV_VPP_SAPI_SOCKET "VCL_VPP_SAPI_SOCKET"
Dave Wallace543852a2017-08-03 02:11:34 -040047
Florin Coras4b47ee22020-11-19 13:38:26 -080048 typedef enum
49 {
50 VPPCOM_PROTO_TCP = 0,
51 VPPCOM_PROTO_UDP,
52 VPPCOM_PROTO_NONE,
53 VPPCOM_PROTO_TLS,
54 VPPCOM_PROTO_QUIC,
55 VPPCOM_PROTO_DTLS,
Florin Coras6621abf2021-01-06 17:35:17 -080056 VPPCOM_PROTO_SRTP,
Florin Coras4b47ee22020-11-19 13:38:26 -080057 } vppcom_proto_t;
Dave Wallace543852a2017-08-03 02:11:34 -040058
Florin Coras4b47ee22020-11-19 13:38:26 -080059 typedef enum
60 {
61 VPPCOM_IS_IP6 = 0,
62 VPPCOM_IS_IP4,
63 } vppcom_is_ip4_t;
Dave Wallace543852a2017-08-03 02:11:34 -040064
Florin Coras4b47ee22020-11-19 13:38:26 -080065 typedef struct vppcom_endpt_t_
66 {
67 uint8_t is_cut_thru;
68 uint8_t is_ip4;
69 uint8_t *ip;
70 uint16_t port;
71 uint64_t parent_handle;
72 } vppcom_endpt_t;
Dave Wallace543852a2017-08-03 02:11:34 -040073
Florin Coras30e79c22019-01-02 19:31:22 -080074typedef uint32_t vcl_session_handle_t;
75
Florin Corasa5a9efd2021-01-05 17:03:29 -080076typedef struct vppcom_cert_key_pair_
77{
78 char *cert;
79 char *key;
80 uint32_t cert_len;
81 uint32_t key_len;
82} vppcom_cert_key_pair_t;
83
Dave Wallace543852a2017-08-03 02:11:34 -040084typedef enum
85{
86 VPPCOM_OK = 0,
87 VPPCOM_EAGAIN = -EAGAIN,
Florin Coras54693d22018-07-17 10:46:29 -070088 VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
Florin Coras57c88932019-08-29 12:03:17 -070089 VPPCOM_EINPROGRESS = -EINPROGRESS,
Dave Wallace048b1d62018-01-03 22:24:41 -050090 VPPCOM_EFAULT = -EFAULT,
Dave Wallace60caa062017-11-10 17:07:13 -050091 VPPCOM_ENOMEM = -ENOMEM,
Dave Wallace543852a2017-08-03 02:11:34 -040092 VPPCOM_EINVAL = -EINVAL,
93 VPPCOM_EBADFD = -EBADFD,
94 VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
Dave Wallaceee45d412017-11-24 21:44:06 -050095 VPPCOM_ECONNABORTED = -ECONNABORTED,
Dave Wallace543852a2017-08-03 02:11:34 -040096 VPPCOM_ECONNRESET = -ECONNRESET,
Dave Wallace4878cbe2017-11-21 03:45:09 -050097 VPPCOM_ENOTCONN = -ENOTCONN,
Dave Wallace543852a2017-08-03 02:11:34 -040098 VPPCOM_ECONNREFUSED = -ECONNREFUSED,
99 VPPCOM_ETIMEDOUT = -ETIMEDOUT,
Florin Coras04ae8272021-04-12 19:55:37 -0700100 VPPCOM_EEXIST = -EEXIST,
Florin Coras2645f682021-06-04 15:59:41 -0700101 VPPCOM_ENOPROTOOPT = -ENOPROTOOPT,
liuyacan55c952e2021-06-13 14:54:55 +0800102 VPPCOM_EPIPE = -EPIPE,
Florin Coras2645f682021-06-04 15:59:41 -0700103 VPPCOM_ENOENT = -ENOENT,
Dave Wallace543852a2017-08-03 02:11:34 -0400104} vppcom_error_t;
105
Dave Wallace35830af2017-10-09 01:43:42 -0400106typedef enum
107{
108 VPPCOM_ATTR_GET_NREAD,
Dave Wallace227867f2017-11-13 21:21:53 -0500109 VPPCOM_ATTR_GET_NWRITE,
Dave Wallace35830af2017-10-09 01:43:42 -0400110 VPPCOM_ATTR_GET_FLAGS,
111 VPPCOM_ATTR_SET_FLAGS,
112 VPPCOM_ATTR_GET_LCL_ADDR,
Florin Corasef7cbf62019-10-17 09:56:27 -0700113 VPPCOM_ATTR_SET_LCL_ADDR,
Dave Wallace35830af2017-10-09 01:43:42 -0400114 VPPCOM_ATTR_GET_PEER_ADDR,
Dave Wallace048b1d62018-01-03 22:24:41 -0500115 VPPCOM_ATTR_GET_LIBC_EPFD,
116 VPPCOM_ATTR_SET_LIBC_EPFD,
117 VPPCOM_ATTR_GET_PROTOCOL,
118 VPPCOM_ATTR_GET_LISTEN,
119 VPPCOM_ATTR_GET_ERROR,
120 VPPCOM_ATTR_GET_TX_FIFO_LEN,
121 VPPCOM_ATTR_SET_TX_FIFO_LEN,
122 VPPCOM_ATTR_GET_RX_FIFO_LEN,
123 VPPCOM_ATTR_SET_RX_FIFO_LEN,
124 VPPCOM_ATTR_GET_REUSEADDR,
Stevenb5a11602017-10-11 09:59:30 -0700125 VPPCOM_ATTR_SET_REUSEADDR,
Dave Wallace048b1d62018-01-03 22:24:41 -0500126 VPPCOM_ATTR_GET_REUSEPORT,
127 VPPCOM_ATTR_SET_REUSEPORT,
128 VPPCOM_ATTR_GET_BROADCAST,
Stevenb5a11602017-10-11 09:59:30 -0700129 VPPCOM_ATTR_SET_BROADCAST,
Dave Wallace048b1d62018-01-03 22:24:41 -0500130 VPPCOM_ATTR_GET_V6ONLY,
Stevenb5a11602017-10-11 09:59:30 -0700131 VPPCOM_ATTR_SET_V6ONLY,
Dave Wallace048b1d62018-01-03 22:24:41 -0500132 VPPCOM_ATTR_GET_KEEPALIVE,
Stevenbccd3392017-10-12 20:42:21 -0700133 VPPCOM_ATTR_SET_KEEPALIVE,
Dave Wallace048b1d62018-01-03 22:24:41 -0500134 VPPCOM_ATTR_GET_TCP_NODELAY,
135 VPPCOM_ATTR_SET_TCP_NODELAY,
136 VPPCOM_ATTR_GET_TCP_KEEPIDLE,
Stevenbccd3392017-10-12 20:42:21 -0700137 VPPCOM_ATTR_SET_TCP_KEEPIDLE,
Dave Wallace048b1d62018-01-03 22:24:41 -0500138 VPPCOM_ATTR_GET_TCP_KEEPINTVL,
Stevenbccd3392017-10-12 20:42:21 -0700139 VPPCOM_ATTR_SET_TCP_KEEPINTVL,
Dave Wallace048b1d62018-01-03 22:24:41 -0500140 VPPCOM_ATTR_GET_TCP_USER_MSS,
141 VPPCOM_ATTR_SET_TCP_USER_MSS,
Florin Coras1e966172020-05-16 18:18:14 +0000142 VPPCOM_ATTR_SET_CONNECTED,
Florin Corasa5a9efd2021-01-05 17:03:29 -0800143 VPPCOM_ATTR_SET_CKPAIR,
Florin Coras6a6555a2021-01-28 11:39:27 -0800144 VPPCOM_ATTR_SET_VRF,
145 VPPCOM_ATTR_GET_VRF,
wanghanlin0674f852021-02-22 10:38:36 +0800146 VPPCOM_ATTR_GET_DOMAIN,
Florin Coras87f63892021-05-01 16:01:40 -0700147 VPPCOM_ATTR_SET_ENDPT_EXT_CFG,
Dave Wallace35830af2017-10-09 01:43:42 -0400148} vppcom_attr_op_t;
149
Dave Wallace048b1d62018-01-03 22:24:41 -0500150typedef struct _vcl_poll
151{
152 uint32_t fds_ndx;
Florin Coras7baeb712019-01-04 17:05:43 -0800153 vcl_session_handle_t sh;
Dave Wallace048b1d62018-01-03 22:24:41 -0500154 short events;
Florin Coras6917b942018-11-13 22:44:54 -0800155 short revents;
Dave Wallace048b1d62018-01-03 22:24:41 -0500156} vcl_poll_t;
157
Florin Coras2cba8532018-09-11 16:33:36 -0700158typedef struct vppcom_data_segment_
159{
160 unsigned char *data;
161 uint32_t len;
162} vppcom_data_segment_t;
163
164typedef vppcom_data_segment_t vppcom_data_segments_t[2];
165
Florin Coras294afe22019-01-07 17:49:17 -0800166typedef unsigned long vcl_si_set;
167
Dave Wallace543852a2017-08-03 02:11:34 -0400168/*
169 * VPPCOM Public API Functions
170 */
Dave Wallace543852a2017-08-03 02:11:34 -0400171
Florin Coras66ec4672020-06-15 07:59:40 -0700172extern int vppcom_app_create (const char *app_name);
Dave Wallace543852a2017-08-03 02:11:34 -0400173extern void vppcom_app_destroy (void);
174
Dave Wallacec04cbf12018-02-07 18:14:02 -0500175extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
liuyacan55c952e2021-06-13 14:54:55 +0800176extern int vppcom_session_shutdown (uint32_t session_handle, int how);
Florin Coras134a9962018-08-28 11:32:04 -0700177extern int vppcom_session_close (uint32_t session_handle);
178extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
179extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
Dave Wallace543852a2017-08-03 02:11:34 -0400180
Florin Coras134a9962018-08-28 11:32:04 -0700181extern int vppcom_session_accept (uint32_t session_handle,
Dave Wallace048b1d62018-01-03 22:24:41 -0500182 vppcom_endpt_t * client_ep, uint32_t flags);
Dave Wallace543852a2017-08-03 02:11:34 -0400183
Florin Coras134a9962018-08-28 11:32:04 -0700184extern int vppcom_session_connect (uint32_t session_handle,
Dave Wallace543852a2017-08-03 02:11:34 -0400185 vppcom_endpt_t * server_ep);
Nathan Skrzypczak9fd99622019-05-16 14:38:44 +0200186extern int vppcom_session_stream_connect (uint32_t session_handle,
187 uint32_t parent_session_handle);
Florin Coras134a9962018-08-28 11:32:04 -0700188extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
189extern int vppcom_session_write (uint32_t session_handle, void *buf,
190 size_t n);
Florin Corasb0f662f2018-12-27 14:51:46 -0800191extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
192 size_t n);
Dave Wallace543852a2017-08-03 02:11:34 -0400193
Florin Coras294afe22019-01-07 17:49:17 -0800194extern int vppcom_select (int n_bits, vcl_si_set * read_map,
195 vcl_si_set * write_map, vcl_si_set * except_map,
196 double wait_for_time);
Dave Wallace543852a2017-08-03 02:11:34 -0400197
Dave Wallacef7f809c2017-10-03 01:48:42 -0400198extern int vppcom_epoll_create (void);
Florin Coras134a9962018-08-28 11:32:04 -0700199extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
200 uint32_t session_handle,
Dave Wallacef7f809c2017-10-03 01:48:42 -0400201 struct epoll_event *event);
Florin Coras134a9962018-08-28 11:32:04 -0700202extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
Dave Wallacef7f809c2017-10-03 01:48:42 -0400203 int maxevents, double wait_for_time);
Florin Coras134a9962018-08-28 11:32:04 -0700204extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
Dave Wallace35830af2017-10-09 01:43:42 -0400205 void *buffer, uint32_t * buflen);
Florin Coras134a9962018-08-28 11:32:04 -0700206extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
Stevenac1f96d2017-10-24 16:03:58 -0700207 uint32_t buflen, int flags,
208 vppcom_endpt_t * ep);
Florin Coras134a9962018-08-28 11:32:04 -0700209extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
Stevenac1f96d2017-10-24 16:03:58 -0700210 uint32_t buflen, int flags,
211 vppcom_endpt_t * ep);
Dave Wallace048b1d62018-01-03 22:24:41 -0500212extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
213 double wait_for_time);
Florin Coras99368312018-08-02 10:45:44 -0700214extern int vppcom_mq_epoll_fd (void);
Florin Coras30e79c22019-01-02 19:31:22 -0800215extern int vppcom_session_index (vcl_session_handle_t session_handle);
216extern int vppcom_session_worker (vcl_session_handle_t session_handle);
Florin Coras134a9962018-08-28 11:32:04 -0700217
Florin Coras2cba8532018-09-11 16:33:36 -0700218extern int vppcom_session_read_segments (uint32_t session_handle,
Florin Corasd68faf82020-09-25 15:18:13 -0700219 vppcom_data_segment_t * ds,
220 uint32_t n_segments,
221 uint32_t max_bytes);
Florin Coras2cba8532018-09-11 16:33:36 -0700222extern void vppcom_session_free_segments (uint32_t session_handle,
Florin Corasd68faf82020-09-25 15:18:13 -0700223 uint32_t n_bytes);
Florin Corasa5a9efd2021-01-05 17:03:29 -0800224extern int vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
225extern int vppcom_del_cert_key_pair (uint32_t ckpair_index);
Nathan Skrzypczak9fd99622019-05-16 14:38:44 +0200226extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str);
227extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
228extern int vppcom_session_listener (uint32_t session_handle);
229extern int vppcom_session_n_accepted (uint32_t session_handle);
Florin Coras2cba8532018-09-11 16:33:36 -0700230
Florin Coras66ec4672020-06-15 07:59:40 -0700231extern const char *vppcom_proto_str (vppcom_proto_t proto);
232extern const char *vppcom_retval_str (int retval);
233
Florin Coras134a9962018-08-28 11:32:04 -0700234/**
235 * Request from application to register a new worker
236 *
237 * Expectation is that applications will make use of this after a new pthread
238 * is spawned.
239 */
240extern int vppcom_worker_register (void);
Dave Wallacef7f809c2017-10-03 01:48:42 -0400241
Florin Corasdfe4cf42018-11-28 22:13:45 -0800242/**
Florin Coras369db832019-07-08 12:34:45 -0700243 * Unregister current worker
244 */
245extern void vppcom_worker_unregister (void);
246
247/**
Florin Corasdfe4cf42018-11-28 22:13:45 -0800248 * Retrieve current worker index
249 */
250extern int vppcom_worker_index (void);
251
Florin Corase0982e52019-01-25 13:19:56 -0800252/**
Pivo6017ff02020-05-04 17:57:33 +0200253 * Set current worker index
254 */
255extern void vppcom_worker_index_set (int);
256
257/**
Florin Corase0982e52019-01-25 13:19:56 -0800258 * Returns the current worker's message queues epoll fd
259 *
260 * This only works if vcl is configured to do eventfd based message queue
261 * notifications.
262 */
263extern int vppcom_worker_mqs_epfd (void);
264
Keith Burns (alagalah)5a2946c2018-02-02 08:21:56 -0800265/* *INDENT-OFF* */
266#ifdef __cplusplus
267}
268#endif
269/* *INDENT-ON* */
270
Dave Wallace543852a2017-08-03 02:11:34 -0400271#endif /* included_vppcom_h */
272
273/*
274 * fd.io coding-style-patch-verification: ON
275 *
276 * Local Variables:
277 * eval: (c-set-style "gnu")
278 * End:
279 */