72e5d46bc8f96308e4b92d3181731e7e19b93035
[vpp.git] / src / vcl / vppcom.h
1 /*
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:
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>
21 #include <sys/fcntl.h>
22 #include <sys/poll.h>
23 #include <sys/epoll.h>
24
25 /* *INDENT-OFF* */
26 #ifdef __cplusplus
27 extern "C"
28 {
29 #endif
30 /* *INDENT-ON* */
31
32 /*
33  * VPPCOM Public API Definitions, Enums, and Data Structures
34  */
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"
47
48   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,
56   } vppcom_proto_t;
57
58   typedef enum
59   {
60     VPPCOM_IS_IP6 = 0,
61     VPPCOM_IS_IP4,
62   } vppcom_is_ip4_t;
63
64   typedef struct vppcom_endpt_t_
65   {
66     uint8_t is_cut_thru;
67     uint8_t is_ip4;
68     uint8_t *ip;
69     uint16_t port;
70     uint64_t parent_handle;
71   } vppcom_endpt_t;
72
73 typedef uint32_t vcl_session_handle_t;
74
75 typedef struct vppcom_cert_key_pair_
76 {
77   char *cert;
78   char *key;
79   uint32_t cert_len;
80   uint32_t key_len;
81 } vppcom_cert_key_pair_t;
82
83 typedef enum
84 {
85   VPPCOM_OK = 0,
86   VPPCOM_EAGAIN = -EAGAIN,
87   VPPCOM_EWOULDBLOCK = -EWOULDBLOCK,
88   VPPCOM_EINPROGRESS = -EINPROGRESS,
89   VPPCOM_EFAULT = -EFAULT,
90   VPPCOM_ENOMEM = -ENOMEM,
91   VPPCOM_EINVAL = -EINVAL,
92   VPPCOM_EBADFD = -EBADFD,
93   VPPCOM_EAFNOSUPPORT = -EAFNOSUPPORT,
94   VPPCOM_ECONNABORTED = -ECONNABORTED,
95   VPPCOM_ECONNRESET = -ECONNRESET,
96   VPPCOM_ENOTCONN = -ENOTCONN,
97   VPPCOM_ECONNREFUSED = -ECONNREFUSED,
98   VPPCOM_ETIMEDOUT = -ETIMEDOUT,
99   VPPCOM_EEXIST = -EEXIST,
100   VPPCOM_ENOPROTOOPT = -ENOPROTOOPT
101 } vppcom_error_t;
102
103 typedef enum
104 {
105   VPPCOM_ATTR_GET_NREAD,
106   VPPCOM_ATTR_GET_NWRITE,
107   VPPCOM_ATTR_GET_FLAGS,
108   VPPCOM_ATTR_SET_FLAGS,
109   VPPCOM_ATTR_GET_LCL_ADDR,
110   VPPCOM_ATTR_SET_LCL_ADDR,
111   VPPCOM_ATTR_GET_PEER_ADDR,
112   VPPCOM_ATTR_GET_LIBC_EPFD,
113   VPPCOM_ATTR_SET_LIBC_EPFD,
114   VPPCOM_ATTR_GET_PROTOCOL,
115   VPPCOM_ATTR_GET_LISTEN,
116   VPPCOM_ATTR_GET_ERROR,
117   VPPCOM_ATTR_GET_TX_FIFO_LEN,
118   VPPCOM_ATTR_SET_TX_FIFO_LEN,
119   VPPCOM_ATTR_GET_RX_FIFO_LEN,
120   VPPCOM_ATTR_SET_RX_FIFO_LEN,
121   VPPCOM_ATTR_GET_REUSEADDR,
122   VPPCOM_ATTR_SET_REUSEADDR,
123   VPPCOM_ATTR_GET_REUSEPORT,
124   VPPCOM_ATTR_SET_REUSEPORT,
125   VPPCOM_ATTR_GET_BROADCAST,
126   VPPCOM_ATTR_SET_BROADCAST,
127   VPPCOM_ATTR_GET_V6ONLY,
128   VPPCOM_ATTR_SET_V6ONLY,
129   VPPCOM_ATTR_GET_KEEPALIVE,
130   VPPCOM_ATTR_SET_KEEPALIVE,
131   VPPCOM_ATTR_GET_TCP_NODELAY,
132   VPPCOM_ATTR_SET_TCP_NODELAY,
133   VPPCOM_ATTR_GET_TCP_KEEPIDLE,
134   VPPCOM_ATTR_SET_TCP_KEEPIDLE,
135   VPPCOM_ATTR_GET_TCP_KEEPINTVL,
136   VPPCOM_ATTR_SET_TCP_KEEPINTVL,
137   VPPCOM_ATTR_GET_TCP_USER_MSS,
138   VPPCOM_ATTR_SET_TCP_USER_MSS,
139   VPPCOM_ATTR_SET_SHUT,
140   VPPCOM_ATTR_GET_SHUT,
141   VPPCOM_ATTR_SET_CONNECTED,
142   VPPCOM_ATTR_SET_CKPAIR,
143   VPPCOM_ATTR_SET_VRF,
144   VPPCOM_ATTR_GET_VRF,
145   VPPCOM_ATTR_GET_DOMAIN,
146   VPPCOM_ATTR_SET_ENDPT_EXT_CFG,
147 } vppcom_attr_op_t;
148
149 typedef struct _vcl_poll
150 {
151   uint32_t fds_ndx;
152   vcl_session_handle_t sh;
153   short events;
154   short revents;
155 } vcl_poll_t;
156
157 typedef struct vppcom_data_segment_
158 {
159   unsigned char *data;
160   uint32_t len;
161 } vppcom_data_segment_t;
162
163 typedef vppcom_data_segment_t vppcom_data_segments_t[2];
164
165 typedef unsigned long vcl_si_set;
166
167 /*
168  * VPPCOM Public API Functions
169  */
170
171 extern int vppcom_app_create (const char *app_name);
172 extern void vppcom_app_destroy (void);
173
174 extern int vppcom_session_create (uint8_t proto, uint8_t is_nonblocking);
175 extern int vppcom_session_shutdown (uint32_t session_handle);
176 extern int vppcom_session_close (uint32_t session_handle);
177 extern int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep);
178 extern int vppcom_session_listen (uint32_t session_handle, uint32_t q_len);
179
180 extern int vppcom_session_accept (uint32_t session_handle,
181                                   vppcom_endpt_t * client_ep, uint32_t flags);
182
183 extern int vppcom_session_connect (uint32_t session_handle,
184                                    vppcom_endpt_t * server_ep);
185 extern int vppcom_session_stream_connect (uint32_t session_handle,
186                                           uint32_t parent_session_handle);
187 extern int vppcom_session_read (uint32_t session_handle, void *buf, size_t n);
188 extern int vppcom_session_write (uint32_t session_handle, void *buf,
189                                  size_t n);
190 extern int vppcom_session_write_msg (uint32_t session_handle, void *buf,
191                                      size_t n);
192
193 extern int vppcom_select (int n_bits, vcl_si_set * read_map,
194                           vcl_si_set * write_map, vcl_si_set * except_map,
195                           double wait_for_time);
196
197 extern int vppcom_epoll_create (void);
198 extern int vppcom_epoll_ctl (uint32_t vep_handle, int op,
199                              uint32_t session_handle,
200                              struct epoll_event *event);
201 extern int vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
202                               int maxevents, double wait_for_time);
203 extern int vppcom_session_attr (uint32_t session_handle, uint32_t op,
204                                 void *buffer, uint32_t * buflen);
205 extern int vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
206                                     uint32_t buflen, int flags,
207                                     vppcom_endpt_t * ep);
208 extern int vppcom_session_sendto (uint32_t session_handle, void *buffer,
209                                   uint32_t buflen, int flags,
210                                   vppcom_endpt_t * ep);
211 extern int vppcom_poll (vcl_poll_t * vp, uint32_t n_sids,
212                         double wait_for_time);
213 extern int vppcom_mq_epoll_fd (void);
214 extern int vppcom_session_index (vcl_session_handle_t session_handle);
215 extern int vppcom_session_worker (vcl_session_handle_t session_handle);
216
217 extern int vppcom_session_read_segments (uint32_t session_handle,
218                                          vppcom_data_segment_t * ds,
219                                          uint32_t n_segments,
220                                          uint32_t max_bytes);
221 extern void vppcom_session_free_segments (uint32_t session_handle,
222                                           uint32_t n_bytes);
223 extern int vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
224 extern int vppcom_del_cert_key_pair (uint32_t ckpair_index);
225 extern int vppcom_unformat_proto (uint8_t * proto, char *proto_str);
226 extern int vppcom_session_is_connectable_listener (uint32_t session_handle);
227 extern int vppcom_session_listener (uint32_t session_handle);
228 extern int vppcom_session_n_accepted (uint32_t session_handle);
229
230 extern const char *vppcom_proto_str (vppcom_proto_t proto);
231 extern const char *vppcom_retval_str (int retval);
232
233 /**
234  * Request from application to register a new worker
235  *
236  * Expectation is that applications will make use of this after a new pthread
237  * is spawned.
238  */
239 extern int vppcom_worker_register (void);
240
241 /**
242  * Unregister current worker
243  */
244 extern void vppcom_worker_unregister (void);
245
246 /**
247  * Retrieve current worker index
248  */
249 extern int vppcom_worker_index (void);
250
251 /**
252  * Set current worker index
253  */
254 extern void vppcom_worker_index_set (int);
255
256 /**
257  * Returns the current worker's message queues epoll fd
258  *
259  * This only works if vcl is configured to do eventfd based message queue
260  * notifications.
261  */
262 extern int vppcom_worker_mqs_epfd (void);
263
264 /* *INDENT-OFF* */
265 #ifdef __cplusplus
266 }
267 #endif
268 /* *INDENT-ON* */
269
270 #endif /* included_vppcom_h */
271
272 /*
273  * fd.io coding-style-patch-verification: ON
274  *
275  * Local Variables:
276  * eval: (c-set-style "gnu")
277  * End:
278  */