blob: 24150fbbcd1600ee8f5521a98c3d3a9c2a4cedd3 [file] [log] [blame]
Dave Barach68b0fb02017-02-28 15:15:56 -05001/*
Florin Coras288eaab2019-02-03 15:26:14 -08002 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
Dave Barach68b0fb02017-02-28 15:15:56 -05003 * 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#ifndef __included_session_h__
16#define __included_session_h__
17
Florin Coras2062ec02019-07-15 13:15:18 -070018#include <vppinfra/llist.h>
Florin Coras288eaab2019-02-03 15:26:14 -080019#include <vnet/session/session_types.h>
Florin Coras04e53442017-07-16 17:12:15 -070020#include <vnet/session/session_lookup.h>
Florin Coras3e350af2017-03-30 02:54:28 -070021#include <vnet/session/session_debug.h>
Florin Coras288eaab2019-02-03 15:26:14 -080022#include <svm/message_queue.h>
Florin Coras04943b42020-12-25 11:45:40 -080023#include <svm/fifo_segment.h>
Marvin Liu06542422022-08-16 06:49:09 +000024#include <vlib/dma/dma.h>
Dave Barach68b0fb02017-02-28 15:15:56 -050025
Filip Tehlarac3c8dc2023-03-14 08:50:28 +010026typedef struct session_wrk_stats_
27{
28 u32 errors[SESSION_N_ERRORS];
29} session_wrk_stats_t;
30
Florin Coras8e43d042018-05-04 15:46:57 -070031typedef struct session_tx_context_
32{
33 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Florin Coras288eaab2019-02-03 15:26:14 -080034 session_t *s;
Florin Coras8e43d042018-05-04 15:46:57 -070035 transport_proto_vft_t *transport_vft;
36 transport_connection_t *tc;
Florin Coras70f879d2020-03-13 17:54:42 +000037 transport_send_params_t sp;
Florin Coras8e43d042018-05-04 15:46:57 -070038 u32 max_dequeue;
Florin Coras8e43d042018-05-04 15:46:57 -070039 u32 left_to_snd;
Florin Coras8e43d042018-05-04 15:46:57 -070040 u32 max_len_to_snd;
41 u16 deq_per_first_buf;
42 u16 deq_per_buf;
Florin Corasf08f26d2018-05-10 13:20:47 -070043 u16 n_segs_per_evt;
Simon Zhangae16a982020-03-31 20:56:22 +080044 u16 n_bufs_needed;
Florin Coras8e43d042018-05-04 15:46:57 -070045 u8 n_bufs_per_seg;
46 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
47 session_dgram_hdr_t hdr;
Florin Coras1d7a6632021-05-17 23:44:53 -070048
49 /** Vector of tx buffer free lists */
50 u32 *tx_buffers;
Florin Corasf66cc802021-04-08 19:10:07 -070051 vlib_buffer_t **transport_pending_bufs;
Florin Coras8e43d042018-05-04 15:46:57 -070052} session_tx_context_t;
53
Florin Coras2062ec02019-07-15 13:15:18 -070054typedef struct session_evt_elt
55{
56 clib_llist_anchor_t evt_list;
57 session_event_t evt;
58} session_evt_elt_t;
59
Florin Coras458089b2019-08-21 16:20:44 -070060typedef struct session_ctrl_evt_data_
61{
62 u8 data[SESSION_CTRL_MSG_MAX_SIZE];
63} session_evt_ctrl_data_t;
64
Florin Coras7da88292021-03-18 15:04:34 -070065typedef enum session_wrk_state_
66{
67 SESSION_WRK_POLLING,
68 SESSION_WRK_INTERRUPT,
69 SESSION_WRK_IDLE,
70} __clib_packed session_wrk_state_t;
71
72typedef enum session_wrk_flags_
73{
74 SESSION_WRK_F_ADAPTIVE = 1 << 0,
75} __clib_packed session_wrk_flag_t;
76
Marvin Liu06542422022-08-16 06:49:09 +000077#define DMA_TRANS_SIZE 1024
78typedef struct
79{
80 u32 *pending_tx_buffers;
81 u16 *pending_tx_nexts;
82} session_dma_transfer;
83
Florin Coras31c99552019-03-01 13:00:58 -080084typedef struct session_worker_
Dave Barach68b0fb02017-02-28 15:15:56 -050085{
Florin Coras5a7ca7b2018-10-30 12:01:48 -070086 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Dave Barach68b0fb02017-02-28 15:15:56 -050087
Florin Coras5a7ca7b2018-10-30 12:01:48 -070088 /** Worker session pool */
Florin Coras288eaab2019-02-03 15:26:14 -080089 session_t *sessions;
Florin Coras3cbc04b2017-10-02 00:18:51 -070090
Florin Coras5a7ca7b2018-10-30 12:01:48 -070091 /** vpp event message queue for worker */
92 svm_msg_q_t *vpp_event_queue;
Florin Coras8e43d042018-05-04 15:46:57 -070093
Florin Corasd67f1122018-05-21 17:47:40 -070094 /** vlib_time_now last time around the track */
Florin Corasa8e71c82019-10-22 19:01:39 -070095 clib_time_type_t last_vlib_time;
96
97 /** vlib_time_now rounded to us precision and as u64 */
98 clib_us_time_t last_vlib_us_time;
Florin Corasd67f1122018-05-21 17:47:40 -070099
Florin Coras60183db2019-07-20 15:53:16 -0700100 /** Convenience pointer to this worker's vlib_main */
101 vlib_main_t *vm;
102
Florin Coras0242d302022-12-22 15:03:44 -0800103 /** Per-proto vector of session handles to enqueue */
104 session_handle_t **session_to_enqueue;
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700105
Florin Coras7da88292021-03-18 15:04:34 -0700106 /** Timerfd used to periodically signal wrk session queue node */
Florin Coras1c19aef2021-04-06 15:54:14 -0700107 int timerfd;
Florin Coras7da88292021-03-18 15:04:34 -0700108
109 /** Worker flags */
110 session_wrk_flag_t flags;
111
112 /** Worker state */
113 session_wrk_state_t state;
114
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700115 /** Context for session tx */
116 session_tx_context_t ctx;
117
Florin Coras2062ec02019-07-15 13:15:18 -0700118 /** Pool of session event list elements */
119 session_evt_elt_t *event_elts;
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700120
Florin Coras458089b2019-08-21 16:20:44 -0700121 /** Pool of ctrl events data buffers */
122 session_evt_ctrl_data_t *ctrl_evts_data;
123
Florin Corasb0ffbee2019-07-21 19:23:46 -0700124 /** Head of control events list */
125 clib_llist_index_t ctrl_head;
126
Florin Coras2062ec02019-07-15 13:15:18 -0700127 /** Head of list of elements */
128 clib_llist_index_t new_head;
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700129
Florin Coras2062ec02019-07-15 13:15:18 -0700130 /** Head of list of pending events */
Florin Coras60183db2019-07-20 15:53:16 -0700131 clib_llist_index_t old_head;
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700132
Florin Coras2a7ea2e2019-10-16 22:06:08 -0700133 /** Vector of buffers to be sent */
134 u32 *pending_tx_buffers;
135
136 /** Vector of nexts for the pending tx buffers */
137 u16 *pending_tx_nexts;
138
Florin Coras7da88292021-03-18 15:04:34 -0700139 /** Clib file for timerfd. Used only if adaptive mode is on */
140 uword timerfd_file;
141
Florin Corasaf972212021-05-05 09:54:00 -0700142 /** List of pending connects for first worker */
143 clib_llist_index_t pending_connects;
144
145 /** Flag that is set if main thread signaled to handle connects */
Florin Coras0f273392021-05-21 15:48:18 -0700146 u32 n_pending_connects;
Florin Corasaf972212021-05-05 09:54:00 -0700147
Florin Corase09bd482022-03-21 10:38:01 -0700148 /** List head for first worker evts pending handling on main */
149 clib_llist_index_t evts_pending_main;
150
Florin Coras0242d302022-12-22 15:03:44 -0800151 /** Per-app-worker bitmap of pending notifications */
152 uword *app_wrks_pending_ntf;
153
Marvin Liu06542422022-08-16 06:49:09 +0000154 int config_index;
155 u8 dma_enabled;
156 session_dma_transfer *dma_trans;
157 u16 trans_head;
158 u16 trans_tail;
159 u16 trans_size;
160 u16 batch_num;
161 vlib_dma_batch_t *batch;
162
Filip Tehlarac3c8dc2023-03-14 08:50:28 +0100163 session_wrk_stats_t stats;
164
Florin Corascca96182019-07-19 07:34:13 -0700165#if SESSION_DEBUG
166 /** last event poll time by thread */
Florin Corasa8e71c82019-10-22 19:01:39 -0700167 clib_time_type_t last_event_poll;
Florin Corascca96182019-07-19 07:34:13 -0700168#endif
Florin Coras31c99552019-03-01 13:00:58 -0800169} session_worker_t;
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700170
Florin Coras60183db2019-07-20 15:53:16 -0700171typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
Florin Coras1bcad5c2019-01-09 20:04:38 -0800172 vlib_node_runtime_t * node,
Florin Coras60183db2019-07-20 15:53:16 -0700173 session_evt_elt_t * e, int *n_tx_packets);
Florin Coras1bcad5c2019-01-09 20:04:38 -0800174
175extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
176extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
177extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
178
179u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
180
Florin Coras5384cca2022-01-20 18:10:26 -0800181typedef void (*session_update_time_fn) (f64 time_now, u8 thread_index);
qinyangaf9b7152023-06-27 01:11:53 -0700182typedef void (*nat44_original_dst_lookup_fn) (
183 ip4_address_t *i2o_src, u16 i2o_src_port, ip4_address_t *i2o_dst,
184 u16 i2o_dst_port, ip_protocol_t proto, u32 *original_dst,
185 u16 *original_dst_port);
Florin Coras5384cca2022-01-20 18:10:26 -0800186
Steven Luongc4b5d102024-07-30 13:44:01 -0700187#define foreach_rt_engine \
188 _ (DISABLE, "disable") \
189 _ (RULE_TABLE, "enable with rt-backend rule table") \
190 _ (NONE, "enable without rt-backend") \
191 _ (SDL, "enable with rt-backend sdl")
192
193typedef enum
194{
195#define _(v, s) RT_BACKEND_ENGINE_##v,
196 foreach_rt_engine
197#undef _
198} session_rt_engine_type_t;
199
Florin Coras31c99552019-03-01 13:00:58 -0800200typedef struct session_main_
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700201{
202 /** Worker contexts */
Florin Coras31c99552019-03-01 13:00:58 -0800203 session_worker_t *wrk;
Dave Barach68b0fb02017-02-28 15:15:56 -0500204
Florin Coras5384cca2022-01-20 18:10:26 -0800205 /** Vector of transport update time functions */
206 session_update_time_fn *update_time_fns;
207
Florin Coras6c10ab22020-11-08 16:50:39 -0800208 /** Event queues memfd segment */
Florin Coras8afe1b82021-11-17 23:38:54 -0800209 fifo_segment_t wrk_mqs_segment;
Florin Corasb384b542018-01-15 01:08:33 -0800210
Florin Coras93e65802017-11-29 00:07:11 -0500211 /** Unique segment name counter */
212 u32 unique_segment_name_counter;
213
214 /** Per transport rx function that can either dequeue or peek */
Florin Coras561af9b2017-12-09 10:19:43 -0800215 session_fifo_rx_fn **session_tx_fns;
216
217 /** Per session type output nodes. Could optimize to group nodes by
218 * fib but lookup would then require session type parsing in session node.
219 * Trade memory for speed, for now */
220 u32 *session_type_to_next;
Florin Coras93e65802017-11-29 00:07:11 -0500221
Florin Coras309f7aa2022-03-18 08:33:08 -0700222 /** Thread used for allocating active open connections, i.e., half-opens
223 * for transports like tcp, and sessions that will be migrated for cl
224 * transports like udp. If vpp has workers, this will be first worker. */
Florin Corasfb50bc32021-05-18 00:28:59 -0700225 u32 transport_cl_thread;
226
Florin Coras07063b82020-03-13 04:44:51 +0000227 transport_proto_t last_transport_proto_type;
228
Florin Coras53d8d4f2022-03-09 13:55:38 -0800229 /** Number of workers at pool realloc barrier */
Florin Coras5b47a6d2022-03-26 01:25:02 -0700230 volatile u32 pool_realloc_at_barrier;
231
232 /** Number of workers doing reallocs */
233 volatile u32 pool_realloc_doing_work;
Florin Coras53d8d4f2022-03-09 13:55:38 -0800234
235 /** Lock to synchronize parallel forced reallocs */
236 clib_spinlock_t pool_realloc_lock;
237
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700238 /*
239 * Config parameters
240 */
241
Florin Coras93e65802017-11-29 00:07:11 -0500242 /** Session manager is enabled */
243 u8 is_enabled;
Florin Corase10da622020-10-25 14:00:29 -0700244
245 /** Session manager initialized (not necessarily enabled) */
246 u8 is_initialized;
247
Nathan Skrzypczak31bd0352019-11-07 17:55:01 +0100248 /** Enable session manager at startup */
249 u8 session_enable_asap;
Florin Coras93e65802017-11-29 00:07:11 -0500250
Steven Luongc4b5d102024-07-30 13:44:01 -0700251 /** Session engine type */
252 session_rt_engine_type_t rt_engine_type;
253
Florin Corase92c9462020-11-25 08:44:16 -0800254 /** Poll session node in main thread */
255 u8 poll_main;
256
Florin Coras41d5f542021-01-15 13:49:33 -0800257 /** Allocate private rx mqs for external apps */
258 u8 use_private_rx_mqs;
259
Florin Coras7da88292021-03-18 15:04:34 -0700260 /** Do not enable session queue node adaptive mode */
261 u8 no_adaptive;
262
Dave Barach10d8cc62017-05-30 09:30:07 -0400263 /** vpp fifo event queue configured length */
Florin Coras8afe1b82021-11-17 23:38:54 -0800264 u32 configured_wrk_mq_length;
Dave Barach10d8cc62017-05-30 09:30:07 -0400265
Florin Corasb384b542018-01-15 01:08:33 -0800266 /** Session ssvm segment configs*/
Florin Coras8afe1b82021-11-17 23:38:54 -0800267 uword wrk_mqs_segment_size;
Florin Corasb384b542018-01-15 01:08:33 -0800268
Marvin Liu06542422022-08-16 06:49:09 +0000269 /** Session enable dma*/
270 u8 dma_enabled;
271
Florin Corasb384b542018-01-15 01:08:33 -0800272 /** Session table size parameters */
Florin Coras66b11312017-07-31 17:18:03 -0700273 u32 configured_v4_session_table_buckets;
274 u32 configured_v4_session_table_memory;
275 u32 configured_v4_halfopen_table_buckets;
276 u32 configured_v4_halfopen_table_memory;
277 u32 configured_v6_session_table_buckets;
278 u32 configured_v6_session_table_memory;
279 u32 configured_v6_halfopen_table_buckets;
280 u32 configured_v6_halfopen_table_memory;
281
Florin Coras93e65802017-11-29 00:07:11 -0500282 /** Transport table (preallocation) size parameters */
283 u32 local_endpoints_table_memory;
284 u32 local_endpoints_table_buckets;
Florin Corase04c2992017-03-01 08:17:34 -0800285
Nathan Skrzypczake111bbd2023-10-03 13:54:15 +0200286 /** Transport source port allocation range */
287 u16 port_allocator_min_src_port;
288 u16 port_allocator_max_src_port;
289
Dave Barach2c25a622017-06-26 11:35:07 -0400290 /** Preallocate session config parameter */
291 u32 preallocated_sessions;
292
Filip Tehlar0046e972021-06-26 22:12:08 +0000293 u16 msg_id_base;
qinyangaf9b7152023-06-27 01:11:53 -0700294
295 /** Query nat44-ed session to get original dst ip4 & dst port. */
296 nat44_original_dst_lookup_fn original_dst_lookup;
Florin Coras31c99552019-03-01 13:00:58 -0800297} session_main_t;
Dave Barach68b0fb02017-02-28 15:15:56 -0500298
Florin Coras31c99552019-03-01 13:00:58 -0800299extern session_main_t session_main;
Florin Corase04c2992017-03-01 08:17:34 -0800300extern vlib_node_registration_t session_queue_node;
Florin Coras0242d302022-12-22 15:03:44 -0800301extern vlib_node_registration_t session_input_node;
Florin Corasfd542f12018-05-16 19:28:24 -0700302extern vlib_node_registration_t session_queue_process_node;
Florin Coras653e43f2019-03-04 10:56:23 -0800303extern vlib_node_registration_t session_queue_pre_input_node;
Florin Corasfd542f12018-05-16 19:28:24 -0700304
Florin Coras5484daa2020-03-27 23:55:06 +0000305typedef enum session_q_process_evt_
306{
307 SESSION_Q_PROCESS_RUN_ON_MAIN = 1,
308 SESSION_Q_PROCESS_STOP
309} session_q_process_evt_t;
Dave Barach68b0fb02017-02-28 15:15:56 -0500310
Steven Luongc4b5d102024-07-30 13:44:01 -0700311typedef struct _session_enable_disable_args_t
312{
313 session_rt_engine_type_t rt_engine_type;
314 u8 is_en;
315} session_enable_disable_args_t;
316
Florin Coras07063b82020-03-13 04:44:51 +0000317#define TRANSPORT_PROTO_INVALID (session_main.last_transport_proto_type + 1)
318#define TRANSPORT_N_PROTOS (session_main.last_transport_proto_type + 1)
319
Florin Coras2062ec02019-07-15 13:15:18 -0700320static inline void
Florin Coras60183db2019-07-20 15:53:16 -0700321session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
Florin Coras2062ec02019-07-15 13:15:18 -0700322{
323 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
Florin Coras46b8b1a2021-05-17 19:09:33 -0700324 clib_llist_elt (wrk->event_elts, wrk->old_head));
Florin Coras2062ec02019-07-15 13:15:18 -0700325}
326
Florin Corasdd97a482019-11-02 14:32:52 -0700327static inline void
328session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
329{
330 clib_llist_add (wrk->event_elts, evt_list, elt,
Florin Coras46b8b1a2021-05-17 19:09:33 -0700331 clib_llist_elt (wrk->event_elts, wrk->old_head));
Florin Corasdd97a482019-11-02 14:32:52 -0700332}
333
334
Florin Coras458089b2019-08-21 16:20:44 -0700335static inline u32
336session_evt_ctrl_data_alloc (session_worker_t * wrk)
337{
338 session_evt_ctrl_data_t *data;
339 pool_get (wrk->ctrl_evts_data, data);
340 return (data - wrk->ctrl_evts_data);
341}
342
Florin Corasb0ffbee2019-07-21 19:23:46 -0700343static inline session_evt_elt_t *
344session_evt_alloc_ctrl (session_worker_t * wrk)
Florin Coras2062ec02019-07-15 13:15:18 -0700345{
Florin Corasb0ffbee2019-07-21 19:23:46 -0700346 session_evt_elt_t *elt;
Florin Coras46b8b1a2021-05-17 19:09:33 -0700347 clib_llist_get (wrk->event_elts, elt);
Florin Coras2062ec02019-07-15 13:15:18 -0700348 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
Florin Coras46b8b1a2021-05-17 19:09:33 -0700349 clib_llist_elt (wrk->event_elts, wrk->ctrl_head));
Florin Corasb0ffbee2019-07-21 19:23:46 -0700350 return elt;
Florin Coras2062ec02019-07-15 13:15:18 -0700351}
352
Florin Coras458089b2019-08-21 16:20:44 -0700353static inline void *
354session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
355{
356 return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
357 elt->evt.ctrl_data_index));
358}
359
360static inline void
361session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
362{
Florin Corasaeb7c1c2023-03-10 10:22:21 -0800363 ASSERT (elt->evt.event_type >= SESSION_CTRL_EVT_RPC);
Florin Coras458089b2019-08-21 16:20:44 -0700364 pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
365}
366
Florin Coras26dd6de2019-07-23 23:54:47 -0700367static inline session_evt_elt_t *
368session_evt_alloc_new (session_worker_t * wrk)
369{
370 session_evt_elt_t *elt;
Florin Coras46b8b1a2021-05-17 19:09:33 -0700371 clib_llist_get (wrk->event_elts, elt);
Florin Coras26dd6de2019-07-23 23:54:47 -0700372 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
Florin Coras46b8b1a2021-05-17 19:09:33 -0700373 clib_llist_elt (wrk->event_elts, wrk->new_head));
Florin Coras26dd6de2019-07-23 23:54:47 -0700374 return elt;
375}
376
377static inline session_evt_elt_t *
378session_evt_alloc_old (session_worker_t * wrk)
379{
380 session_evt_elt_t *elt;
Florin Coras46b8b1a2021-05-17 19:09:33 -0700381 clib_llist_get (wrk->event_elts, elt);
Florin Coras26dd6de2019-07-23 23:54:47 -0700382 clib_llist_add_tail (wrk->event_elts, evt_list, elt,
Florin Coras46b8b1a2021-05-17 19:09:33 -0700383 clib_llist_elt (wrk->event_elts, wrk->old_head));
Florin Coras26dd6de2019-07-23 23:54:47 -0700384 return elt;
385}
386
Florin Coras41d5f542021-01-15 13:49:33 -0800387int session_wrk_handle_mq (session_worker_t *wrk, svm_msg_q_t *mq);
388
Florin Coras288eaab2019-02-03 15:26:14 -0800389session_t *session_alloc (u32 thread_index);
Florin Coras288eaab2019-02-03 15:26:14 -0800390void session_free (session_t * s);
Florin Coras0242d302022-12-22 15:03:44 -0800391void session_cleanup (session_t *s);
392void session_program_cleanup (session_t *s);
Florin Corasea727642021-05-07 19:39:43 -0700393void session_cleanup_half_open (session_handle_t ho_handle);
Srikanth Akulae140d5d2019-11-18 11:49:58 -0800394u8 session_is_valid (u32 si, u8 thread_index);
Florin Coras3cbc04b2017-10-02 00:18:51 -0700395
Florin Coras288eaab2019-02-03 15:26:14 -0800396always_inline session_t *
Florin Corascea194d2017-10-02 00:18:51 -0700397session_get (u32 si, u32 thread_index)
Dave Barach68b0fb02017-02-28 15:15:56 -0500398{
Florin Coras31c99552019-03-01 13:00:58 -0800399 ASSERT (session_is_valid (si, thread_index));
400 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
Dave Barach68b0fb02017-02-28 15:15:56 -0500401}
402
Florin Coras288eaab2019-02-03 15:26:14 -0800403always_inline session_t *
Florin Coras3cbc04b2017-10-02 00:18:51 -0700404session_get_if_valid (u64 si, u32 thread_index)
Dave Barach68b0fb02017-02-28 15:15:56 -0500405{
Florin Coras31c99552019-03-01 13:00:58 -0800406 if (thread_index >= vec_len (session_main.wrk))
Dave Barach68b0fb02017-02-28 15:15:56 -0500407 return 0;
408
Florin Coras31c99552019-03-01 13:00:58 -0800409 if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
Dave Barach68b0fb02017-02-28 15:15:56 -0500410 return 0;
411
Florin Coras31c99552019-03-01 13:00:58 -0800412 ASSERT (session_is_valid (si, thread_index));
413 return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
Dave Barach68b0fb02017-02-28 15:15:56 -0500414}
415
Florin Coras288eaab2019-02-03 15:26:14 -0800416always_inline session_t *
Florin Coras980ee742023-08-04 16:14:01 -0700417session_get_from_handle (session_handle_tu_t handle)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700418{
Florin Coras31c99552019-03-01 13:00:58 -0800419 session_main_t *smm = &session_main;
Florin Coras980ee742023-08-04 16:14:01 -0700420 return pool_elt_at_index (smm->wrk[handle.thread_index].sessions,
421 handle.session_index);
Florin Corasf8f516a2018-02-08 15:10:09 -0800422}
423
Florin Coras288eaab2019-02-03 15:26:14 -0800424always_inline session_t *
Florin Coras980ee742023-08-04 16:14:01 -0700425session_get_from_handle_if_valid (session_handle_tu_t handle)
Florin Corasf8f516a2018-02-08 15:10:09 -0800426{
Florin Coras980ee742023-08-04 16:14:01 -0700427 return session_get_if_valid (handle.session_index, handle.thread_index);
Florin Corasf8f516a2018-02-08 15:10:09 -0800428}
429
Florin Coras3cbc04b2017-10-02 00:18:51 -0700430/**
Florin Coras6bd8d3f2022-03-14 21:17:25 -0700431 * Get session from handle and avoid pool validation if no same thread
Florin Coras3cbc04b2017-10-02 00:18:51 -0700432 *
Florin Coras6bd8d3f2022-03-14 21:17:25 -0700433 * Peekers are fine because pool grows with barrier (see @ref session_alloc)
Florin Coras3cbc04b2017-10-02 00:18:51 -0700434 */
Florin Coras288eaab2019-02-03 15:26:14 -0800435always_inline session_t *
Florin Coras980ee742023-08-04 16:14:01 -0700436session_get_from_handle_safe (session_handle_tu_t handle)
Florin Coras3cbc04b2017-10-02 00:18:51 -0700437{
Florin Coras980ee742023-08-04 16:14:01 -0700438 session_worker_t *wrk = &session_main.wrk[handle.thread_index];
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700439
Florin Coras980ee742023-08-04 16:14:01 -0700440 if (handle.thread_index == vlib_get_thread_index ())
Florin Coras3cbc04b2017-10-02 00:18:51 -0700441 {
Florin Coras980ee742023-08-04 16:14:01 -0700442 return pool_elt_at_index (wrk->sessions, handle.session_index);
Florin Coras3cbc04b2017-10-02 00:18:51 -0700443 }
444 else
445 {
Florin Coras6bd8d3f2022-03-14 21:17:25 -0700446 /* Don't use pool_elt_at index to avoid pool bitmap reallocs */
Florin Coras980ee742023-08-04 16:14:01 -0700447 return wrk->sessions + handle.session_index;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700448 }
449}
450
Florin Coras1ee78302019-02-05 15:51:15 -0800451always_inline session_t *
452session_clone_safe (u32 session_index, u32 thread_index)
453{
Florin Coras6bd8d3f2022-03-14 21:17:25 -0700454 u32 current_thread_index = vlib_get_thread_index (), new_index;
Florin Coras1ee78302019-02-05 15:51:15 -0800455 session_t *old_s, *new_s;
Florin Coras1ee78302019-02-05 15:51:15 -0800456
Florin Coras1ee78302019-02-05 15:51:15 -0800457 new_s = session_alloc (current_thread_index);
Florin Coras6bd8d3f2022-03-14 21:17:25 -0700458 new_index = new_s->session_index;
459 /* Session pools are reallocated with barrier (see @ref session_alloc) */
Florin Coras31c99552019-03-01 13:00:58 -0800460 old_s = session_main.wrk[thread_index].sessions + session_index;
Florin Coras1ee78302019-02-05 15:51:15 -0800461 clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
Florin Coras1ee78302019-02-05 15:51:15 -0800462 new_s->thread_index = current_thread_index;
Florin Coras6bd8d3f2022-03-14 21:17:25 -0700463 new_s->session_index = new_index;
Florin Coras1ee78302019-02-05 15:51:15 -0800464 return new_s;
465}
466
Florin Coras89a9f612021-05-11 11:55:07 -0700467int session_open (session_endpoint_cfg_t *sep, session_handle_t *rsh);
Florin Coras1ee78302019-02-05 15:51:15 -0800468int session_listen (session_t * s, session_endpoint_cfg_t * sep);
469int session_stop_listen (session_t * s);
liuyacan534468e2021-05-09 03:50:40 +0000470void session_half_close (session_t *s);
Florin Coras1ee78302019-02-05 15:51:15 -0800471void session_close (session_t * s);
Florin Corasdfb3b872019-08-16 17:48:44 -0700472void session_reset (session_t * s);
Florin Corasaa786312024-04-09 13:27:53 -0700473void session_detach_app (session_t *s);
liuyacan534468e2021-05-09 03:50:40 +0000474void session_transport_half_close (session_t *s);
Florin Coras1ee78302019-02-05 15:51:15 -0800475void session_transport_close (session_t * s);
Florin Corasdfb3b872019-08-16 17:48:44 -0700476void session_transport_reset (session_t * s);
Florin Coras1ee78302019-02-05 15:51:15 -0800477void session_transport_cleanup (session_t * s);
Florin Coras0242d302022-12-22 15:03:44 -0800478int session_enqueue_notify (session_t *s);
Florin Coras1ee78302019-02-05 15:51:15 -0800479int session_dequeue_notify (session_t * s);
Florin Coras0242d302022-12-22 15:03:44 -0800480int session_enqueue_notify_cl (session_t *s);
Florin Coras7e9e2bd2024-03-22 16:29:09 -0700481int session_send_io_evt_to_thread (svm_fifo_t *f, session_evt_type_t evt_type);
Florin Coras1ee78302019-02-05 15:51:15 -0800482int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
483 session_evt_type_t evt_type);
Florin Coras7e9e2bd2024-03-22 16:29:09 -0700484int session_program_tx_io_evt (session_handle_tu_t sh,
485 session_evt_type_t evt_type);
Florin Coras129ff042024-07-08 15:15:07 -0700486int session_program_rx_io_evt (session_handle_tu_t sh);
Florin Coras1ee78302019-02-05 15:51:15 -0800487void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
488 void *rpc_args);
Nathan Skrzypczak60f3e652019-03-19 13:57:31 +0100489void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
490 void *rpc_args);
Florin Coras26dd6de2019-07-23 23:54:47 -0700491void session_add_self_custom_tx_evt (transport_connection_t * tc,
492 u8 has_prio);
Florin Coras70f879d2020-03-13 17:54:42 +0000493void sesssion_reschedule_tx (transport_connection_t * tc);
Florin Coras1ee78302019-02-05 15:51:15 -0800494transport_connection_t *session_get_transport (session_t * s);
Florin Coras09d18c22019-04-24 11:10:02 -0700495void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
496 u8 is_lcl);
Florin Coras04ae8272021-04-12 19:55:37 -0700497int session_transport_attribute (session_t *s, u8 is_get,
498 transport_endpt_attr_t *attr);
Florin Coras980ee742023-08-04 16:14:01 -0700499u64 session_segment_handle (session_t *s);
Florin Coras1ee78302019-02-05 15:51:15 -0800500
Florin Coras31c99552019-03-01 13:00:58 -0800501u8 *format_session (u8 * s, va_list * args);
502uword unformat_session (unformat_input_t * input, va_list * args);
Florin Coras1ee78302019-02-05 15:51:15 -0800503uword unformat_transport_connection (unformat_input_t * input,
504 va_list * args);
505
506/*
507 * Interface to transport protos
508 */
509
510int session_enqueue_stream_connection (transport_connection_t * tc,
511 vlib_buffer_t * b, u32 offset,
512 u8 queue_event, u8 is_in_order);
513int session_enqueue_dgram_connection (session_t * s,
514 session_dgram_hdr_t * hdr,
515 vlib_buffer_t * b, u8 proto,
516 u8 queue_event);
Florin Coras7428eaa2023-12-11 16:04:57 -0800517int session_enqueue_dgram_connection2 (session_t *s, session_dgram_hdr_t *hdr,
518 vlib_buffer_t *b, u8 proto,
519 u8 queue_event);
Florin Coras0242d302022-12-22 15:03:44 -0800520int session_enqueue_dgram_connection_cl (session_t *s,
521 session_dgram_hdr_t *hdr,
522 vlib_buffer_t *b, u8 proto,
523 u8 queue_event);
Florin Coras00e01d32019-10-21 16:07:46 -0700524int session_stream_connect_notify (transport_connection_t * tc,
525 session_error_t err);
Florin Coras1ee78302019-02-05 15:51:15 -0800526int session_dgram_connect_notify (transport_connection_t * tc,
527 u32 old_thread_index,
528 session_t ** new_session);
Florin Corasa27a46e2019-02-18 13:02:28 -0800529int session_stream_accept_notify (transport_connection_t * tc);
Florin Coras1ee78302019-02-05 15:51:15 -0800530void session_transport_closing_notify (transport_connection_t * tc);
531void session_transport_delete_notify (transport_connection_t * tc);
Florin Corasea727642021-05-07 19:39:43 -0700532void session_half_open_delete_notify (transport_connection_t *tc);
Florin Corasbab6c522021-05-13 08:36:56 -0700533void session_half_open_migrate_notify (transport_connection_t *tc);
534int session_half_open_migrated_notify (transport_connection_t *tc);
Florin Coras1ee78302019-02-05 15:51:15 -0800535void session_transport_closed_notify (transport_connection_t * tc);
536void session_transport_reset_notify (transport_connection_t * tc);
Florin Corasc9940fc2019-02-05 20:55:11 -0800537int session_stream_accept (transport_connection_t * tc, u32 listener_index,
Nathan Skrzypczak2f0f96b2019-06-13 10:14:28 +0200538 u32 thread_index, u8 notify);
Florin Corase759bb52020-04-08 01:55:39 +0000539int session_dgram_accept (transport_connection_t * tc, u32 listener_index,
540 u32 thread_index);
Florin Coras0242d302022-12-22 15:03:44 -0800541
Florin Coras07063b82020-03-13 04:44:51 +0000542/**
543 * Initialize session layer for given transport proto and ip version
544 *
545 * Allocates per session type (transport proto + ip version) data structures
546 * and adds arc from session queue node to session type output node.
547 *
548 * @param transport_proto transport proto to be registered
549 * @param vft virtual function table for transport
550 * @param is_ip4 flag that indicates if transports uses ipv4
551 * as underlying network layer
552 * @param output_node output node for transport
553 */
Florin Coras1ee78302019-02-05 15:51:15 -0800554void session_register_transport (transport_proto_t transport_proto,
555 const transport_proto_vft_t * vft, u8 is_ip4,
556 u32 output_node);
Florin Coras07063b82020-03-13 04:44:51 +0000557transport_proto_t session_add_transport_proto (void);
Florin Coras5384cca2022-01-20 18:10:26 -0800558void session_register_update_time_fn (session_update_time_fn fn, u8 is_add);
Florin Coras31c99552019-03-01 13:00:58 -0800559int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
560 u32 offset, u32 max_bytes);
561u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
Florin Coras1ee78302019-02-05 15:51:15 -0800562
Steven Luongd810a6e2022-10-25 13:09:11 -0700563always_inline void
564session_set_state (session_t *s, session_state_t session_state)
565{
566 s->session_state = session_state;
567 SESSION_EVT (SESSION_EVT_STATE_CHANGE, s);
568}
569
Florin Coras1ee78302019-02-05 15:51:15 -0800570always_inline u32
Florin Corasd2aab832018-05-22 11:39:59 -0700571transport_max_rx_enqueue (transport_connection_t * tc)
Dave Barach68b0fb02017-02-28 15:15:56 -0500572{
Florin Coras288eaab2019-02-03 15:26:14 -0800573 session_t *s = session_get (tc->s_index, tc->thread_index);
Sirshak Das28aa5392019-02-05 01:33:33 -0600574 return svm_fifo_max_enqueue_prod (s->rx_fifo);
Dave Barach68b0fb02017-02-28 15:15:56 -0500575}
576
Florin Corase04c2992017-03-01 08:17:34 -0800577always_inline u32
Florin Coras42ceddb2018-12-12 10:56:01 -0800578transport_max_tx_dequeue (transport_connection_t * tc)
579{
Florin Coras288eaab2019-02-03 15:26:14 -0800580 session_t *s = session_get (tc->s_index, tc->thread_index);
Sirshak Das28aa5392019-02-05 01:33:33 -0600581 return svm_fifo_max_dequeue_cons (s->tx_fifo);
Florin Coras42ceddb2018-12-12 10:56:01 -0800582}
583
584always_inline u32
Florin Corasf65074e2019-03-31 17:17:11 -0700585transport_max_rx_dequeue (transport_connection_t * tc)
586{
587 session_t *s = session_get (tc->s_index, tc->thread_index);
588 return svm_fifo_max_dequeue (s->rx_fifo);
589}
590
591always_inline u32
Florin Corasd2aab832018-05-22 11:39:59 -0700592transport_rx_fifo_size (transport_connection_t * tc)
Florin Corase04c2992017-03-01 08:17:34 -0800593{
Florin Coras288eaab2019-02-03 15:26:14 -0800594 session_t *s = session_get (tc->s_index, tc->thread_index);
Florin Corasf22f4e52019-12-19 16:10:58 -0800595 return svm_fifo_size (s->rx_fifo);
Florin Corase04c2992017-03-01 08:17:34 -0800596}
597
Florin Coras3cbc04b2017-10-02 00:18:51 -0700598always_inline u32
Florin Corasd2aab832018-05-22 11:39:59 -0700599transport_tx_fifo_size (transport_connection_t * tc)
600{
Florin Coras288eaab2019-02-03 15:26:14 -0800601 session_t *s = session_get (tc->s_index, tc->thread_index);
Florin Corasf22f4e52019-12-19 16:10:58 -0800602 return svm_fifo_size (s->tx_fifo);
Florin Corasd2aab832018-05-22 11:39:59 -0700603}
604
Florin Coras7ac053b2018-11-05 15:57:21 -0800605always_inline u8
606transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
607{
Florin Coras288eaab2019-02-03 15:26:14 -0800608 session_t *s = session_get (tc->c_index, tc->thread_index);
609 return svm_fifo_has_ooo_data (s->rx_fifo);
Florin Coras7ac053b2018-11-05 15:57:21 -0800610}
611
Florin Corasc8767c42023-06-27 19:45:59 -0700612always_inline u32
613transport_tx_fifo_has_dgram (transport_connection_t *tc)
614{
615 session_t *s = session_get (tc->s_index, tc->thread_index);
616 u32 max_deq = svm_fifo_max_dequeue_cons (s->tx_fifo);
617 session_dgram_pre_hdr_t phdr;
618
619 if (max_deq <= sizeof (session_dgram_hdr_t))
620 return 0;
621 svm_fifo_peek (s->tx_fifo, 0, sizeof (phdr), (u8 *) &phdr);
622 return max_deq >= phdr.data_length + sizeof (session_dgram_hdr_t);
623}
624
Florin Coras5a41fd52021-04-19 10:17:26 -0700625always_inline void
626transport_rx_fifo_req_deq_ntf (transport_connection_t *tc)
627{
628 session_t *s = session_get (tc->s_index, tc->thread_index);
629 svm_fifo_add_want_deq_ntf (s->rx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
630}
631
Florin Corasa8e71c82019-10-22 19:01:39 -0700632always_inline clib_time_type_t
Florin Corasd67f1122018-05-21 17:47:40 -0700633transport_time_now (u32 thread_index)
634{
Florin Coras31c99552019-03-01 13:00:58 -0800635 return session_main.wrk[thread_index].last_vlib_time;
Florin Corasd67f1122018-05-21 17:47:40 -0700636}
637
Florin Corasa8e71c82019-10-22 19:01:39 -0700638always_inline clib_us_time_t
639transport_us_time_now (u32 thread_index)
640{
641 return session_main.wrk[thread_index].last_vlib_us_time;
642}
643
Florin Corasa39f4722020-11-12 10:20:05 -0800644always_inline clib_time_type_t
645transport_seconds_per_loop (u32 thread_index)
646{
647 return session_main.wrk[thread_index].vm->seconds_per_loop;
648}
649
Florin Coras3ec66b02018-08-23 16:27:05 -0700650always_inline void
651transport_add_tx_event (transport_connection_t * tc)
652{
Florin Coras288eaab2019-02-03 15:26:14 -0800653 session_t *s = session_get (tc->s_index, tc->thread_index);
654 if (svm_fifo_has_event (s->tx_fifo))
Florin Coras3ec66b02018-08-23 16:27:05 -0700655 return;
Florin Corasf6c43132019-03-01 12:41:21 -0800656 session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
Florin Coras3ec66b02018-08-23 16:27:05 -0700657}
658
Florin Corasfb50bc32021-05-18 00:28:59 -0700659always_inline u32
660transport_cl_thread (void)
661{
662 return session_main.transport_cl_thread;
663}
664
Florin Coras309f7aa2022-03-18 08:33:08 -0700665always_inline u32
666session_vlib_thread_is_cl_thread (void)
667{
668 return (vlib_get_thread_index () == transport_cl_thread () ||
669 vlib_thread_is_main_w_barrier ());
670}
671
Florin Coras1ee78302019-02-05 15:51:15 -0800672/*
673 * Listen sessions
674 */
Florin Coras6cf30ad2017-04-04 23:08:23 -0700675
Florin Coras980ee742023-08-04 16:14:01 -0700676always_inline session_handle_t
677listen_session_get_handle (session_t *s)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700678{
Aloys Augustincdb71702019-04-08 17:54:39 +0200679 ASSERT (s->session_state == SESSION_STATE_LISTENING ||
680 session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
Florin Coras5c9083d2018-04-13 06:39:07 -0700681 return session_handle (s);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700682}
683
Florin Coras288eaab2019-02-03 15:26:14 -0800684always_inline session_t *
Florin Corasf8f516a2018-02-08 15:10:09 -0800685listen_session_get_from_handle (session_handle_t handle)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700686{
Florin Coras5c9083d2018-04-13 06:39:07 -0700687 return session_get_from_handle (handle);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700688}
689
Florin Coras371ca502018-02-21 12:07:41 -0800690always_inline void
Florin Coras5c9083d2018-04-13 06:39:07 -0700691listen_session_parse_handle (session_handle_t handle, u32 * index,
692 u32 * thread_index)
Florin Coras371ca502018-02-21 12:07:41 -0800693{
Florin Coras5c9083d2018-04-13 06:39:07 -0700694 session_parse_handle (handle, index, thread_index);
Florin Coras371ca502018-02-21 12:07:41 -0800695}
696
Florin Coras288eaab2019-02-03 15:26:14 -0800697always_inline session_t *
Florin Corasba7d8f52019-02-22 13:11:38 -0800698listen_session_alloc (u8 thread_index, session_type_t type)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700699{
Florin Coras288eaab2019-02-03 15:26:14 -0800700 session_t *s;
Florin Coras5c9083d2018-04-13 06:39:07 -0700701 s = session_alloc (thread_index);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700702 s->session_type = type;
703 s->session_state = SESSION_STATE_LISTENING;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700704 return s;
705}
706
Florin Coras288eaab2019-02-03 15:26:14 -0800707always_inline session_t *
Florin Corasba7d8f52019-02-22 13:11:38 -0800708listen_session_get (u32 ls_index)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700709{
Florin Corasba7d8f52019-02-22 13:11:38 -0800710 return session_get (ls_index, 0);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700711}
712
713always_inline void
Florin Corasba7d8f52019-02-22 13:11:38 -0800714listen_session_free (session_t * s)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700715{
Florin Coras87b7e3d2020-03-27 15:06:07 +0000716 ASSERT (!s->rx_fifo);
Florin Coras5c9083d2018-04-13 06:39:07 -0700717 session_free (s);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700718}
719
Florin Corasea727642021-05-07 19:39:43 -0700720always_inline session_t *
721ho_session_alloc (void)
722{
723 session_t *s;
Florin Coras309f7aa2022-03-18 08:33:08 -0700724 ASSERT (session_vlib_thread_is_cl_thread ());
725 s = session_alloc (transport_cl_thread ());
Florin Corasea727642021-05-07 19:39:43 -0700726 s->session_state = SESSION_STATE_CONNECTING;
727 s->flags |= SESSION_F_HALF_OPEN;
728 return s;
729}
730
731always_inline session_t *
732ho_session_get (u32 ho_index)
733{
Florin Coras309f7aa2022-03-18 08:33:08 -0700734 return session_get (ho_index, transport_cl_thread ());
Florin Corasea727642021-05-07 19:39:43 -0700735}
736
737always_inline void
738ho_session_free (session_t *s)
739{
740 ASSERT (!s->rx_fifo && s->thread_index == 0);
741 session_free (s);
742}
743
Florin Coras288eaab2019-02-03 15:26:14 -0800744transport_connection_t *listen_session_get_transport (session_t * s);
Florin Coras3cbc04b2017-10-02 00:18:51 -0700745
Florin Coras1ee78302019-02-05 15:51:15 -0800746/*
Florin Coras31c99552019-03-01 13:00:58 -0800747 * Session layer functions
Florin Coras1ee78302019-02-05 15:51:15 -0800748 */
749
Florin Coras31c99552019-03-01 13:00:58 -0800750always_inline session_main_t *
751vnet_get_session_main ()
Florin Coras1ee78302019-02-05 15:51:15 -0800752{
Florin Coras31c99552019-03-01 13:00:58 -0800753 return &session_main;
Florin Coras1ee78302019-02-05 15:51:15 -0800754}
755
Florin Coras31c99552019-03-01 13:00:58 -0800756always_inline session_worker_t *
757session_main_get_worker (u32 thread_index)
Florin Coras1ee78302019-02-05 15:51:15 -0800758{
Benoît Gannec5b0fcd2022-12-22 15:01:32 +0100759 return vec_elt_at_index (session_main.wrk, thread_index);
Florin Coras1ee78302019-02-05 15:51:15 -0800760}
761
Florin Coras5bb23ec2019-08-31 09:45:13 -0700762static inline session_worker_t *
763session_main_get_worker_if_valid (u32 thread_index)
764{
Nathan Skrzypczak901467e2019-12-04 11:02:28 +0100765 if (thread_index > vec_len (session_main.wrk))
Florin Coras5bb23ec2019-08-31 09:45:13 -0700766 return 0;
Benoît Gannec5b0fcd2022-12-22 15:01:32 +0100767 return session_main_get_worker (thread_index);
Florin Coras5bb23ec2019-08-31 09:45:13 -0700768}
769
Florin Coras1ee78302019-02-05 15:51:15 -0800770always_inline svm_msg_q_t *
Florin Coras31c99552019-03-01 13:00:58 -0800771session_main_get_vpp_event_queue (u32 thread_index)
Florin Coras1ee78302019-02-05 15:51:15 -0800772{
Benoît Gannec5b0fcd2022-12-22 15:01:32 +0100773 return session_main_get_worker (thread_index)->vpp_event_queue;
Florin Coras1ee78302019-02-05 15:51:15 -0800774}
Florin Corasfd542f12018-05-16 19:28:24 -0700775
Florin Coras6cf30ad2017-04-04 23:08:23 -0700776always_inline u8
Florin Coras31c99552019-03-01 13:00:58 -0800777session_main_is_enabled ()
Florin Coras6cf30ad2017-04-04 23:08:23 -0700778{
Florin Coras31c99552019-03-01 13:00:58 -0800779 return session_main.is_enabled == 1;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700780}
781
Filip Tehlarac3c8dc2023-03-14 08:50:28 +0100782always_inline void
783session_worker_stat_error_inc (session_worker_t *wrk, int error, int value)
784{
785 if ((-(error) >= 0 && -(error) < SESSION_N_ERRORS))
786 wrk->stats.errors[-error] += value;
787 else
788 SESSION_DBG ("unknown session counter");
789}
790
791always_inline void
792session_stat_error_inc (int error, int value)
793{
794 session_worker_t *wrk;
795 wrk = session_main_get_worker (vlib_get_thread_index ());
796 session_worker_stat_error_inc (wrk, error, value);
797}
798
Florin Corascea194d2017-10-02 00:18:51 -0700799#define session_cli_return_if_not_enabled() \
800do { \
Florin Coras5bb23ec2019-08-31 09:45:13 -0700801 if (!session_main.is_enabled) \
802 return clib_error_return (0, "session layer is not enabled"); \
Florin Corascea194d2017-10-02 00:18:51 -0700803} while (0)
804
Florin Coras0242d302022-12-22 15:03:44 -0800805void session_main_flush_enqueue_events (transport_proto_t transport_proto,
806 u32 thread_index);
Florin Coras5484daa2020-03-27 23:55:06 +0000807void session_queue_run_on_main_thread (vlib_main_t * vm);
Florin Coras2a7ea2e2019-10-16 22:06:08 -0700808
Florin Coras5484daa2020-03-27 23:55:06 +0000809/**
810 * Add session node pending buffer with custom node
811 *
812 * @param thread_index worker thread expected to send the buffer
813 * @param bi buffer index
814 * @param next_node next node edge index for buffer. Edge to next node
815 * must exist
816 */
Florin Coras2a7ea2e2019-10-16 22:06:08 -0700817always_inline void
Florin Coras5484daa2020-03-27 23:55:06 +0000818session_add_pending_tx_buffer (u32 thread_index, u32 bi, u32 next_node)
Florin Coras2a7ea2e2019-10-16 22:06:08 -0700819{
820 session_worker_t *wrk = session_main_get_worker (thread_index);
821 vec_add1 (wrk->pending_tx_buffers, bi);
Florin Coras5484daa2020-03-27 23:55:06 +0000822 vec_add1 (wrk->pending_tx_nexts, next_node);
Florin Coras7da88292021-03-18 15:04:34 -0700823 if (PREDICT_FALSE (wrk->state == SESSION_WRK_INTERRUPT))
824 vlib_node_set_interrupt_pending (wrk->vm, session_queue_node.index);
Florin Coras2a7ea2e2019-10-16 22:06:08 -0700825}
826
Florin Coras8f10b902021-04-02 18:32:00 -0700827always_inline void
828session_wrk_update_time (session_worker_t *wrk, f64 now)
829{
830 wrk->last_vlib_time = now;
831 wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
832}
833
Florin Coras7da88292021-03-18 15:04:34 -0700834void session_wrk_enable_adaptive_mode (session_worker_t *wrk);
Florin Coras8afe1b82021-11-17 23:38:54 -0800835fifo_segment_t *session_main_get_wrk_mqs_segment (void);
Dave Barach2a863912017-11-28 10:11:42 -0500836void session_node_enable_disable (u8 is_en);
Steven Luongc4b5d102024-07-30 13:44:01 -0700837clib_error_t *
838vnet_session_enable_disable (vlib_main_t *vm,
839 session_enable_disable_args_t *args);
Damjan Mariondd298e82022-10-12 16:02:18 +0200840void session_wrk_handle_evts_main_rpc (void *);
Florin Coras0242d302022-12-22 15:03:44 -0800841void session_wrk_program_app_wrk_evts (session_worker_t *wrk,
842 u32 app_wrk_index);
Dave Barach2a863912017-11-28 10:11:42 -0500843
Andreas Schultz1a8c4372020-03-20 09:39:59 +0100844session_t *session_alloc_for_connection (transport_connection_t * tc);
Florin Coras2c876f92021-05-10 21:12:27 -0700845session_t *session_alloc_for_half_open (transport_connection_t *tc);
qinyangaf9b7152023-06-27 01:11:53 -0700846void session_get_original_dst (transport_endpoint_t *i2o_src,
847 transport_endpoint_t *i2o_dst,
848 transport_proto_t transport_proto,
849 u32 *original_dst, u16 *original_dst_port);
Andreas Schultz1a8c4372020-03-20 09:39:59 +0100850
Florin Coras53d8d4f2022-03-09 13:55:38 -0800851typedef void (pool_safe_realloc_rpc_fn) (void *rpc_args);
852
853typedef struct
854{
855 u8 ph[STRUCT_OFFSET_OF (pool_header_t, max_elts) + 4];
856 u32 flag;
857} pool_safe_realloc_header_t;
858
859STATIC_ASSERT_SIZEOF (pool_safe_realloc_header_t, sizeof (pool_header_t));
860
861#define POOL_REALLOC_SAFE_ELT_THRESH 32
862
863#define pool_realloc_flag(PH) \
864 ((pool_safe_realloc_header_t *) pool_header (PH))->flag
865
Florin Corasd3915dc2022-03-31 15:42:17 -0700866typedef struct pool_realloc_rpc_args_
867{
868 void **pool;
869 uword elt_size;
870 uword align;
871} pool_realloc_rpc_args_t;
Florin Coras53d8d4f2022-03-09 13:55:38 -0800872
873always_inline void
Florin Corasd3915dc2022-03-31 15:42:17 -0700874pool_program_safe_realloc_rpc (void *args)
Florin Coras53d8d4f2022-03-09 13:55:38 -0800875{
Florin Corasd3915dc2022-03-31 15:42:17 -0700876 vlib_main_t *vm = vlib_get_main ();
877 u32 free_elts, max_elts, n_alloc;
878 pool_realloc_rpc_args_t *pra;
879
880 ASSERT (vlib_get_thread_index () == 0);
881 pra = (pool_realloc_rpc_args_t *) args;
882
883 vlib_worker_thread_barrier_sync (vm);
884
885 free_elts = _pool_free_elts (*pra->pool, pra->elt_size);
886 if (free_elts < POOL_REALLOC_SAFE_ELT_THRESH)
887 {
888 max_elts = _vec_max_len (*pra->pool, pra->elt_size);
889 n_alloc = clib_max (2 * max_elts, POOL_REALLOC_SAFE_ELT_THRESH);
Florin Corase8d8d472022-11-09 15:13:16 -0800890 _pool_alloc (pra->pool, n_alloc, pra->align, 0, pra->elt_size);
Florin Corasd3915dc2022-03-31 15:42:17 -0700891 }
892 pool_realloc_flag (*pra->pool) = 0;
893 clib_mem_free (args);
894
895 vlib_worker_thread_barrier_release (vm);
896}
897
898always_inline void
899pool_program_safe_realloc (void **p, u32 elt_size, u32 align)
900{
901 pool_realloc_rpc_args_t *pra;
902
Florin Coras53d8d4f2022-03-09 13:55:38 -0800903 /* Reuse pad as a realloc flag */
Florin Corasd3915dc2022-03-31 15:42:17 -0700904 if (pool_realloc_flag (*p))
Florin Coras53d8d4f2022-03-09 13:55:38 -0800905 return;
906
Florin Corasd3915dc2022-03-31 15:42:17 -0700907 pra = clib_mem_alloc (sizeof (*pra));
908 pra->pool = p;
909 pra->elt_size = elt_size;
910 pra->align = align;
911 pool_realloc_flag (*p) = 1;
912
913 session_send_rpc_evt_to_thread (0 /* thread index */,
914 pool_program_safe_realloc_rpc, pra);
Florin Coras53d8d4f2022-03-09 13:55:38 -0800915}
916
Florin Coras53d8d4f2022-03-09 13:55:38 -0800917#define pool_needs_realloc(P) \
918 ((!P) || \
919 (vec_len (pool_header (P)->free_indices) < POOL_REALLOC_SAFE_ELT_THRESH && \
920 pool_free_elts (P) < POOL_REALLOC_SAFE_ELT_THRESH))
921
Florin Corasd3915dc2022-03-31 15:42:17 -0700922#define pool_get_aligned_safe(P, E, align) \
Florin Coras53d8d4f2022-03-09 13:55:38 -0800923 do \
924 { \
Florin Coras53d8d4f2022-03-09 13:55:38 -0800925 if (PREDICT_FALSE (pool_needs_realloc (P))) \
926 { \
927 if (PREDICT_FALSE (!(P))) \
928 { \
Florin Corasd3915dc2022-03-31 15:42:17 -0700929 pool_alloc_aligned (P, POOL_REALLOC_SAFE_ELT_THRESH, align); \
Florin Coras53d8d4f2022-03-09 13:55:38 -0800930 } \
Florin Coras5b47a6d2022-03-26 01:25:02 -0700931 else if (PREDICT_FALSE (!pool_free_elts (P))) \
Florin Coras53d8d4f2022-03-09 13:55:38 -0800932 { \
Florin Coras4b208302022-03-30 13:50:19 -0700933 vlib_workers_sync (); \
Florin Coras5b47a6d2022-03-26 01:25:02 -0700934 pool_alloc_aligned (P, pool_max_len (P), align); \
Florin Coras4b208302022-03-30 13:50:19 -0700935 vlib_workers_continue (); \
Florin Coras5b47a6d2022-03-26 01:25:02 -0700936 ALWAYS_ASSERT (pool_free_elts (P) > 0); \
Florin Coras53d8d4f2022-03-09 13:55:38 -0800937 } \
938 else \
939 { \
Florin Corasd3915dc2022-03-31 15:42:17 -0700940 pool_program_safe_realloc ((void **) &(P), sizeof ((P)[0]), \
941 _vec_align (P, align)); \
Florin Coras53d8d4f2022-03-09 13:55:38 -0800942 } \
943 } \
944 pool_get_aligned (P, E, align); \
945 } \
946 while (0)
947
Steven Luongc4b5d102024-07-30 13:44:01 -0700948always_inline u8
949session_is_enabled_without_rt_backend (void)
950{
951 session_main_t *smm = vnet_get_session_main ();
952
953 return (smm->rt_engine_type == RT_BACKEND_ENGINE_NONE);
954}
955
956always_inline u8
957session_sdl_is_enabled (void)
958{
959 session_main_t *smm = vnet_get_session_main ();
960
961 return (smm->rt_engine_type == RT_BACKEND_ENGINE_SDL);
962}
963
964always_inline u8
965session_rule_table_is_enabled (void)
966{
967 session_main_t *smm = vnet_get_session_main ();
968
969 return (smm->rt_engine_type == RT_BACKEND_ENGINE_RULE_TABLE);
970}
971
Dave Barach68b0fb02017-02-28 15:15:56 -0500972#endif /* __included_session_h__ */
973
974/*
975 * fd.io coding-style-patch-verification: ON
976 *
977 * Local Variables:
978 * eval: (c-set-style "gnu")
979 * End:
980 */