blob: f163de201252b288df9f6e893eb9c397e8039725 [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 Corasf0fe1ea2021-12-03 17:03:37 -0800142 VCL_SESSION_F_PENDING_DISCONNECT = 1 << 6,
143 VCL_SESSION_F_PENDING_FREE = 1 << 7,
Florin Coras0a1e1832020-03-29 18:54:04 +0000144} __clib_packed vcl_session_flags_t;
145
Florin Corasac422d62020-10-19 20:51:36 -0700146typedef struct vcl_session_
Florin Coras697faea2018-06-27 17:10:49 -0700147{
Florin Coras2cba8532018-09-11 16:33:36 -0700148 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Florin Corasac422d62020-10-19 20:51:36 -0700149
Florin Coras697faea2018-06-27 17:10:49 -0700150#define _(type, name) type name;
151 foreach_app_session_field
152#undef _
Florin Corasac422d62020-10-19 20:51:36 -0700153 vcl_session_flags_t flags; /**< see @ref vcl_session_flags_t */
154 u32 rx_bytes_pending; /**< bytes rx-ed as segs but not yet freed */
Florin Coras697faea2018-06-27 17:10:49 -0700155
Florin Coras653e43f2019-03-04 10:56:23 -0800156 svm_fifo_t *ct_rx_fifo;
157 svm_fifo_t *ct_tx_fifo;
Florin Coras54693d22018-07-17 10:46:29 -0700158 vcl_session_msg_t *accept_evts_fifo;
Florin Corasac422d62020-10-19 20:51:36 -0700159
160 u64 vpp_handle;
Florin Corasa5a9efd2021-01-05 17:03:29 -0800161 u64 parent_handle;
Florin Corasac422d62020-10-19 20:51:36 -0700162 u32 listener_index; /**< index of parent listener (if any) */
163 int n_accepted_sessions; /**< sessions accepted by this listener */
Florin Corasac422d62020-10-19 20:51:36 -0700164 vppcom_epoll_t vep;
Florin Corasa5a9efd2021-01-05 17:03:29 -0800165 u32 attributes; /**< see @ref vppcom_session_attr_t */
166 int libc_epfd;
Florin Coras6a6555a2021-01-28 11:39:27 -0800167 u32 vrf;
Florin Corasac422d62020-10-19 20:51:36 -0700168
169 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
170 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
Florin Corasac422d62020-10-19 20:51:36 -0700171
Florin Coras4ac25842021-04-19 17:34:54 -0700172 transport_endpt_ext_cfg_t *ext_config;
Filip Tehlar2f09bfc2021-11-15 10:26:56 +0000173 u8 dscp;
Florin Coras4ac25842021-04-19 17:34:54 -0700174
Florin Coras697faea2018-06-27 17:10:49 -0700175#if VCL_ELOG
176 elog_track_t elog_track;
177#endif
178} vcl_session_t;
179
180typedef struct vppcom_cfg_t_
181{
David Johnsond9818dd2018-12-14 14:53:41 -0500182 uword heapsize;
Florin Coras134a9962018-08-28 11:32:04 -0700183 u32 max_workers;
David Johnsond9818dd2018-12-14 14:53:41 -0500184 uword segment_baseva;
Florin Corasd18528f2020-03-27 18:41:54 +0000185 uword segment_size;
186 uword add_segment_size;
Florin Coras697faea2018-06-27 17:10:49 -0700187 u32 preallocated_fifo_pairs;
188 u32 rx_fifo_size;
189 u32 tx_fifo_size;
190 u32 event_queue_size;
Florin Coras697faea2018-06-27 17:10:49 -0700191 u8 app_proxy_transport_tcp;
192 u8 app_proxy_transport_udp;
193 u8 app_scope_local;
194 u8 app_scope_global;
195 u8 *namespace_id;
196 u64 namespace_secret;
Florin Coras99368312018-08-02 10:45:44 -0700197 u8 use_mq_eventfd;
Florin Coras697faea2018-06-27 17:10:49 -0700198 f64 app_timeout;
199 f64 session_timeout;
Florin Coras697faea2018-06-27 17:10:49 -0700200 char *event_log_path;
Florin Coras935ce752020-09-08 22:43:47 -0700201 u8 *vpp_app_socket_api; /**< app socket api socket file name */
Florin Corasb88de902020-09-08 16:47:57 -0700202 u8 *vpp_bapi_socket_name; /**< bapi socket transport socket name */
Florin Corasd747c3c2019-10-20 19:55:56 -0700203 u32 tls_engine;
Florin Corasff40d8f2020-08-11 22:05:28 -0700204 u8 mt_wrk_supported;
Florin Coras697faea2018-06-27 17:10:49 -0700205} vppcom_cfg_t;
206
207void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
208
Florin Coras54693d22018-07-17 10:46:29 -0700209typedef struct vcl_cut_through_registration_
210{
211 svm_msg_q_t *mq;
Florin Coras99368312018-08-02 10:45:44 -0700212 svm_msg_q_t *peer_mq;
Florin Coras54693d22018-07-17 10:46:29 -0700213 u32 sid;
Florin Coras99368312018-08-02 10:45:44 -0700214 u32 epoll_evt_conn_index; /*< mq evt connection index part of
215 the mqs evtfd epoll (if used) */
Florin Coras54693d22018-07-17 10:46:29 -0700216} vcl_cut_through_registration_t;
217
Florin Coras99368312018-08-02 10:45:44 -0700218typedef struct vcl_mq_evt_conn_
219{
220 svm_msg_q_t *mq;
221 int mq_fd;
222} vcl_mq_evt_conn_t;
223
Florin Coras134a9962018-08-28 11:32:04 -0700224typedef struct vcl_worker_
Florin Coras697faea2018-06-27 17:10:49 -0700225{
Florin Coras134a9962018-08-28 11:32:04 -0700226 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Florin Coras697faea2018-06-27 17:10:49 -0700227
Florin Coras697faea2018-06-27 17:10:49 -0700228 /* Session pool */
Florin Coras697faea2018-06-27 17:10:49 -0700229 vcl_session_t *sessions;
230
Florin Coras053a0e42018-11-13 15:52:38 -0800231 /** Worker/thread index in current process */
Florin Coras134a9962018-08-28 11:32:04 -0700232 u32 wrk_index;
233
Florin Coras053a0e42018-11-13 15:52:38 -0800234 /** Worker index in vpp*/
235 u32 vpp_wrk_index;
236
Florin Corascc7c88e2020-09-15 15:56:51 -0700237 /**
238 * Generic api client handle. When binary api is in used, it stores
239 * the "client_index" and when socket api is use, it stores the sapi
240 * client handle */
241 u32 api_client_handle;
Florin Coras47c40e22018-11-26 17:01:36 -0800242
243 /** VPP binary api input queue */
244 svm_queue_t *vl_input_queue;
245
Florin Coras458089b2019-08-21 16:20:44 -0700246 /** VPP mq to be used for exchanging control messages */
247 svm_msg_q_t *ctrl_mq;
248
Florin Coras99368312018-08-02 10:45:44 -0700249 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
250 int mqs_epfd;
251
252 /** Pool of event message queue event connections */
253 vcl_mq_evt_conn_t *mq_evt_conns;
254
255 /** Per worker buffer for receiving mq epoll events */
256 struct epoll_event *mq_events;
257
Florin Corasfa3884f2021-06-22 20:04:46 -0700258 /** Next session to be lt polled */
259 u32 ep_lt_current;
Florin Corasfe286f72021-06-04 10:07:55 -0700260
Florin Coras134a9962018-08-28 11:32:04 -0700261 /** Hash table for disconnect processing */
Florin Coras697faea2018-06-27 17:10:49 -0700262 uword *session_index_by_vpp_handles;
263
Florin Coras134a9962018-08-28 11:32:04 -0700264 /** Select bitmaps */
Florin Coras697faea2018-06-27 17:10:49 -0700265 clib_bitmap_t *rd_bitmap;
266 clib_bitmap_t *wr_bitmap;
267 clib_bitmap_t *ex_bitmap;
268
Florin Coras134a9962018-08-28 11:32:04 -0700269 /** Our event message queue */
Florin Coras3c2fed52018-07-04 04:15:05 -0700270 svm_msg_q_t *app_event_queue;
Florin Coras697faea2018-06-27 17:10:49 -0700271
Florin Coras134a9962018-08-28 11:32:04 -0700272 /** For deadman timers */
Florin Coras697faea2018-06-27 17:10:49 -0700273 clib_time_t clib_time;
274
Florin Coras134a9962018-08-28 11:32:04 -0700275 /** Vector acting as buffer for mq messages */
Florin Coras99368312018-08-02 10:45:44 -0700276 svm_msg_q_msg_t *mq_msg_vector;
Florin Coras3348a4c2018-09-07 17:09:35 -0700277
Florin Coras86f04502018-09-12 16:08:01 -0700278 /** Vector of unhandled events */
279 session_event_t *unhandled_evts_vector;
280
Florin Coras30e79c22019-01-02 19:31:22 -0800281 u32 *pending_session_wrk_updates;
282
Florin Coras3348a4c2018-09-07 17:09:35 -0700283 /** Used also as a thread stop key buffer */
284 pthread_t thread_id;
Florin Coras47c40e22018-11-26 17:01:36 -0800285
286 /** Current pid, may be different from main_pid if forked child */
287 pid_t current_pid;
Florin Coras01f3f892018-12-02 12:45:53 -0800288
289 u32 forked_child;
290
Florin Coras935ce752020-09-08 22:43:47 -0700291 clib_socket_t app_api_sock;
Florin Corasd4c70922019-11-28 14:21:21 -0800292 socket_client_main_t bapi_sock_ctx;
Florin Corasd4c70922019-11-28 14:21:21 -0800293 api_main_t bapi_api_ctx;
Florin Corasfda21c92021-04-07 17:03:01 -0700294 memory_client_main_t bapi_mem_ctx;
hanlina3a48962020-07-13 11:09:15 +0800295
Florin Coras3b6c84c2021-01-05 20:45:44 -0800296 /* State of the connection, shared between msg RX thread and main thread */
297 volatile vcl_bapi_app_state_t bapi_app_state;
Florin Corasa5a9efd2021-01-05 17:03:29 -0800298 volatile uword bapi_return;
Florin Coras3b6c84c2021-01-05 20:45:44 -0800299
Florin Coras04ae8272021-04-12 19:55:37 -0700300 u8 session_attr_op;
301 int session_attr_op_rv;
302 transport_endpt_attr_t session_attr_rv;
303
hanlina3a48962020-07-13 11:09:15 +0800304 /** vcl needs next epoll_create to go to libc_epoll */
305 u8 vcl_needs_real_epoll;
306 volatile int rpc_done;
Florin Coras134a9962018-08-28 11:32:04 -0700307} vcl_worker_t;
308
Florin Corasb242d312020-10-26 15:35:40 -0700309STATIC_ASSERT (sizeof (session_disconnected_msg_t) <= 16,
310 "disconnected must fit in session_event_t");
311STATIC_ASSERT (sizeof (session_reset_msg_t) <= 16,
312 "disconnected must fit in session_event_t");
313
Florin Coras40c07ce2020-07-16 20:46:17 -0700314typedef void (vcl_rpc_fn_t) (void *args);
315
Florin Coras134a9962018-08-28 11:32:04 -0700316typedef struct vppcom_main_t_
317{
318 u8 is_init;
319 u32 debug;
320 pthread_t main_cpu;
321
Florin Coras053a0e42018-11-13 15:52:38 -0800322 /** Main process pid */
323 pid_t main_pid;
324
Florin Corasc1f5a432018-11-20 11:31:26 -0800325 /** App's index in vpp. It's used by vpp to identify the app */
326 u32 app_index;
Florin Coras134a9962018-08-28 11:32:04 -0700327
Florin Coras053a0e42018-11-13 15:52:38 -0800328 u8 *app_name;
329
Florin Coras134a9962018-08-28 11:32:04 -0700330 /** VCL configuration */
331 vppcom_cfg_t cfg;
Florin Coras99368312018-08-02 10:45:44 -0700332
Florin Coras47c40e22018-11-26 17:01:36 -0800333 volatile u32 forking;
334
Florin Coras134a9962018-08-28 11:32:04 -0700335 /** Workers */
336 vcl_worker_t *workers;
337
Florin Corasde9f08b2018-09-07 14:32:58 -0700338 /** Lock to protect worker registrations */
339 clib_spinlock_t workers_lock;
340
Florin Corasd85de682018-11-29 17:02:29 -0800341 /** Lock to protect segment hash table */
342 clib_rwlock_t segment_table_lock;
343
344 /** Mapped segments table */
345 uword *segment_table;
346
Florin Coras22ba3302019-08-29 22:45:04 -0700347 /** Control mq obtained from attach */
348 svm_msg_q_t *ctrl_mq;
349
Florin Coras88001c62019-04-24 14:44:46 -0700350 fifo_segment_main_t segment_main;
Florin Corasadc74d72018-12-02 13:36:00 -0800351
Florin Corasb88de902020-09-08 16:47:57 -0700352 vcl_rpc_fn_t *wrk_rpc_fn;
353
354 /*
355 * Binary api context
356 */
357
Florin Corasb88de902020-09-08 16:47:57 -0700358 /* VNET_API_ERROR_FOO -> "Foo" hash table */
359 uword *error_string_by_error_number;
360
Florin Coras697faea2018-06-27 17:10:49 -0700361#ifdef VCL_ELOG
362 /* VPP Event-logger */
363 elog_main_t elog_main;
364 elog_track_t elog_track;
365#endif
366
Florin Coras697faea2018-06-27 17:10:49 -0700367} vppcom_main_t;
368
369extern vppcom_main_t *vcm;
Florin Corasce815de2020-04-16 18:47:27 +0000370extern vppcom_main_t _vppcom_main;
Florin Coras697faea2018-06-27 17:10:49 -0700371
Florin Coras54693d22018-07-17 10:46:29 -0700372#define VCL_INVALID_SESSION_INDEX ((u32)~0)
Nathan Skrzypczakcef02be2019-07-17 10:20:45 +0200373#define VCL_INVALID_SESSION_HANDLE ((u64)~0)
Florin Corasd85de682018-11-29 17:02:29 -0800374#define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
375#define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
Florin Coras54693d22018-07-17 10:46:29 -0700376
Florin Corascbb5e822021-02-20 10:42:22 -0800377void vcl_session_detach_fifos (vcl_session_t *s);
378
Florin Coras54693d22018-07-17 10:46:29 -0700379static inline vcl_session_t *
Florin Coras134a9962018-08-28 11:32:04 -0700380vcl_session_alloc (vcl_worker_t * wrk)
Florin Coras99368312018-08-02 10:45:44 -0700381{
382 vcl_session_t *s;
Florin Coras134a9962018-08-28 11:32:04 -0700383 pool_get (wrk->sessions, s);
Florin Coras99368312018-08-02 10:45:44 -0700384 memset (s, 0, sizeof (*s));
Florin Coras134a9962018-08-28 11:32:04 -0700385 s->session_index = s - wrk->sessions;
Nathan Skrzypczak9fd99622019-05-16 14:38:44 +0200386 s->listener_index = VCL_INVALID_SESSION_INDEX;
Florin Coras99368312018-08-02 10:45:44 -0700387 return s;
388}
389
390static inline void
Florin Coras134a9962018-08-28 11:32:04 -0700391vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
Florin Coras99368312018-08-02 10:45:44 -0700392{
Florin Coras243edd52020-03-04 22:20:12 +0000393 /* Debug level set to 1 to avoid debug messages while ldp is cleaning up */
394 VDBG (1, "session %u [0x%llx] removed", s->session_index, s->vpp_handle);
Florin Corascbb5e822021-02-20 10:42:22 -0800395 vcl_session_detach_fifos (s);
Florin Corasa54b62d2021-04-21 09:05:56 -0700396 if (s->ext_config)
397 clib_mem_free (s->ext_config);
Florin Coras134a9962018-08-28 11:32:04 -0700398 pool_put (wrk->sessions, s);
Florin Coras99368312018-08-02 10:45:44 -0700399}
400
401static inline vcl_session_t *
Florin Coras134a9962018-08-28 11:32:04 -0700402vcl_session_get (vcl_worker_t * wrk, u32 session_index)
Florin Coras54693d22018-07-17 10:46:29 -0700403{
Florin Coras134a9962018-08-28 11:32:04 -0700404 if (pool_is_free_index (wrk->sessions, session_index))
Florin Coras54693d22018-07-17 10:46:29 -0700405 return 0;
Florin Coras134a9962018-08-28 11:32:04 -0700406 return pool_elt_at_index (wrk->sessions, session_index);
Florin Coras54693d22018-07-17 10:46:29 -0700407}
408
Florin Corasf9240dc2019-01-15 08:03:17 -0800409static inline vcl_session_handle_t
hanlinf8e13632020-08-21 11:05:36 +0800410vcl_session_handle_from_wrk_session_index (u32 session_index, u32 wrk_index)
411{
412 ASSERT (session_index < 2 << 24);
413 return (wrk_index << 24 | session_index);
414}
415
416static inline vcl_session_handle_t
Florin Corasf9240dc2019-01-15 08:03:17 -0800417vcl_session_handle_from_index (u32 session_index)
418{
419 ASSERT (session_index < 2 << 24);
420 return (vcl_get_worker_index () << 24 | session_index);
421}
422
423static inline vcl_session_handle_t
Florin Coras134a9962018-08-28 11:32:04 -0700424vcl_session_handle (vcl_session_t * s)
Florin Coras54693d22018-07-17 10:46:29 -0700425{
Florin Corasf9240dc2019-01-15 08:03:17 -0800426 return vcl_session_handle_from_index (s->session_index);
Florin Coras134a9962018-08-28 11:32:04 -0700427}
428
429static inline void
430vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
431{
432 *wrk_index = handle >> 24;
433 *session_index = handle & 0xFFFFFF;
Florin Coras54693d22018-07-17 10:46:29 -0700434}
435
436static inline vcl_session_t *
Florin Coras134a9962018-08-28 11:32:04 -0700437vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
438{
439 u32 session_index, wrk_index;
440 vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
441 ASSERT (wrk_index == wrk->wrk_index);
442 return vcl_session_get (wrk, session_index);
443}
444
445static inline vcl_session_t *
446vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
Florin Coras54693d22018-07-17 10:46:29 -0700447{
448 uword *p;
Florin Coras134a9962018-08-28 11:32:04 -0700449 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
450 return vcl_session_get (wrk, (u32) p[0]);
Florin Coras54693d22018-07-17 10:46:29 -0700451 return 0;
452}
453
454static inline u32
Florin Coras134a9962018-08-28 11:32:04 -0700455vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
Florin Coras54693d22018-07-17 10:46:29 -0700456{
457 uword *p;
Florin Coras134a9962018-08-28 11:32:04 -0700458 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
Florin Coras54693d22018-07-17 10:46:29 -0700459 return p[0];
460 return VCL_INVALID_SESSION_INDEX;
461}
462
Florin Coras134a9962018-08-28 11:32:04 -0700463static inline void
464vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
465{
466 hash_set (wrk->session_index_by_vpp_handles, handle, value);
467}
468
469static inline void
470vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
471{
472 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
473}
474
475static inline uword *
476vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
477{
478 return hash_get (wrk->session_index_by_vpp_handles, handle);
479}
480
481static inline void
482vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
483 u32 value)
484{
Florin Coras134a9962018-08-28 11:32:04 -0700485 hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
486}
487
488static inline void
489vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
490{
Florin Coras134a9962018-08-28 11:32:04 -0700491 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
492}
493
Nathan Skrzypczak9fd99622019-05-16 14:38:44 +0200494static inline int
495vcl_session_is_connectable_listener (vcl_worker_t * wrk,
496 vcl_session_t * session)
497{
498 /* Tell if we session_handle is a QUIC session.
499 * We can be in the following cases :
500 * Listen session <- QUIC session <- Stream session
501 * QUIC session <- Stream session
502 */
503 vcl_session_t *ls;
504 if (session->session_type != VPPCOM_PROTO_QUIC)
505 return 0;
506 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
Florin Corasc127d5a2020-10-14 16:35:58 -0700507 return !(session->session_state == VCL_STATE_LISTEN);
Nathan Skrzypczak9fd99622019-05-16 14:38:44 +0200508 ls = vcl_session_get_w_handle (wrk, session->listener_index);
509 if (!ls)
510 return VPPCOM_EBADFD;
Florin Corasc127d5a2020-10-14 16:35:58 -0700511 return ls->session_state == VCL_STATE_LISTEN;
Nathan Skrzypczak9fd99622019-05-16 14:38:44 +0200512}
513
Florin Coras134a9962018-08-28 11:32:04 -0700514static inline vcl_session_t *
Florin Corasdfae9f92019-02-20 19:48:31 -0800515vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
Florin Coras134a9962018-08-28 11:32:04 -0700516{
517 uword *p;
Florin Corasc127d5a2020-10-14 16:35:58 -0700518 vcl_session_t *s;
Florin Coras134a9962018-08-28 11:32:04 -0700519
520 p = hash_get (wrk->session_index_by_vpp_handles, handle);
521 if (!p)
522 {
Florin Corasdfae9f92019-02-20 19:48:31 -0800523 VDBG (0, "could not find listen session: unknown vpp listener handle"
524 " %llx", handle);
Florin Coras134a9962018-08-28 11:32:04 -0700525 return 0;
526 }
Florin Corasc127d5a2020-10-14 16:35:58 -0700527 s = vcl_session_get (wrk, p[0]);
528 if (!s)
Florin Coras134a9962018-08-28 11:32:04 -0700529 {
Florin Corasdfae9f92019-02-20 19:48:31 -0800530 VDBG (1, "invalid listen session index (%u)", p[0]);
Florin Coras134a9962018-08-28 11:32:04 -0700531 return 0;
532 }
533
liuyacan4fca7442021-05-14 02:11:03 +0000534 if (s->session_state == VCL_STATE_DISCONNECT)
535 {
536 VDBG (0, "listen session [0x%llx] is closing", s->vpp_handle);
537 return 0;
538 }
539
Florin Corasc127d5a2020-10-14 16:35:58 -0700540 ASSERT (s->session_state == VCL_STATE_LISTEN
541 || s->session_state == VCL_STATE_LISTEN_NO_MQ
542 || vcl_session_is_connectable_listener (wrk, s));
543 return s;
Florin Coras134a9962018-08-28 11:32:04 -0700544}
545
Florin Coras460dce62018-07-27 05:45:06 -0700546static inline u8
547vcl_session_is_ct (vcl_session_t * s)
548{
Florin Coras653e43f2019-03-04 10:56:23 -0800549 return (s->ct_tx_fifo != 0);
Florin Coras460dce62018-07-27 05:45:06 -0700550}
551
Florin Coras6d0106e2019-01-29 20:11:58 -0800552static inline u8
Florin Coras6e3c1f82020-01-15 01:30:46 +0000553vcl_session_is_cl (vcl_session_t * s)
554{
555 if (s->session_type == VPPCOM_PROTO_UDP)
Florin Corasa4dac8a2020-05-25 18:17:03 +0000556 return !(s->flags & VCL_SESSION_F_CONNECTED);
Florin Coras6e3c1f82020-01-15 01:30:46 +0000557 return 0;
558}
559
560static inline u8
Florin Corasa5a9efd2021-01-05 17:03:29 -0800561vcl_session_has_crypto (vcl_session_t *s)
562{
563 return (s->session_type == VPPCOM_PROTO_TLS ||
Florin Coras4b47ee22020-11-19 13:38:26 -0800564 s->session_type == VPPCOM_PROTO_QUIC ||
565 s->session_type == VPPCOM_PROTO_DTLS);
Florin Corasa5a9efd2021-01-05 17:03:29 -0800566}
567
568static inline u8
Florin Corasc127d5a2020-10-14 16:35:58 -0700569vcl_session_is_ready (vcl_session_t * s)
570{
Florin Corasdfffdd72020-10-15 10:54:47 -0700571 return (s->session_state == VCL_STATE_READY
Florin Corasc127d5a2020-10-14 16:35:58 -0700572 || s->session_state == VCL_STATE_VPP_CLOSING);
573}
574
575static inline u8
Florin Coras6d0106e2019-01-29 20:11:58 -0800576vcl_session_is_open (vcl_session_t * s)
577{
Florin Corasc127d5a2020-10-14 16:35:58 -0700578 return ((vcl_session_is_ready (s))
Florin Coras1bc919e2020-10-18 20:17:49 -0700579 || (s->session_state == VCL_STATE_LISTEN && vcl_session_is_cl (s)));
Florin Coras6d0106e2019-01-29 20:11:58 -0800580}
581
582static inline u8
583vcl_session_is_closing (vcl_session_t * s)
584{
Florin Corasc127d5a2020-10-14 16:35:58 -0700585 return (s->session_state == VCL_STATE_VPP_CLOSING
586 || s->session_state == VCL_STATE_DISCONNECT);
Florin Coras6d0106e2019-01-29 20:11:58 -0800587}
588
Florin Coras080aa502020-05-26 00:47:52 +0000589static inline u8
590vcl_session_is_closed (vcl_session_t * s)
591{
Florin Corasc127d5a2020-10-14 16:35:58 -0700592 return (!s || (s->session_state == VCL_STATE_CLOSED));
Florin Coras080aa502020-05-26 00:47:52 +0000593}
594
Florin Coras6d0106e2019-01-29 20:11:58 -0800595static inline int
596vcl_session_closing_error (vcl_session_t * s)
597{
Florin Coras067f9542020-02-14 05:33:46 +0000598 /* Return 0 on closing sockets */
Florin Corasc127d5a2020-10-14 16:35:58 -0700599 return s->session_state == VCL_STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
Florin Coras6d0106e2019-01-29 20:11:58 -0800600}
601
602static inline int
603vcl_session_closed_error (vcl_session_t * s)
604{
Florin Corasc127d5a2020-10-14 16:35:58 -0700605 return s->session_state == VCL_STATE_DISCONNECT
Florin Coras6d0106e2019-01-29 20:11:58 -0800606 ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
607}
608
Florin Coras5da10c42020-04-01 04:31:21 +0000609static inline void
610vcl_ip_copy_from_ep (ip46_address_t * ip, vppcom_endpt_t * ep)
611{
612 if (ep->is_ip4)
613 clib_memcpy_fast (&ip->ip4, ep->ip, sizeof (ip4_address_t));
614 else
615 clib_memcpy_fast (&ip->ip6, ep->ip, sizeof (ip6_address_t));
616}
617
618static inline void
619vcl_ip_copy_to_ep (ip46_address_t * ip, vppcom_endpt_t * ep, u8 is_ip4)
620{
621 ep->is_ip4 = is_ip4;
622 if (is_ip4)
623 clib_memcpy_fast (ep->ip, &ip->ip4, sizeof (ip4_address_t));
624 else
625 clib_memcpy_fast (ep->ip, &ip->ip6, sizeof (ip6_address_t));
626}
627
Florin Coras66ec4672020-06-15 07:59:40 -0700628static inline int
629vcl_proto_is_dgram (uint8_t proto)
630{
Florin Coras6621abf2021-01-06 17:35:17 -0800631 return proto == VPPCOM_PROTO_UDP || proto == VPPCOM_PROTO_DTLS ||
632 proto == VPPCOM_PROTO_SRTP;
Florin Coras66ec4672020-06-15 07:59:40 -0700633}
634
Florin Corasac422d62020-10-19 20:51:36 -0700635static inline u8
636vcl_session_has_attr (vcl_session_t * s, u8 attr)
637{
638 return (s->attributes & (1 << attr)) ? 1 : 0;
639}
640
641static inline void
642vcl_session_set_attr (vcl_session_t * s, u8 attr)
643{
644 s->attributes |= 1 << attr;
645}
646
647static inline void
648vcl_session_clear_attr (vcl_session_t * s, u8 attr)
649{
650 s->attributes &= ~(1 << attr);
651}
652
Florin Coras697faea2018-06-27 17:10:49 -0700653/*
Florin Coras99368312018-08-02 10:45:44 -0700654 * Helpers
655 */
Florin Coras134a9962018-08-28 11:32:04 -0700656vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
657u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
658vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
659int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
660int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
661
662vcl_worker_t *vcl_worker_alloc_and_init (void);
Florin Coras01f3f892018-12-02 12:45:53 -0800663void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
Florin Coras47c40e22018-11-26 17:01:36 -0800664int vcl_worker_register_with_vpp (void);
Florin Coras458089b2019-08-21 16:20:44 -0700665svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
Florin Corasf9240dc2019-01-15 08:03:17 -0800666
667void vcl_flush_mq_events (void);
Florin Corasf9240dc2019-01-15 08:03:17 -0800668int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
669 vcl_session_handle_t sh, u8 do_disconnect);
Florin Coras134a9962018-08-28 11:32:04 -0700670
Florin Corasd85de682018-11-29 17:02:29 -0800671void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
672u32 vcl_segment_table_lookup (u64 segment_handle);
673void vcl_segment_table_del (u64 segment_handle);
674
Florin Coras0ef8ef22019-01-18 08:37:13 -0800675int vcl_session_read_ready (vcl_session_t * session);
676int vcl_session_write_ready (vcl_session_t * session);
Florin Corasa54b62d2021-04-21 09:05:56 -0700677int vcl_session_alloc_ext_cfg (vcl_session_t *s,
Florin Coras87f63892021-05-01 16:01:40 -0700678 transport_endpt_ext_cfg_type_t type, u32 len);
Florin Coras0ef8ef22019-01-18 08:37:13 -0800679
Florin Coras134a9962018-08-28 11:32:04 -0700680static inline vcl_worker_t *
681vcl_worker_get (u32 wrk_index)
682{
683 return pool_elt_at_index (vcm->workers, wrk_index);
684}
685
686static inline vcl_worker_t *
Florin Coras01f3f892018-12-02 12:45:53 -0800687vcl_worker_get_if_valid (u32 wrk_index)
688{
689 if (pool_is_free_index (vcm->workers, wrk_index))
690 return 0;
691 return pool_elt_at_index (vcm->workers, wrk_index);
692}
693
694static inline vcl_worker_t *
Florin Coras134a9962018-08-28 11:32:04 -0700695vcl_worker_get_current (void)
696{
697 return vcl_worker_get (vcl_get_worker_index ());
698}
Florin Coras99368312018-08-02 10:45:44 -0700699
Florin Coras2d675d72019-01-28 15:54:27 -0800700static inline u8
701vcl_n_workers (void)
702{
703 return pool_elts (vcm->workers);
704}
705
Florin Coras935ce752020-09-08 22:43:47 -0700706static inline u64
707vcl_vpp_worker_segment_handle (u32 wrk_index)
708{
709 return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
710}
711
Florin Coras30e79c22019-01-02 19:31:22 -0800712void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
713 u32 wrk_index);
hanlina3a48962020-07-13 11:09:15 +0800714int vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len);
Florin Coras40c07ce2020-07-16 20:46:17 -0700715
Florin Corasc4c4cf52019-08-24 18:17:34 -0700716int vcl_segment_attach (u64 segment_handle, char *name,
717 ssvm_segment_type_t type, int fd);
718void vcl_segment_detach (u64 segment_handle);
Florin Corasb88de902020-09-08 16:47:57 -0700719void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
Florin Corasc4c4cf52019-08-24 18:17:34 -0700720
Florin Corasc547e912020-12-08 17:50:45 -0800721int vcl_segment_attach_session (uword segment_handle, uword rxf_offset,
Florin Corasf6e284b2021-07-21 18:17:20 -0700722 uword txf_offset, uword mq_offset,
723 u32 mq_index, u8 is_ct, vcl_session_t *s);
Florin Corasb4624182020-12-11 13:58:12 -0800724int vcl_segment_attach_mq (uword segment_handle, uword mq_offset, u32 mq_index,
725 svm_msg_q_t **mq);
Florin Coras80b74252021-01-27 18:08:25 -0800726int vcl_segment_discover_mqs (uword segment_handle, int *fds, u32 n_fds);
Florin Coras4ac25842021-04-19 17:34:54 -0700727svm_fifo_chunk_t *vcl_segment_alloc_chunk (uword segment_handle,
728 u32 slice_index, u32 size,
729 uword *offset);
Florin Coras8eb8d502021-06-16 14:46:57 -0700730int vcl_session_share_fifos (vcl_session_t *s, svm_fifo_t *rxf,
731 svm_fifo_t *txf);
Florin Corasc547e912020-12-08 17:50:45 -0800732
Florin Corasb88de902020-09-08 16:47:57 -0700733/*
734 * VCL Binary API
735 */
736int vcl_bapi_attach (void);
737int vcl_bapi_app_worker_add (void);
738void vcl_bapi_app_worker_del (vcl_worker_t * wrk);
739void vcl_bapi_disconnect_from_vpp (void);
Florin Coras935ce752020-09-08 22:43:47 -0700740int vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
Florin Corasa5a9efd2021-01-05 17:03:29 -0800741int vcl_bapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
742int vcl_bapi_del_cert_key_pair (u32 ckpair_index);
Florin Corasb88de902020-09-08 16:47:57 -0700743u32 vcl_bapi_max_nsid_len (void);
744int vcl_bapi_worker_set (void);
Florin Coras697faea2018-06-27 17:10:49 -0700745
Florin Coras935ce752020-09-08 22:43:47 -0700746/*
747 * VCL Socket API
748 */
749int vcl_sapi_attach (void);
750int vcl_sapi_app_worker_add (void);
751void vcl_sapi_app_worker_del (vcl_worker_t * wrk);
752void vcl_sapi_detach (vcl_worker_t * wrk);
753int vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
Florin Corase191d762021-08-11 14:55:49 -0700754int vcl_sapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
755int vcl_sapi_del_cert_key_pair (u32 ckpair_index);
Florin Coras935ce752020-09-08 22:43:47 -0700756
Florin Coras60687192021-11-29 21:00:47 -0800757/*
758 * Utility functions
759 */
760const char *vcl_session_state_str (vcl_session_state_t state);
761u8 *vcl_format_ip4_address (u8 *s, va_list *args);
762u8 *vcl_format_ip6_address (u8 *s, va_list *args);
763u8 *vcl_format_ip46_address (u8 *s, va_list *args);
764
Florin Coras697faea2018-06-27 17:10:49 -0700765#endif /* SRC_VCL_VCL_PRIVATE_H_ */
766
767/*
768 * fd.io coding-style-patch-verification: ON
769 *
770 * Local Variables:
771 * eval: (c-set-style "gnu")
772 * End:
773 */