blob: f79786ba51c28241c28e3277df4b16aa9f8b1c74 [file] [log] [blame]
Florin Coras697faea2018-06-27 17:10:49 -07001/*
Florin Coras5e062572019-03-14 19:07:51 -07002 * Copyright (c) 2018-2019 Cisco and/or its affiliates.
Florin Coras697faea2018-06-27 17:10:49 -07003 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this
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 SRC_VCL_VCL_PRIVATE_H_
17#define SRC_VCL_VCL_PRIVATE_H_
18
19#include <vnet/session/application_interface.h>
20#include <vcl/vppcom.h>
Florin Coras697faea2018-06-27 17:10:49 -070021#include <vcl/vcl_debug.h>
22
23#if (CLIB_DEBUG > 0)
24/* Set VPPCOM_DEBUG_INIT 2 for connection debug,
25 * 3 for read/write debug output
26 * or
27 * export VCL_DEBUG=<#> to set dynamically.
28 */
29#define VPPCOM_DEBUG_INIT 1
30#else
31#define VPPCOM_DEBUG_INIT 0
32#endif
33
34#define VPPCOM_DEBUG vcm->debug
35
Florin Coras134a9962018-08-28 11:32:04 -070036extern __thread uword __vcl_worker_index;
37
38static inline void
39vcl_set_worker_index (uword wrk_index)
40{
41 __vcl_worker_index = wrk_index;
42}
43
44static inline uword
45vcl_get_worker_index (void)
46{
47 return __vcl_worker_index;
48}
49
Florin Coras697faea2018-06-27 17:10:49 -070050/*
51 * VPPCOM Private definitions and functions.
52 */
53typedef enum
54{
55 STATE_APP_START,
56 STATE_APP_CONN_VPP,
57 STATE_APP_ENABLED,
58 STATE_APP_ATTACHED,
Florin Coras134a9962018-08-28 11:32:04 -070059 STATE_APP_ADDING_WORKER,
Florin Coras458089b2019-08-21 16:20:44 -070060 STATE_APP_ADDING_TLS_DATA,
Florin Coras134a9962018-08-28 11:32:04 -070061 STATE_APP_FAILED,
62 STATE_APP_READY
Florin Corasb88de902020-09-08 16:47:57 -070063} vcl_bapi_app_state_t;
Florin Coras697faea2018-06-27 17:10:49 -070064
Florin Corasc127d5a2020-10-14 16:35:58 -070065typedef enum vcl_session_state_
Florin Coras697faea2018-06-27 17:10:49 -070066{
Florin Corasc127d5a2020-10-14 16:35:58 -070067 VCL_STATE_CLOSED,
Florin Corasc127d5a2020-10-14 16:35:58 -070068 VCL_STATE_LISTEN,
Florin Corasdfffdd72020-10-15 10:54:47 -070069 VCL_STATE_READY,
Florin Corasc127d5a2020-10-14 16:35:58 -070070 VCL_STATE_VPP_CLOSING,
71 VCL_STATE_DISCONNECT,
72 VCL_STATE_DETACHED,
73 VCL_STATE_UPDATED,
74 VCL_STATE_LISTEN_NO_MQ,
Florin Coras288eaab2019-02-03 15:26:14 -080075} vcl_session_state_t;
Florin Coras697faea2018-06-27 17:10:49 -070076
Florin Coras697faea2018-06-27 17:10:49 -070077typedef struct epoll_event vppcom_epoll_event_t;
78
79typedef struct
80{
Florin Coras134a9962018-08-28 11:32:04 -070081 u32 next_sh;
82 u32 prev_sh;
83 u32 vep_sh;
Florin Coras697faea2018-06-27 17:10:49 -070084 vppcom_epoll_event_t ev;
85#define VEP_DEFAULT_ET_MASK (EPOLLIN|EPOLLOUT)
86#define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
87 u32 et_mask;
Florin Corasfa3884f2021-06-22 20:04:46 -070088 u32 lt_next;
89 u32 lt_prev;
Florin Coras697faea2018-06-27 17:10:49 -070090} vppcom_epoll_t;
91
Florin Coras294afe22019-01-07 17:49:17 -080092/* Select uses the vcl_si_set as if a clib_bitmap. Make sure they are the
93 * same size */
94STATIC_ASSERT (sizeof (clib_bitmap_t) == sizeof (vcl_si_set),
95 "vppcom bitmap size mismatch");
96
Florin Coras697faea2018-06-27 17:10:49 -070097typedef struct
98{
99 u8 is_ip4;
100 ip46_address_t ip46;
101} vppcom_ip46_t;
102
Florin Coras3c7d4f92018-12-14 11:28:43 -0800103#define VCL_ACCEPTED_F_CLOSED (1 << 0)
104#define VCL_ACCEPTED_F_RESET (1 << 1)
105
Florin Coras54693d22018-07-17 10:46:29 -0700106typedef struct vcl_session_msg
107{
Florin Coras54693d22018-07-17 10:46:29 -0700108 union
109 {
110 session_accepted_msg_t accepted_msg;
111 };
Florin Coras3c7d4f92018-12-14 11:28:43 -0800112 u32 flags;
Florin Coras54693d22018-07-17 10:46:29 -0700113} vcl_session_msg_t;
114
BenoƮt Ganne47727c02019-02-12 13:35:08 +0100115typedef enum
Florin Coras697faea2018-06-27 17:10:49 -0700116{
117 VCL_SESS_ATTR_SERVER,
118 VCL_SESS_ATTR_CUT_THRU,
119 VCL_SESS_ATTR_VEP,
120 VCL_SESS_ATTR_VEP_SESSION,
121 VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN
122 VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK
123 VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR
124 VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT
125 VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST
126 VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY
127 VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE
128 VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY
129 VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE
130 VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL
131 VCL_SESS_ATTR_MAX
132} vppcom_session_attr_t;
133
Florin Coras0a1e1832020-03-29 18:54:04 +0000134typedef enum vcl_session_flags_
135{
Florin Corasd85666f2020-04-03 00:58:48 +0000136 VCL_SESSION_F_CONNECTED = 1 << 0,
Florin Coras6c3b2182020-10-19 18:36:48 -0700137 VCL_SESSION_F_IS_VEP = 1 << 1,
138 VCL_SESSION_F_IS_VEP_SESSION = 1 << 2,
Florin Corasac422d62020-10-19 20:51:36 -0700139 VCL_SESSION_F_HAS_RX_EVT = 1 << 3,
liuyacan55c952e2021-06-13 14:54:55 +0800140 VCL_SESSION_F_RD_SHUTDOWN = 1 << 4,
141 VCL_SESSION_F_WR_SHUTDOWN = 1 << 5,
Florin Coras0a1e1832020-03-29 18:54:04 +0000142} __clib_packed vcl_session_flags_t;
143
Florin Corasac422d62020-10-19 20:51:36 -0700144typedef struct vcl_session_
Florin Coras697faea2018-06-27 17:10:49 -0700145{
Florin Coras2cba8532018-09-11 16:33:36 -0700146 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Florin Corasac422d62020-10-19 20:51:36 -0700147
Florin Coras697faea2018-06-27 17:10:49 -0700148#define _(type, name) type name;
149 foreach_app_session_field
150#undef _
Florin Corasac422d62020-10-19 20:51:36 -0700151 vcl_session_flags_t flags; /**< see @ref vcl_session_flags_t */
152 u32 rx_bytes_pending; /**< bytes rx-ed as segs but not yet freed */
Florin Coras697faea2018-06-27 17:10:49 -0700153
Florin Coras653e43f2019-03-04 10:56:23 -0800154 svm_fifo_t *ct_rx_fifo;
155 svm_fifo_t *ct_tx_fifo;
Florin Coras54693d22018-07-17 10:46:29 -0700156 vcl_session_msg_t *accept_evts_fifo;
Florin Corasac422d62020-10-19 20:51:36 -0700157
158 u64 vpp_handle;
Florin Corasa5a9efd2021-01-05 17:03:29 -0800159 u64 parent_handle;
Florin Corasac422d62020-10-19 20:51:36 -0700160 u32 listener_index; /**< index of parent listener (if any) */
161 int n_accepted_sessions; /**< sessions accepted by this listener */
Florin Corasac422d62020-10-19 20:51:36 -0700162 vppcom_epoll_t vep;
Florin Corasa5a9efd2021-01-05 17:03:29 -0800163 u32 attributes; /**< see @ref vppcom_session_attr_t */
164 int libc_epfd;
Florin Coras6a6555a2021-01-28 11:39:27 -0800165 u32 vrf;
Florin Corasac422d62020-10-19 20:51:36 -0700166
167 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
168 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
Florin Corasac422d62020-10-19 20:51:36 -0700169
Florin Coras4ac25842021-04-19 17:34:54 -0700170 transport_endpt_ext_cfg_t *ext_config;
Filip Tehlar2f09bfc2021-11-15 10:26:56 +0000171 u8 dscp;
Florin Coras4ac25842021-04-19 17:34:54 -0700172
Florin Coras697faea2018-06-27 17:10:49 -0700173#if VCL_ELOG
174 elog_track_t elog_track;
175#endif
176} vcl_session_t;
177
178typedef struct vppcom_cfg_t_
179{
David Johnsond9818dd2018-12-14 14:53:41 -0500180 uword heapsize;
Florin Coras134a9962018-08-28 11:32:04 -0700181 u32 max_workers;
David Johnsond9818dd2018-12-14 14:53:41 -0500182 uword segment_baseva;
Florin Corasd18528f2020-03-27 18:41:54 +0000183 uword segment_size;
184 uword add_segment_size;
Florin Coras697faea2018-06-27 17:10:49 -0700185 u32 preallocated_fifo_pairs;
186 u32 rx_fifo_size;
187 u32 tx_fifo_size;
188 u32 event_queue_size;
Florin Coras697faea2018-06-27 17:10:49 -0700189 u8 app_proxy_transport_tcp;
190 u8 app_proxy_transport_udp;
191 u8 app_scope_local;
192 u8 app_scope_global;
193 u8 *namespace_id;
194 u64 namespace_secret;
Florin Coras99368312018-08-02 10:45:44 -0700195 u8 use_mq_eventfd;
Florin Coras697faea2018-06-27 17:10:49 -0700196 f64 app_timeout;
197 f64 session_timeout;
Florin Coras697faea2018-06-27 17:10:49 -0700198 char *event_log_path;
Florin Coras935ce752020-09-08 22:43:47 -0700199 u8 *vpp_app_socket_api; /**< app socket api socket file name */
Florin Corasb88de902020-09-08 16:47:57 -0700200 u8 *vpp_bapi_socket_name; /**< bapi socket transport socket name */
Florin Corasd747c3c2019-10-20 19:55:56 -0700201 u32 tls_engine;
Florin Corasff40d8f2020-08-11 22:05:28 -0700202 u8 mt_wrk_supported;
Florin Coras697faea2018-06-27 17:10:49 -0700203} vppcom_cfg_t;
204
205void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
206
Florin Coras54693d22018-07-17 10:46:29 -0700207typedef struct vcl_cut_through_registration_
208{
209 svm_msg_q_t *mq;
Florin Coras99368312018-08-02 10:45:44 -0700210 svm_msg_q_t *peer_mq;
Florin Coras54693d22018-07-17 10:46:29 -0700211 u32 sid;
Florin Coras99368312018-08-02 10:45:44 -0700212 u32 epoll_evt_conn_index; /*< mq evt connection index part of
213 the mqs evtfd epoll (if used) */
Florin Coras54693d22018-07-17 10:46:29 -0700214} vcl_cut_through_registration_t;
215
Florin Coras99368312018-08-02 10:45:44 -0700216typedef struct vcl_mq_evt_conn_
217{
218 svm_msg_q_t *mq;
219 int mq_fd;
220} vcl_mq_evt_conn_t;
221
Florin Coras134a9962018-08-28 11:32:04 -0700222typedef struct vcl_worker_
Florin Coras697faea2018-06-27 17:10:49 -0700223{
Florin Coras134a9962018-08-28 11:32:04 -0700224 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Florin Coras697faea2018-06-27 17:10:49 -0700225
Florin Coras697faea2018-06-27 17:10:49 -0700226 /* Session pool */
Florin Coras697faea2018-06-27 17:10:49 -0700227 vcl_session_t *sessions;
228
Florin Coras053a0e42018-11-13 15:52:38 -0800229 /** Worker/thread index in current process */
Florin Coras134a9962018-08-28 11:32:04 -0700230 u32 wrk_index;
231
Florin Coras053a0e42018-11-13 15:52:38 -0800232 /** Worker index in vpp*/
233 u32 vpp_wrk_index;
234
Florin Corascc7c88e2020-09-15 15:56:51 -0700235 /**
236 * Generic api client handle. When binary api is in used, it stores
237 * the "client_index" and when socket api is use, it stores the sapi
238 * client handle */
239 u32 api_client_handle;
Florin Coras47c40e22018-11-26 17:01:36 -0800240
241 /** VPP binary api input queue */
242 svm_queue_t *vl_input_queue;
243
Florin Coras458089b2019-08-21 16:20:44 -0700244 /** VPP mq to be used for exchanging control messages */
245 svm_msg_q_t *ctrl_mq;
246
Florin Coras99368312018-08-02 10:45:44 -0700247 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
248 int mqs_epfd;
249
250 /** Pool of event message queue event connections */
251 vcl_mq_evt_conn_t *mq_evt_conns;
252
253 /** Per worker buffer for receiving mq epoll events */
254 struct epoll_event *mq_events;
255
Florin Corasfa3884f2021-06-22 20:04:46 -0700256 /** Next session to be lt polled */
257 u32 ep_lt_current;
Florin Corasfe286f72021-06-04 10:07:55 -0700258
Florin Coras134a9962018-08-28 11:32:04 -0700259 /** Hash table for disconnect processing */
Florin Coras697faea2018-06-27 17:10:49 -0700260 uword *session_index_by_vpp_handles;
261
Florin Coras134a9962018-08-28 11:32:04 -0700262 /** Select bitmaps */
Florin Coras697faea2018-06-27 17:10:49 -0700263 clib_bitmap_t *rd_bitmap;
264 clib_bitmap_t *wr_bitmap;
265 clib_bitmap_t *ex_bitmap;
266
Florin Coras134a9962018-08-28 11:32:04 -0700267 /** Our event message queue */
Florin Coras3c2fed52018-07-04 04:15:05 -0700268 svm_msg_q_t *app_event_queue;
Florin Coras697faea2018-06-27 17:10:49 -0700269
Florin Coras134a9962018-08-28 11:32:04 -0700270 /** For deadman timers */
Florin Coras697faea2018-06-27 17:10:49 -0700271 clib_time_t clib_time;
272
Florin Coras134a9962018-08-28 11:32:04 -0700273 /** Vector acting as buffer for mq messages */
Florin Coras99368312018-08-02 10:45:44 -0700274 svm_msg_q_msg_t *mq_msg_vector;
Florin Coras3348a4c2018-09-07 17:09:35 -0700275
Florin Coras86f04502018-09-12 16:08:01 -0700276 /** Vector of unhandled events */
277 session_event_t *unhandled_evts_vector;
278
Florin Coras30e79c22019-01-02 19:31:22 -0800279 u32 *pending_session_wrk_updates;
280
Florin Coras3348a4c2018-09-07 17:09:35 -0700281 /** Used also as a thread stop key buffer */
282 pthread_t thread_id;
Florin Coras47c40e22018-11-26 17:01:36 -0800283
284 /** Current pid, may be different from main_pid if forked child */
285 pid_t current_pid;
Florin Coras01f3f892018-12-02 12:45:53 -0800286
287 u32 forked_child;
288
Florin Coras935ce752020-09-08 22:43:47 -0700289 clib_socket_t app_api_sock;
Florin Corasd4c70922019-11-28 14:21:21 -0800290 socket_client_main_t bapi_sock_ctx;
Florin Corasd4c70922019-11-28 14:21:21 -0800291 api_main_t bapi_api_ctx;
Florin Corasfda21c92021-04-07 17:03:01 -0700292 memory_client_main_t bapi_mem_ctx;
hanlina3a48962020-07-13 11:09:15 +0800293
Florin Coras3b6c84c2021-01-05 20:45:44 -0800294 /* State of the connection, shared between msg RX thread and main thread */
295 volatile vcl_bapi_app_state_t bapi_app_state;
Florin Corasa5a9efd2021-01-05 17:03:29 -0800296 volatile uword bapi_return;
Florin Coras3b6c84c2021-01-05 20:45:44 -0800297
Florin Coras04ae8272021-04-12 19:55:37 -0700298 u8 session_attr_op;
299 int session_attr_op_rv;
300 transport_endpt_attr_t session_attr_rv;
301
hanlina3a48962020-07-13 11:09:15 +0800302 /** vcl needs next epoll_create to go to libc_epoll */
303 u8 vcl_needs_real_epoll;
304 volatile int rpc_done;
Florin Coras134a9962018-08-28 11:32:04 -0700305} vcl_worker_t;
306
Florin Corasb242d312020-10-26 15:35:40 -0700307STATIC_ASSERT (sizeof (session_disconnected_msg_t) <= 16,
308 "disconnected must fit in session_event_t");
309STATIC_ASSERT (sizeof (session_reset_msg_t) <= 16,
310 "disconnected must fit in session_event_t");
311
Florin Coras40c07ce2020-07-16 20:46:17 -0700312typedef void (vcl_rpc_fn_t) (void *args);
313
Florin Coras134a9962018-08-28 11:32:04 -0700314typedef struct vppcom_main_t_
315{
316 u8 is_init;
317 u32 debug;
318 pthread_t main_cpu;
319
Florin Coras053a0e42018-11-13 15:52:38 -0800320 /** Main process pid */
321 pid_t main_pid;
322
Florin Corasc1f5a432018-11-20 11:31:26 -0800323 /** App's index in vpp. It's used by vpp to identify the app */
324 u32 app_index;
Florin Coras134a9962018-08-28 11:32:04 -0700325
Florin Coras053a0e42018-11-13 15:52:38 -0800326 u8 *app_name;
327
Florin Coras134a9962018-08-28 11:32:04 -0700328 /** VCL configuration */
329 vppcom_cfg_t cfg;
Florin Coras99368312018-08-02 10:45:44 -0700330
Florin Coras47c40e22018-11-26 17:01:36 -0800331 volatile u32 forking;
332
Florin Coras134a9962018-08-28 11:32:04 -0700333 /** Workers */
334 vcl_worker_t *workers;
335
Florin Corasde9f08b2018-09-07 14:32:58 -0700336 /** Lock to protect worker registrations */
337 clib_spinlock_t workers_lock;
338
Florin Corasd85de682018-11-29 17:02:29 -0800339 /** Lock to protect segment hash table */
340 clib_rwlock_t segment_table_lock;
341
342 /** Mapped segments table */
343 uword *segment_table;
344
Florin Coras22ba3302019-08-29 22:45:04 -0700345 /** Control mq obtained from attach */
346 svm_msg_q_t *ctrl_mq;
347
Florin Coras88001c62019-04-24 14:44:46 -0700348 fifo_segment_main_t segment_main;
Florin Corasadc74d72018-12-02 13:36:00 -0800349
Florin Corasb88de902020-09-08 16:47:57 -0700350 vcl_rpc_fn_t *wrk_rpc_fn;
351
352 /*
353 * Binary api context
354 */
355
Florin Corasb88de902020-09-08 16:47:57 -0700356 /* VNET_API_ERROR_FOO -> "Foo" hash table */
357 uword *error_string_by_error_number;
358
Florin Coras697faea2018-06-27 17:10:49 -0700359#ifdef VCL_ELOG
360 /* VPP Event-logger */
361 elog_main_t elog_main;
362 elog_track_t elog_track;
363#endif
364
Florin Coras697faea2018-06-27 17:10:49 -0700365} vppcom_main_t;
366
367extern vppcom_main_t *vcm;
Florin Corasce815de2020-04-16 18:47:27 +0000368extern vppcom_main_t _vppcom_main;
Florin Coras697faea2018-06-27 17:10:49 -0700369
Florin Coras54693d22018-07-17 10:46:29 -0700370#define VCL_INVALID_SESSION_INDEX ((u32)~0)
Nathan Skrzypczakcef02be2019-07-17 10:20:45 +0200371#define VCL_INVALID_SESSION_HANDLE ((u64)~0)
Florin Corasd85de682018-11-29 17:02:29 -0800372#define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
373#define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
Florin Coras54693d22018-07-17 10:46:29 -0700374
Florin Corascbb5e822021-02-20 10:42:22 -0800375void vcl_session_detach_fifos (vcl_session_t *s);
376
Florin Coras54693d22018-07-17 10:46:29 -0700377static inline vcl_session_t *
Florin Coras134a9962018-08-28 11:32:04 -0700378vcl_session_alloc (vcl_worker_t * wrk)
Florin Coras99368312018-08-02 10:45:44 -0700379{
380 vcl_session_t *s;
Florin Coras134a9962018-08-28 11:32:04 -0700381 pool_get (wrk->sessions, s);
Florin Coras99368312018-08-02 10:45:44 -0700382 memset (s, 0, sizeof (*s));
Florin Coras134a9962018-08-28 11:32:04 -0700383 s->session_index = s - wrk->sessions;
Nathan Skrzypczak9fd99622019-05-16 14:38:44 +0200384 s->listener_index = VCL_INVALID_SESSION_INDEX;
Florin Coras99368312018-08-02 10:45:44 -0700385 return s;
386}
387
388static inline void
Florin Coras134a9962018-08-28 11:32:04 -0700389vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
Florin Coras99368312018-08-02 10:45:44 -0700390{
Florin Coras243edd52020-03-04 22:20:12 +0000391 /* Debug level set to 1 to avoid debug messages while ldp is cleaning up */
392 VDBG (1, "session %u [0x%llx] removed", s->session_index, s->vpp_handle);
Florin Corascbb5e822021-02-20 10:42:22 -0800393 vcl_session_detach_fifos (s);
Florin Corasa54b62d2021-04-21 09:05:56 -0700394 if (s->ext_config)
395 clib_mem_free (s->ext_config);
Florin Coras134a9962018-08-28 11:32:04 -0700396 pool_put (wrk->sessions, s);
Florin Coras99368312018-08-02 10:45:44 -0700397}
398
399static inline vcl_session_t *
Florin Coras134a9962018-08-28 11:32:04 -0700400vcl_session_get (vcl_worker_t * wrk, u32 session_index)
Florin Coras54693d22018-07-17 10:46:29 -0700401{
Florin Coras134a9962018-08-28 11:32:04 -0700402 if (pool_is_free_index (wrk->sessions, session_index))
Florin Coras54693d22018-07-17 10:46:29 -0700403 return 0;
Florin Coras134a9962018-08-28 11:32:04 -0700404 return pool_elt_at_index (wrk->sessions, session_index);
Florin Coras54693d22018-07-17 10:46:29 -0700405}
406
Florin Corasf9240dc2019-01-15 08:03:17 -0800407static inline vcl_session_handle_t
hanlinf8e13632020-08-21 11:05:36 +0800408vcl_session_handle_from_wrk_session_index (u32 session_index, u32 wrk_index)
409{
410 ASSERT (session_index < 2 << 24);
411 return (wrk_index << 24 | session_index);
412}
413
414static inline vcl_session_handle_t
Florin Corasf9240dc2019-01-15 08:03:17 -0800415vcl_session_handle_from_index (u32 session_index)
416{
417 ASSERT (session_index < 2 << 24);
418 return (vcl_get_worker_index () << 24 | session_index);
419}
420
421static inline vcl_session_handle_t
Florin Coras134a9962018-08-28 11:32:04 -0700422vcl_session_handle (vcl_session_t * s)
Florin Coras54693d22018-07-17 10:46:29 -0700423{
Florin Corasf9240dc2019-01-15 08:03:17 -0800424 return vcl_session_handle_from_index (s->session_index);
Florin Coras134a9962018-08-28 11:32:04 -0700425}
426
427static inline void
428vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
429{
430 *wrk_index = handle >> 24;
431 *session_index = handle & 0xFFFFFF;
Florin Coras54693d22018-07-17 10:46:29 -0700432}
433
434static inline vcl_session_t *
Florin Coras134a9962018-08-28 11:32:04 -0700435vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
436{
437 u32 session_index, wrk_index;
438 vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
439 ASSERT (wrk_index == wrk->wrk_index);
440 return vcl_session_get (wrk, session_index);
441}
442
443static inline vcl_session_t *
444vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
Florin Coras54693d22018-07-17 10:46:29 -0700445{
446 uword *p;
Florin Coras134a9962018-08-28 11:32:04 -0700447 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
448 return vcl_session_get (wrk, (u32) p[0]);
Florin Coras54693d22018-07-17 10:46:29 -0700449 return 0;
450}
451
452static inline u32
Florin Coras134a9962018-08-28 11:32:04 -0700453vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
Florin Coras54693d22018-07-17 10:46:29 -0700454{
455 uword *p;
Florin Coras134a9962018-08-28 11:32:04 -0700456 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
Florin Coras54693d22018-07-17 10:46:29 -0700457 return p[0];
458 return VCL_INVALID_SESSION_INDEX;
459}
460
Florin Coras134a9962018-08-28 11:32:04 -0700461static inline void
462vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
463{
464 hash_set (wrk->session_index_by_vpp_handles, handle, value);
465}
466
467static inline void
468vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
469{
470 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
471}
472
473static inline uword *
474vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
475{
476 return hash_get (wrk->session_index_by_vpp_handles, handle);
477}
478
479static inline void
480vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
481 u32 value)
482{
Florin Coras134a9962018-08-28 11:32:04 -0700483 hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
484}
485
486static inline void
487vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
488{
Florin Coras134a9962018-08-28 11:32:04 -0700489 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
490}
491
Nathan Skrzypczak9fd99622019-05-16 14:38:44 +0200492static inline int
493vcl_session_is_connectable_listener (vcl_worker_t * wrk,
494 vcl_session_t * session)
495{
496 /* Tell if we session_handle is a QUIC session.
497 * We can be in the following cases :
498 * Listen session <- QUIC session <- Stream session
499 * QUIC session <- Stream session
500 */
501 vcl_session_t *ls;
502 if (session->session_type != VPPCOM_PROTO_QUIC)
503 return 0;
504 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
Florin Corasc127d5a2020-10-14 16:35:58 -0700505 return !(session->session_state == VCL_STATE_LISTEN);
Nathan Skrzypczak9fd99622019-05-16 14:38:44 +0200506 ls = vcl_session_get_w_handle (wrk, session->listener_index);
507 if (!ls)
508 return VPPCOM_EBADFD;
Florin Corasc127d5a2020-10-14 16:35:58 -0700509 return ls->session_state == VCL_STATE_LISTEN;
Nathan Skrzypczak9fd99622019-05-16 14:38:44 +0200510}
511
Florin Coras134a9962018-08-28 11:32:04 -0700512static inline vcl_session_t *
Florin Corasdfae9f92019-02-20 19:48:31 -0800513vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
Florin Coras134a9962018-08-28 11:32:04 -0700514{
515 uword *p;
Florin Corasc127d5a2020-10-14 16:35:58 -0700516 vcl_session_t *s;
Florin Coras134a9962018-08-28 11:32:04 -0700517
518 p = hash_get (wrk->session_index_by_vpp_handles, handle);
519 if (!p)
520 {
Florin Corasdfae9f92019-02-20 19:48:31 -0800521 VDBG (0, "could not find listen session: unknown vpp listener handle"
522 " %llx", handle);
Florin Coras134a9962018-08-28 11:32:04 -0700523 return 0;
524 }
Florin Corasc127d5a2020-10-14 16:35:58 -0700525 s = vcl_session_get (wrk, p[0]);
526 if (!s)
Florin Coras134a9962018-08-28 11:32:04 -0700527 {
Florin Corasdfae9f92019-02-20 19:48:31 -0800528 VDBG (1, "invalid listen session index (%u)", p[0]);
Florin Coras134a9962018-08-28 11:32:04 -0700529 return 0;
530 }
531
liuyacan4fca7442021-05-14 02:11:03 +0000532 if (s->session_state == VCL_STATE_DISCONNECT)
533 {
534 VDBG (0, "listen session [0x%llx] is closing", s->vpp_handle);
535 return 0;
536 }
537
Florin Corasc127d5a2020-10-14 16:35:58 -0700538 ASSERT (s->session_state == VCL_STATE_LISTEN
539 || s->session_state == VCL_STATE_LISTEN_NO_MQ
540 || vcl_session_is_connectable_listener (wrk, s));
541 return s;
Florin Coras134a9962018-08-28 11:32:04 -0700542}
543
Florin Coras460dce62018-07-27 05:45:06 -0700544static inline u8
545vcl_session_is_ct (vcl_session_t * s)
546{
Florin Coras653e43f2019-03-04 10:56:23 -0800547 return (s->ct_tx_fifo != 0);
Florin Coras460dce62018-07-27 05:45:06 -0700548}
549
Florin Coras6d0106e2019-01-29 20:11:58 -0800550static inline u8
Florin Coras6e3c1f82020-01-15 01:30:46 +0000551vcl_session_is_cl (vcl_session_t * s)
552{
553 if (s->session_type == VPPCOM_PROTO_UDP)
Florin Corasa4dac8a2020-05-25 18:17:03 +0000554 return !(s->flags & VCL_SESSION_F_CONNECTED);
Florin Coras6e3c1f82020-01-15 01:30:46 +0000555 return 0;
556}
557
558static inline u8
Florin Corasa5a9efd2021-01-05 17:03:29 -0800559vcl_session_has_crypto (vcl_session_t *s)
560{
561 return (s->session_type == VPPCOM_PROTO_TLS ||
Florin Coras4b47ee22020-11-19 13:38:26 -0800562 s->session_type == VPPCOM_PROTO_QUIC ||
563 s->session_type == VPPCOM_PROTO_DTLS);
Florin Corasa5a9efd2021-01-05 17:03:29 -0800564}
565
566static inline u8
Florin Corasc127d5a2020-10-14 16:35:58 -0700567vcl_session_is_ready (vcl_session_t * s)
568{
Florin Corasdfffdd72020-10-15 10:54:47 -0700569 return (s->session_state == VCL_STATE_READY
Florin Corasc127d5a2020-10-14 16:35:58 -0700570 || s->session_state == VCL_STATE_VPP_CLOSING);
571}
572
573static inline u8
Florin Coras6d0106e2019-01-29 20:11:58 -0800574vcl_session_is_open (vcl_session_t * s)
575{
Florin Corasc127d5a2020-10-14 16:35:58 -0700576 return ((vcl_session_is_ready (s))
Florin Coras1bc919e2020-10-18 20:17:49 -0700577 || (s->session_state == VCL_STATE_LISTEN && vcl_session_is_cl (s)));
Florin Coras6d0106e2019-01-29 20:11:58 -0800578}
579
580static inline u8
581vcl_session_is_closing (vcl_session_t * s)
582{
Florin Corasc127d5a2020-10-14 16:35:58 -0700583 return (s->session_state == VCL_STATE_VPP_CLOSING
584 || s->session_state == VCL_STATE_DISCONNECT);
Florin Coras6d0106e2019-01-29 20:11:58 -0800585}
586
Florin Coras080aa502020-05-26 00:47:52 +0000587static inline u8
588vcl_session_is_closed (vcl_session_t * s)
589{
Florin Corasc127d5a2020-10-14 16:35:58 -0700590 return (!s || (s->session_state == VCL_STATE_CLOSED));
Florin Coras080aa502020-05-26 00:47:52 +0000591}
592
Florin Coras6d0106e2019-01-29 20:11:58 -0800593static inline int
594vcl_session_closing_error (vcl_session_t * s)
595{
Florin Coras067f9542020-02-14 05:33:46 +0000596 /* Return 0 on closing sockets */
Florin Corasc127d5a2020-10-14 16:35:58 -0700597 return s->session_state == VCL_STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
Florin Coras6d0106e2019-01-29 20:11:58 -0800598}
599
600static inline int
601vcl_session_closed_error (vcl_session_t * s)
602{
Florin Corasc127d5a2020-10-14 16:35:58 -0700603 return s->session_state == VCL_STATE_DISCONNECT
Florin Coras6d0106e2019-01-29 20:11:58 -0800604 ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
605}
606
Florin Coras5da10c42020-04-01 04:31:21 +0000607static inline void
608vcl_ip_copy_from_ep (ip46_address_t * ip, vppcom_endpt_t * ep)
609{
610 if (ep->is_ip4)
611 clib_memcpy_fast (&ip->ip4, ep->ip, sizeof (ip4_address_t));
612 else
613 clib_memcpy_fast (&ip->ip6, ep->ip, sizeof (ip6_address_t));
614}
615
616static inline void
617vcl_ip_copy_to_ep (ip46_address_t * ip, vppcom_endpt_t * ep, u8 is_ip4)
618{
619 ep->is_ip4 = is_ip4;
620 if (is_ip4)
621 clib_memcpy_fast (ep->ip, &ip->ip4, sizeof (ip4_address_t));
622 else
623 clib_memcpy_fast (ep->ip, &ip->ip6, sizeof (ip6_address_t));
624}
625
Florin Coras66ec4672020-06-15 07:59:40 -0700626static inline int
627vcl_proto_is_dgram (uint8_t proto)
628{
Florin Coras6621abf2021-01-06 17:35:17 -0800629 return proto == VPPCOM_PROTO_UDP || proto == VPPCOM_PROTO_DTLS ||
630 proto == VPPCOM_PROTO_SRTP;
Florin Coras66ec4672020-06-15 07:59:40 -0700631}
632
Florin Corasac422d62020-10-19 20:51:36 -0700633static inline u8
634vcl_session_has_attr (vcl_session_t * s, u8 attr)
635{
636 return (s->attributes & (1 << attr)) ? 1 : 0;
637}
638
639static inline void
640vcl_session_set_attr (vcl_session_t * s, u8 attr)
641{
642 s->attributes |= 1 << attr;
643}
644
645static inline void
646vcl_session_clear_attr (vcl_session_t * s, u8 attr)
647{
648 s->attributes &= ~(1 << attr);
649}
650
Florin Coras697faea2018-06-27 17:10:49 -0700651/*
Florin Coras99368312018-08-02 10:45:44 -0700652 * Helpers
653 */
Florin Coras134a9962018-08-28 11:32:04 -0700654vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
655u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
656vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
657int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
658int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
659
660vcl_worker_t *vcl_worker_alloc_and_init (void);
Florin Coras01f3f892018-12-02 12:45:53 -0800661void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
Florin Coras47c40e22018-11-26 17:01:36 -0800662int vcl_worker_register_with_vpp (void);
Florin Coras458089b2019-08-21 16:20:44 -0700663svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
Florin Corasf9240dc2019-01-15 08:03:17 -0800664
665void vcl_flush_mq_events (void);
Florin Corasf9240dc2019-01-15 08:03:17 -0800666int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
667 vcl_session_handle_t sh, u8 do_disconnect);
Florin Coras134a9962018-08-28 11:32:04 -0700668
Florin Corasd85de682018-11-29 17:02:29 -0800669void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
670u32 vcl_segment_table_lookup (u64 segment_handle);
671void vcl_segment_table_del (u64 segment_handle);
672
Florin Coras0ef8ef22019-01-18 08:37:13 -0800673int vcl_session_read_ready (vcl_session_t * session);
674int vcl_session_write_ready (vcl_session_t * session);
Florin Corasa54b62d2021-04-21 09:05:56 -0700675int vcl_session_alloc_ext_cfg (vcl_session_t *s,
Florin Coras87f63892021-05-01 16:01:40 -0700676 transport_endpt_ext_cfg_type_t type, u32 len);
Florin Coras0ef8ef22019-01-18 08:37:13 -0800677
Florin Coras134a9962018-08-28 11:32:04 -0700678static inline vcl_worker_t *
679vcl_worker_get (u32 wrk_index)
680{
681 return pool_elt_at_index (vcm->workers, wrk_index);
682}
683
684static inline vcl_worker_t *
Florin Coras01f3f892018-12-02 12:45:53 -0800685vcl_worker_get_if_valid (u32 wrk_index)
686{
687 if (pool_is_free_index (vcm->workers, wrk_index))
688 return 0;
689 return pool_elt_at_index (vcm->workers, wrk_index);
690}
691
692static inline vcl_worker_t *
Florin Coras134a9962018-08-28 11:32:04 -0700693vcl_worker_get_current (void)
694{
695 return vcl_worker_get (vcl_get_worker_index ());
696}
Florin Coras99368312018-08-02 10:45:44 -0700697
Florin Coras2d675d72019-01-28 15:54:27 -0800698static inline u8
699vcl_n_workers (void)
700{
701 return pool_elts (vcm->workers);
702}
703
Florin Coras935ce752020-09-08 22:43:47 -0700704static inline u64
705vcl_vpp_worker_segment_handle (u32 wrk_index)
706{
707 return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
708}
709
Florin Coras30e79c22019-01-02 19:31:22 -0800710void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
711 u32 wrk_index);
hanlina3a48962020-07-13 11:09:15 +0800712int vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len);
Florin Coras40c07ce2020-07-16 20:46:17 -0700713
Florin Corasc4c4cf52019-08-24 18:17:34 -0700714int vcl_segment_attach (u64 segment_handle, char *name,
715 ssvm_segment_type_t type, int fd);
716void vcl_segment_detach (u64 segment_handle);
Florin Corasb88de902020-09-08 16:47:57 -0700717void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
Florin Corasc4c4cf52019-08-24 18:17:34 -0700718
Florin Corasc547e912020-12-08 17:50:45 -0800719int vcl_segment_attach_session (uword segment_handle, uword rxf_offset,
Florin Corasf6e284b2021-07-21 18:17:20 -0700720 uword txf_offset, uword mq_offset,
721 u32 mq_index, u8 is_ct, vcl_session_t *s);
Florin Corasb4624182020-12-11 13:58:12 -0800722int vcl_segment_attach_mq (uword segment_handle, uword mq_offset, u32 mq_index,
723 svm_msg_q_t **mq);
Florin Coras80b74252021-01-27 18:08:25 -0800724int vcl_segment_discover_mqs (uword segment_handle, int *fds, u32 n_fds);
Florin Coras4ac25842021-04-19 17:34:54 -0700725svm_fifo_chunk_t *vcl_segment_alloc_chunk (uword segment_handle,
726 u32 slice_index, u32 size,
727 uword *offset);
Florin Coras8eb8d502021-06-16 14:46:57 -0700728int vcl_session_share_fifos (vcl_session_t *s, svm_fifo_t *rxf,
729 svm_fifo_t *txf);
Florin Corasc547e912020-12-08 17:50:45 -0800730
Florin Corasb88de902020-09-08 16:47:57 -0700731/*
732 * VCL Binary API
733 */
734int vcl_bapi_attach (void);
735int vcl_bapi_app_worker_add (void);
736void vcl_bapi_app_worker_del (vcl_worker_t * wrk);
737void vcl_bapi_disconnect_from_vpp (void);
Florin Coras935ce752020-09-08 22:43:47 -0700738int vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
Florin Corasa5a9efd2021-01-05 17:03:29 -0800739int vcl_bapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
740int vcl_bapi_del_cert_key_pair (u32 ckpair_index);
Florin Corasb88de902020-09-08 16:47:57 -0700741u32 vcl_bapi_max_nsid_len (void);
742int vcl_bapi_worker_set (void);
Florin Coras697faea2018-06-27 17:10:49 -0700743
Florin Coras935ce752020-09-08 22:43:47 -0700744/*
745 * VCL Socket API
746 */
747int vcl_sapi_attach (void);
748int vcl_sapi_app_worker_add (void);
749void vcl_sapi_app_worker_del (vcl_worker_t * wrk);
750void vcl_sapi_detach (vcl_worker_t * wrk);
751int vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
Florin Corase191d762021-08-11 14:55:49 -0700752int vcl_sapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
753int vcl_sapi_del_cert_key_pair (u32 ckpair_index);
Florin Coras935ce752020-09-08 22:43:47 -0700754
Florin Coras60687192021-11-29 21:00:47 -0800755/*
756 * Utility functions
757 */
758const char *vcl_session_state_str (vcl_session_state_t state);
759u8 *vcl_format_ip4_address (u8 *s, va_list *args);
760u8 *vcl_format_ip6_address (u8 *s, va_list *args);
761u8 *vcl_format_ip46_address (u8 *s, va_list *args);
762
Florin Coras697faea2018-06-27 17:10:49 -0700763#endif /* SRC_VCL_VCL_PRIVATE_H_ */
764
765/*
766 * fd.io coding-style-patch-verification: ON
767 *
768 * Local Variables:
769 * eval: (c-set-style "gnu")
770 * End:
771 */