blob: 35c8fb4069fa2de4b1daec0e46a9a7488aeae2db [file] [log] [blame]
Dave Barach68b0fb02017-02-28 15:15:56 -05001/*
2 * Copyright (c) 2017 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15#ifndef __included_session_h__
16#define __included_session_h__
17
Florin Coras04e53442017-07-16 17:12:15 -070018#include <vnet/session/stream_session.h>
19#include <vnet/session/session_lookup.h>
20#include <vnet/session/transport_interface.h>
Florin Coras3e350af2017-03-30 02:54:28 -070021#include <vnet/session/session_debug.h>
Florin Coras6cf30ad2017-04-04 23:08:23 -070022#include <vnet/session/segment_manager.h>
Florin Corase86a8ed2018-01-05 03:20:25 -080023#include <svm/queue.h>
Dave Barach68b0fb02017-02-28 15:15:56 -050024
25#define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
26#define INVALID_INDEX ((u32)~0)
Florin Corasab2f6db2018-08-31 14:31:41 -070027#define SESSION_PROXY_LISTENER_INDEX ((u8)~0 - 1)
Florin Coras5fda7a32018-02-14 08:04:31 -080028#define SESSION_LOCAL_HANDLE_PREFIX 0x7FFFFFFF
Dave Barach68b0fb02017-02-28 15:15:56 -050029
30/* TODO decide how much since we have pre-data as well */
31#define MAX_HDRS_LEN 100 /* Max number of bytes for headers */
32
33typedef enum
34{
Florin Corasa5464812017-04-19 13:00:05 -070035 FIFO_EVENT_APP_RX,
Florin Coras460dce62018-07-27 05:45:06 -070036 SESSION_IO_EVT_CT_RX,
Florin Corasa5464812017-04-19 13:00:05 -070037 FIFO_EVENT_APP_TX,
Florin Coras460dce62018-07-27 05:45:06 -070038 SESSION_IO_EVT_CT_TX,
Florin Corasa5464812017-04-19 13:00:05 -070039 FIFO_EVENT_DISCONNECT,
Dave Barache5f1d272017-05-10 13:34:04 -040040 FIFO_EVENT_BUILTIN_RX,
Florin Corasef915342018-09-29 10:23:06 -070041 FIFO_EVENT_BUILTIN_TX,
Dave Barache5f1d272017-05-10 13:34:04 -040042 FIFO_EVENT_RPC,
Florin Coras60116992018-08-27 09:52:18 -070043 SESSION_CTRL_EVT_BOUND,
Florin Coras52207f12018-07-12 14:48:06 -070044 SESSION_CTRL_EVT_ACCEPTED,
45 SESSION_CTRL_EVT_ACCEPTED_REPLY,
46 SESSION_CTRL_EVT_CONNECTED,
47 SESSION_CTRL_EVT_CONNECTED_REPLY,
48 SESSION_CTRL_EVT_DISCONNECTED,
49 SESSION_CTRL_EVT_DISCONNECTED_REPLY,
50 SESSION_CTRL_EVT_RESET,
51 SESSION_CTRL_EVT_RESET_REPLY
Florin Coras3c2fed52018-07-04 04:15:05 -070052} session_evt_type_t;
Dave Barach68b0fb02017-02-28 15:15:56 -050053
Dave Wallace33e002b2017-09-06 01:20:02 -040054static inline const char *
Florin Coras3c2fed52018-07-04 04:15:05 -070055fifo_event_type_str (session_evt_type_t et)
Dave Wallace33e002b2017-09-06 01:20:02 -040056{
57 switch (et)
58 {
59 case FIFO_EVENT_APP_RX:
60 return "FIFO_EVENT_APP_RX";
61 case FIFO_EVENT_APP_TX:
62 return "FIFO_EVENT_APP_TX";
Dave Wallace33e002b2017-09-06 01:20:02 -040063 case FIFO_EVENT_DISCONNECT:
64 return "FIFO_EVENT_DISCONNECT";
65 case FIFO_EVENT_BUILTIN_RX:
66 return "FIFO_EVENT_BUILTIN_RX";
67 case FIFO_EVENT_RPC:
68 return "FIFO_EVENT_RPC";
69 default:
70 return "UNKNOWN FIFO EVENT";
71 }
72}
73
Florin Coras3c2fed52018-07-04 04:15:05 -070074typedef enum
75{
76 SESSION_MQ_IO_EVT_RING,
77 SESSION_MQ_CTRL_EVT_RING,
78 SESSION_MQ_N_RINGS
79} session_mq_rings_e;
80
Florin Coras3e350af2017-03-30 02:54:28 -070081#define foreach_session_input_error \
Dave Barach68b0fb02017-02-28 15:15:56 -050082_(NO_SESSION, "No session drops") \
83_(NO_LISTENER, "No listener for dst port drops") \
84_(ENQUEUED, "Packets pushed into rx fifo") \
85_(NOT_READY, "Session not ready packets") \
86_(FIFO_FULL, "Packets dropped for lack of rx fifo space") \
87_(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space") \
88_(API_QUEUE_FULL, "Sessions not created for lack of API queue space") \
89_(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair") \
Florin Corasa332c462018-01-31 06:52:17 -080090_(NO_SPACE, "Couldn't allocate a fifo pair") \
91_(SEG_CREATE, "Couldn't create a new segment")
Dave Barach68b0fb02017-02-28 15:15:56 -050092
93typedef enum
94{
95#define _(sym,str) SESSION_ERROR_##sym,
96 foreach_session_input_error
97#undef _
98 SESSION_N_ERROR,
99} session_error_t;
100
Dave Barache5f1d272017-05-10 13:34:04 -0400101typedef struct
102{
103 void *fp;
104 void *arg;
Florin Coras3c2fed52018-07-04 04:15:05 -0700105} session_rpc_args_t;
Dave Barache5f1d272017-05-10 13:34:04 -0400106
Florin Corasf8f516a2018-02-08 15:10:09 -0800107typedef u64 session_handle_t;
108
Florin Coras6792ec02017-03-13 03:49:51 -0700109/* *INDENT-OFF* */
Florin Coras3c2fed52018-07-04 04:15:05 -0700110typedef struct
111{
Florin Coras6792ec02017-03-13 03:49:51 -0700112 u8 event_type;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700113 u8 postponed;
Florin Coras3c2fed52018-07-04 04:15:05 -0700114 union
115 {
116 svm_fifo_t *fifo;
117 session_handle_t session_handle;
118 session_rpc_args_t rpc_args;
119 struct
120 {
121 u8 data[0];
122 };
123 };
Florin Coras52207f12018-07-12 14:48:06 -0700124} __clib_packed session_event_t;
Florin Coras6792ec02017-03-13 03:49:51 -0700125/* *INDENT-ON* */
Dave Barach68b0fb02017-02-28 15:15:56 -0500126
Florin Coras3c2fed52018-07-04 04:15:05 -0700127#define SESSION_MSG_NULL { }
128
Florin Coras8e43d042018-05-04 15:46:57 -0700129typedef struct session_dgram_pre_hdr_
130{
131 u32 data_length;
132 u32 data_offset;
133} session_dgram_pre_hdr_t;
134
135/* *INDENT-OFF* */
136typedef CLIB_PACKED (struct session_dgram_header_
137{
138 u32 data_length;
139 u32 data_offset;
140 ip46_address_t rmt_ip;
141 ip46_address_t lcl_ip;
142 u16 rmt_port;
143 u16 lcl_port;
144 u8 is_ip4;
145}) session_dgram_hdr_t;
146/* *INDENT-ON* */
147
148#define SESSION_CONN_ID_LEN 37
149#define SESSION_CONN_HDR_LEN 45
150
151STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
152 "session conn id wrong length");
153
154typedef struct session_tx_context_
155{
156 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
157 stream_session_t *s;
158 transport_proto_vft_t *transport_vft;
159 transport_connection_t *tc;
160 vlib_buffer_t *b;
161 u32 max_dequeue;
162 u32 snd_space;
163 u32 left_to_snd;
164 u32 tx_offset;
165 u32 max_len_to_snd;
166 u16 deq_per_first_buf;
167 u16 deq_per_buf;
168 u16 snd_mss;
Florin Corasf08f26d2018-05-10 13:20:47 -0700169 u16 n_segs_per_evt;
Florin Coras8e43d042018-05-04 15:46:57 -0700170 u8 n_bufs_per_seg;
171 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
172 session_dgram_hdr_t hdr;
173} session_tx_context_t;
174
Dave Barach68b0fb02017-02-28 15:15:56 -0500175/* Forward definition */
176typedef struct _session_manager_main session_manager_main_t;
177
178typedef int
179 (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
Florin Coras52207f12018-07-12 14:48:06 -0700180 session_event_t * e0, stream_session_t * s0,
Florin Coras8e43d042018-05-04 15:46:57 -0700181 int *n_tx_pkts);
Dave Barach68b0fb02017-02-28 15:15:56 -0500182
Florin Corasd79b41e2017-03-04 05:37:52 -0800183extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
184extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
Florin Coras371ca502018-02-21 12:07:41 -0800185extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
Dave Barach68b0fb02017-02-28 15:15:56 -0500186
Florin Coras52207f12018-07-12 14:48:06 -0700187u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
Florin Coras6534b7a2017-07-18 05:38:03 -0400188
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700189typedef struct session_manager_worker_
Dave Barach68b0fb02017-02-28 15:15:56 -0500190{
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700191 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
Dave Barach68b0fb02017-02-28 15:15:56 -0500192
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700193 /** Worker session pool */
194 stream_session_t *sessions;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700195
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700196 /** vpp event message queue for worker */
197 svm_msg_q_t *vpp_event_queue;
Florin Coras8e43d042018-05-04 15:46:57 -0700198
Florin Corasd67f1122018-05-21 17:47:40 -0700199 /** Our approximation of a "complete" dispatch loop period */
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700200 f64 dispatch_period;
Florin Corasd67f1122018-05-21 17:47:40 -0700201
202 /** vlib_time_now last time around the track */
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700203 f64 last_vlib_time;
Florin Corasd67f1122018-05-21 17:47:40 -0700204
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700205 /** Per-proto enqueue epoch counters */
206 u64 current_enqueue_epoch[TRANSPORT_N_PROTO];
207
208 /** Per-proto vector of sessions to enqueue */
209 u32 *session_to_enqueue[TRANSPORT_N_PROTO];
210
211 /** Context for session tx */
212 session_tx_context_t ctx;
213
214 /** Vector of tx buffer free lists */
215 u32 *tx_buffers;
216
217 /** Vector of partially read events */
218 session_event_t *free_event_vector;
219
220 /** Vector of active event vectors */
221 session_event_t *pending_event_vector;
222
223 /** Vector of postponed disconnects */
224 session_event_t *pending_disconnects;
225
Florin Coras5f56d732018-10-30 10:21:59 -0700226 /** Vector of postponed events */
227 session_event_t *postponed_event_vector;
228
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700229 /** Peekers rw lock */
230 clib_rwlock_t peekers_rw_locks;
231
Florin Corasc44a5582018-11-01 16:30:54 -0700232 u32 last_tx_packets;
233
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700234} session_manager_worker_t;
235
236struct _session_manager_main
237{
238 /** Worker contexts */
239 session_manager_worker_t *wrk;
Dave Barach68b0fb02017-02-28 15:15:56 -0500240
Florin Corasb384b542018-01-15 01:08:33 -0800241 /** Event queues memfd segment initialized only if so configured */
242 ssvm_private_t evt_qs_segment;
243
Florin Coras93e65802017-11-29 00:07:11 -0500244 /** Unique segment name counter */
245 u32 unique_segment_name_counter;
246
247 /** Per transport rx function that can either dequeue or peek */
Florin Coras561af9b2017-12-09 10:19:43 -0800248 session_fifo_rx_fn **session_tx_fns;
249
250 /** Per session type output nodes. Could optimize to group nodes by
251 * fib but lookup would then require session type parsing in session node.
252 * Trade memory for speed, for now */
253 u32 *session_type_to_next;
Florin Coras93e65802017-11-29 00:07:11 -0500254
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700255 /*
256 * Config parameters
257 */
258
Florin Coras93e65802017-11-29 00:07:11 -0500259 /** Session manager is enabled */
260 u8 is_enabled;
261
Dave Barach10d8cc62017-05-30 09:30:07 -0400262 /** vpp fifo event queue configured length */
263 u32 configured_event_queue_length;
264
Florin Corasb384b542018-01-15 01:08:33 -0800265 /** Session ssvm segment configs*/
266 uword session_baseva;
Florin Corasa332c462018-01-31 06:52:17 -0800267 uword session_va_space_size;
Florin Corasb384b542018-01-15 01:08:33 -0800268 u32 evt_qs_segment_size;
269 u8 evt_qs_use_memfd_seg;
270
271 /** Session table size parameters */
Florin Coras66b11312017-07-31 17:18:03 -0700272 u32 configured_v4_session_table_buckets;
273 u32 configured_v4_session_table_memory;
274 u32 configured_v4_halfopen_table_buckets;
275 u32 configured_v4_halfopen_table_memory;
276 u32 configured_v6_session_table_buckets;
277 u32 configured_v6_session_table_memory;
278 u32 configured_v6_halfopen_table_buckets;
279 u32 configured_v6_halfopen_table_memory;
280
Florin Coras93e65802017-11-29 00:07:11 -0500281 /** Transport table (preallocation) size parameters */
282 u32 local_endpoints_table_memory;
283 u32 local_endpoints_table_buckets;
Florin Corase04c2992017-03-01 08:17:34 -0800284
Dave Barach2c25a622017-06-26 11:35:07 -0400285 /** Preallocate session config parameter */
286 u32 preallocated_sessions;
287
Florin Corasc1a448b2018-04-20 10:51:49 -0700288#if SESSION_DEBUG
Florin Coras3e350af2017-03-30 02:54:28 -0700289 /**
290 * last event poll time by thread
291 * Debug only. Will cause false cache-line sharing as-is
292 */
293 f64 *last_event_poll_by_thread;
294#endif
295
Dave Barach68b0fb02017-02-28 15:15:56 -0500296};
297
298extern session_manager_main_t session_manager_main;
Florin Corase04c2992017-03-01 08:17:34 -0800299extern vlib_node_registration_t session_queue_node;
Florin Corasfd542f12018-05-16 19:28:24 -0700300extern vlib_node_registration_t session_queue_process_node;
301
302#define SESSION_Q_PROCESS_FLUSH_FRAMES 1
303#define SESSION_Q_PROCESS_STOP 2
Dave Barach68b0fb02017-02-28 15:15:56 -0500304
305/*
306 * Session manager function
307 */
308always_inline session_manager_main_t *
309vnet_get_session_manager_main ()
310{
311 return &session_manager_main;
312}
313
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700314always_inline session_manager_worker_t *
315session_manager_get_worker (u32 thread_index)
316{
317 return &session_manager_main.wrk[thread_index];
318}
319
Dave Barach2c25a622017-06-26 11:35:07 -0400320always_inline u8
321stream_session_is_valid (u32 si, u8 thread_index)
322{
323 stream_session_t *s;
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700324 s = pool_elt_at_index (session_manager_main.wrk[thread_index].sessions, si);
Dave Barach2c25a622017-06-26 11:35:07 -0400325 if (s->thread_index != thread_index || s->session_index != si
Dave Barach52851e62017-08-07 09:35:25 -0400326 /* || s->server_rx_fifo->master_session_index != si
327 || s->server_tx_fifo->master_session_index != si
328 || s->server_rx_fifo->master_thread_index != thread_index
329 || s->server_tx_fifo->master_thread_index != thread_index */ )
Dave Barach2c25a622017-06-26 11:35:07 -0400330 return 0;
331 return 1;
332}
333
Florin Coras3cbc04b2017-10-02 00:18:51 -0700334stream_session_t *session_alloc (u32 thread_index);
Florin Coras371ca502018-02-21 12:07:41 -0800335int session_alloc_fifos (segment_manager_t * sm, stream_session_t * s);
336void session_free (stream_session_t * s);
Florin Coraseb97e5f2018-10-15 21:35:42 -0700337void session_free_w_fifos (stream_session_t * s);
Florin Coras3cbc04b2017-10-02 00:18:51 -0700338
Dave Barach68b0fb02017-02-28 15:15:56 -0500339always_inline stream_session_t *
Florin Corascea194d2017-10-02 00:18:51 -0700340session_get (u32 si, u32 thread_index)
Dave Barach68b0fb02017-02-28 15:15:56 -0500341{
Dave Barach2c25a622017-06-26 11:35:07 -0400342 ASSERT (stream_session_is_valid (si, thread_index));
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700343 return pool_elt_at_index (session_manager_main.wrk[thread_index].sessions,
344 si);
Dave Barach68b0fb02017-02-28 15:15:56 -0500345}
346
347always_inline stream_session_t *
Florin Coras3cbc04b2017-10-02 00:18:51 -0700348session_get_if_valid (u64 si, u32 thread_index)
Dave Barach68b0fb02017-02-28 15:15:56 -0500349{
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700350 if (thread_index >= vec_len (session_manager_main.wrk))
Dave Barach68b0fb02017-02-28 15:15:56 -0500351 return 0;
352
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700353 if (pool_is_free_index (session_manager_main.wrk[thread_index].sessions,
354 si))
Dave Barach68b0fb02017-02-28 15:15:56 -0500355 return 0;
356
Dave Barach2c25a622017-06-26 11:35:07 -0400357 ASSERT (stream_session_is_valid (si, thread_index));
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700358 return pool_elt_at_index (session_manager_main.wrk[thread_index].sessions,
359 si);
Dave Barach68b0fb02017-02-28 15:15:56 -0500360}
361
Florin Corasf8f516a2018-02-08 15:10:09 -0800362always_inline session_handle_t
Florin Coras3cbc04b2017-10-02 00:18:51 -0700363session_handle (stream_session_t * s)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700364{
365 return ((u64) s->thread_index << 32) | (u64) s->session_index;
366}
367
368always_inline u32
Florin Corasf8f516a2018-02-08 15:10:09 -0800369session_index_from_handle (session_handle_t handle)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700370{
371 return handle & 0xFFFFFFFF;
372}
373
374always_inline u32
Florin Corasf8f516a2018-02-08 15:10:09 -0800375session_thread_from_handle (session_handle_t handle)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700376{
377 return handle >> 32;
378}
379
380always_inline void
Florin Corasf8f516a2018-02-08 15:10:09 -0800381session_parse_handle (session_handle_t handle, u32 * index,
382 u32 * thread_index)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700383{
Florin Corascea194d2017-10-02 00:18:51 -0700384 *index = session_index_from_handle (handle);
385 *thread_index = session_thread_from_handle (handle);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700386}
387
388always_inline stream_session_t *
Florin Corasf8f516a2018-02-08 15:10:09 -0800389session_get_from_handle (session_handle_t handle)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700390{
391 session_manager_main_t *smm = &session_manager_main;
Florin Corasf8f516a2018-02-08 15:10:09 -0800392 u32 session_index, thread_index;
393 session_parse_handle (handle, &session_index, &thread_index);
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700394 return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
Florin Corasf8f516a2018-02-08 15:10:09 -0800395}
396
397always_inline stream_session_t *
398session_get_from_handle_if_valid (session_handle_t handle)
399{
400 u32 session_index, thread_index;
401 session_parse_handle (handle, &session_index, &thread_index);
402 return session_get_if_valid (session_index, thread_index);
403}
404
405always_inline u8
406session_handle_is_local (session_handle_t handle)
407{
Florin Coras5fda7a32018-02-14 08:04:31 -0800408 if ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX)
Florin Corasf8f516a2018-02-08 15:10:09 -0800409 return 1;
410 return 0;
411}
412
413always_inline transport_proto_t
414session_type_transport_proto (session_type_t st)
415{
416 return (st >> 1);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700417}
418
Florin Coras5fda7a32018-02-14 08:04:31 -0800419always_inline u8
420session_type_is_ip4 (session_type_t st)
421{
422 return (st & 1);
423}
424
Florin Coras561af9b2017-12-09 10:19:43 -0800425always_inline transport_proto_t
426session_get_transport_proto (stream_session_t * s)
427{
428 return (s->session_type >> 1);
429}
430
Florin Corasf8f516a2018-02-08 15:10:09 -0800431always_inline fib_protocol_t
432session_get_fib_proto (stream_session_t * s)
433{
434 u8 is_ip4 = s->session_type & 1;
435 return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
436}
437
Florin Coras561af9b2017-12-09 10:19:43 -0800438always_inline session_type_t
439session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
440{
441 return (proto << 1 | is_ip4);
442}
443
Florin Corasf8f516a2018-02-08 15:10:09 -0800444always_inline u8
445session_has_transport (stream_session_t * s)
446{
447 return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
448}
449
Florin Corasf08f26d2018-05-10 13:20:47 -0700450transport_service_type_t session_transport_service_type (stream_session_t *);
451transport_tx_fn_type_t session_transport_tx_fn_type (stream_session_t *);
452u8 session_tx_is_dgram (stream_session_t * s);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700453
Florin Coras3cbc04b2017-10-02 00:18:51 -0700454/**
455 * Acquires a lock that blocks a session pool from expanding.
456 *
457 * This is typically used for safely peeking into other threads'
458 * pools in order to clone elements. Lock should be dropped as soon
459 * as possible by calling @ref session_pool_remove_peeker.
460 *
461 * NOTE: Avoid using pool_elt_at_index while the lock is held because
462 * it may lead to free elt bitmap expansion/contraction!
463 */
464always_inline void
465session_pool_add_peeker (u32 thread_index)
466{
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700467 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
Florin Coras3cbc04b2017-10-02 00:18:51 -0700468 if (thread_index == vlib_get_thread_index ())
469 return;
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700470 clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
Florin Coras3cbc04b2017-10-02 00:18:51 -0700471}
472
473always_inline void
474session_pool_remove_peeker (u32 thread_index)
475{
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700476 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
Florin Coras3cbc04b2017-10-02 00:18:51 -0700477 if (thread_index == vlib_get_thread_index ())
478 return;
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700479 clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
Florin Coras3cbc04b2017-10-02 00:18:51 -0700480}
481
482/**
483 * Get session from handle and 'lock' pool resize if not in same thread
484 *
485 * Caller should drop the peek 'lock' as soon as possible.
486 */
487always_inline stream_session_t *
488session_get_from_handle_safe (u64 handle)
489{
Florin Coras3cbc04b2017-10-02 00:18:51 -0700490 u32 thread_index = session_thread_from_handle (handle);
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700491 session_manager_worker_t *wrk = &session_manager_main.wrk[thread_index];
492
Florin Coras3cbc04b2017-10-02 00:18:51 -0700493 if (thread_index == vlib_get_thread_index ())
494 {
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700495 return pool_elt_at_index (wrk->sessions,
Florin Coras3cbc04b2017-10-02 00:18:51 -0700496 session_index_from_handle (handle));
497 }
498 else
499 {
500 session_pool_add_peeker (thread_index);
501 /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700502 return wrk->sessions + session_index_from_handle (handle);
Florin Coras3cbc04b2017-10-02 00:18:51 -0700503 }
504}
505
Dave Barach68b0fb02017-02-28 15:15:56 -0500506always_inline u32
Florin Corasd2aab832018-05-22 11:39:59 -0700507transport_max_rx_enqueue (transport_connection_t * tc)
Dave Barach68b0fb02017-02-28 15:15:56 -0500508{
Florin Corascea194d2017-10-02 00:18:51 -0700509 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
Dave Barach68b0fb02017-02-28 15:15:56 -0500510 return svm_fifo_max_enqueue (s->server_rx_fifo);
511}
512
Florin Corase04c2992017-03-01 08:17:34 -0800513always_inline u32
Florin Corasd2aab832018-05-22 11:39:59 -0700514transport_rx_fifo_size (transport_connection_t * tc)
Florin Corase04c2992017-03-01 08:17:34 -0800515{
Florin Corascea194d2017-10-02 00:18:51 -0700516 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
Florin Corase04c2992017-03-01 08:17:34 -0800517 return s->server_rx_fifo->nitems;
518}
519
Florin Coras3cbc04b2017-10-02 00:18:51 -0700520always_inline u32
Florin Corasd2aab832018-05-22 11:39:59 -0700521transport_tx_fifo_size (transport_connection_t * tc)
522{
523 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
524 return s->server_tx_fifo->nitems;
525}
526
Florin Coras7ac053b2018-11-05 15:57:21 -0800527always_inline u8
528transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
529{
530 stream_session_t *s = session_get (tc->c_index, tc->thread_index);
531 return svm_fifo_has_ooo_data (s->server_rx_fifo);
532}
533
Florin Corasd67f1122018-05-21 17:47:40 -0700534always_inline f64
535transport_dispatch_period (u32 thread_index)
536{
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700537 return session_manager_main.wrk[thread_index].dispatch_period;
Florin Corasd67f1122018-05-21 17:47:40 -0700538}
539
540always_inline f64
541transport_time_now (u32 thread_index)
542{
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700543 return session_manager_main.wrk[thread_index].last_vlib_time;
Florin Corasd67f1122018-05-21 17:47:40 -0700544}
545
Florin Corasd2aab832018-05-22 11:39:59 -0700546always_inline u32
Florin Coras3cbc04b2017-10-02 00:18:51 -0700547session_get_index (stream_session_t * s)
548{
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700549 return (s - session_manager_main.wrk[s->thread_index].sessions);
Florin Coras3cbc04b2017-10-02 00:18:51 -0700550}
551
552always_inline stream_session_t *
553session_clone_safe (u32 session_index, u32 thread_index)
554{
555 stream_session_t *old_s, *new_s;
556 u32 current_thread_index = vlib_get_thread_index ();
557
558 /* If during the memcpy pool is reallocated AND the memory allocator
559 * decides to give the old chunk of memory to somebody in a hurry to
560 * scribble something on it, we have a problem. So add this thread as
561 * a session pool peeker.
562 */
563 session_pool_add_peeker (thread_index);
564 new_s = session_alloc (current_thread_index);
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700565 old_s = session_manager_main.wrk[thread_index].sessions + session_index;
Florin Coras3cbc04b2017-10-02 00:18:51 -0700566 clib_memcpy (new_s, old_s, sizeof (*new_s));
567 session_pool_remove_peeker (thread_index);
568 new_s->thread_index = current_thread_index;
569 new_s->session_index = session_get_index (new_s);
570 return new_s;
571}
572
573transport_connection_t *session_get_transport (stream_session_t * s);
574
Florin Coras25579b42018-06-06 17:55:02 -0700575u32 session_tx_fifo_max_dequeue (transport_connection_t * tc);
Florin Coras93992a92017-05-24 18:03:56 -0700576
Dave Barach68b0fb02017-02-28 15:15:56 -0500577int
Florin Coras3cbc04b2017-10-02 00:18:51 -0700578session_enqueue_stream_connection (transport_connection_t * tc,
579 vlib_buffer_t * b, u32 offset,
580 u8 queue_event, u8 is_in_order);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700581int session_enqueue_dgram_connection (stream_session_t * s,
582 session_dgram_hdr_t * hdr,
583 vlib_buffer_t * b, u8 proto,
584 u8 queue_event);
Florin Coras3cbc04b2017-10-02 00:18:51 -0700585int stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
586 u32 offset, u32 max_bytes);
Dave Barach68b0fb02017-02-28 15:15:56 -0500587u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
588
Florin Coras3cbc04b2017-10-02 00:18:51 -0700589int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
590int session_dgram_connect_notify (transport_connection_t * tc,
591 u32 old_thread_index,
592 stream_session_t ** new_session);
Florin Coras0d60a0f2018-06-29 02:02:08 -0700593int session_dequeue_notify (stream_session_t * s);
Florin Corasc28764f2017-04-26 00:08:42 -0700594void stream_session_init_fifos_pointers (transport_connection_t * tc,
595 u32 rx_pointer, u32 tx_pointer);
Florin Corase69f4952017-03-07 10:06:24 -0800596
Dave Barach68b0fb02017-02-28 15:15:56 -0500597void stream_session_accept_notify (transport_connection_t * tc);
598void stream_session_disconnect_notify (transport_connection_t * tc);
599void stream_session_delete_notify (transport_connection_t * tc);
600void stream_session_reset_notify (transport_connection_t * tc);
Florin Coras3cbc04b2017-10-02 00:18:51 -0700601int stream_session_accept (transport_connection_t * tc, u32 listener_index,
602 u8 notify);
603int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
Florin Coras5665ced2018-10-25 18:03:45 -0700604int session_listen (stream_session_t * s, session_endpoint_cfg_t * sep);
Florin Corasab2f6db2018-08-31 14:31:41 -0700605int session_stop_listen (stream_session_t * s);
Dave Barach68b0fb02017-02-28 15:15:56 -0500606void stream_session_disconnect (stream_session_t * s);
Florin Coras2f8d8fa2018-01-26 06:36:04 -0800607void stream_session_disconnect_transport (stream_session_t * s);
Dave Barach68b0fb02017-02-28 15:15:56 -0500608void stream_session_cleanup (stream_session_t * s);
Florin Coras3c2fed52018-07-04 04:15:05 -0700609int session_send_io_evt_to_thread (svm_fifo_t * f,
610 session_evt_type_t evt_type);
Florin Corasef915342018-09-29 10:23:06 -0700611int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
Florin Coras3c2fed52018-07-04 04:15:05 -0700612 session_evt_type_t evt_type);
613void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
614 void *rpc_args);
Florin Coras568ebc72018-09-18 16:12:50 -0700615
Florin Corasb384b542018-01-15 01:08:33 -0800616ssvm_private_t *session_manager_get_evt_q_segment (void);
Florin Coras3eb50622017-07-13 01:24:57 -0400617
Dave Barach68b0fb02017-02-28 15:15:56 -0500618u8 *format_stream_session (u8 * s, va_list * args);
Florin Coras3eb50622017-07-13 01:24:57 -0400619uword unformat_stream_session (unformat_input_t * input, va_list * args);
620uword unformat_transport_connection (unformat_input_t * input,
621 va_list * args);
622
Florin Coras561af9b2017-12-09 10:19:43 -0800623void session_register_transport (transport_proto_t transport_proto,
624 const transport_proto_vft_t * vft, u8 is_ip4,
625 u32 output_node);
Dave Barach68b0fb02017-02-28 15:15:56 -0500626
Florin Coras3ec66b02018-08-23 16:27:05 -0700627always_inline void
628transport_add_tx_event (transport_connection_t * tc)
629{
630 stream_session_t *s = session_get (tc->s_index, tc->thread_index);
631 if (svm_fifo_has_event (s->server_tx_fifo))
632 return;
633 session_send_io_evt_to_thread (s->server_tx_fifo, FIFO_EVENT_APP_TX);
634}
635
Florin Corase04c2992017-03-01 08:17:34 -0800636clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
637
Florin Coras3c2fed52018-07-04 04:15:05 -0700638always_inline svm_msg_q_t *
Florin Coras6cf30ad2017-04-04 23:08:23 -0700639session_manager_get_vpp_event_queue (u32 thread_index)
640{
Florin Coras5a7ca7b2018-10-30 12:01:48 -0700641 return session_manager_main.wrk[thread_index].vpp_event_queue;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700642}
643
Florin Coras3cbc04b2017-10-02 00:18:51 -0700644int session_manager_flush_enqueue_events (u8 proto, u32 thread_index);
Florin Coras7fb0fe12018-04-09 09:24:52 -0700645int session_manager_flush_all_enqueue_events (u8 transport_proto);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700646
647always_inline u64
648listen_session_get_handle (stream_session_t * s)
649{
650 ASSERT (s->session_state == SESSION_STATE_LISTENING);
Florin Coras5c9083d2018-04-13 06:39:07 -0700651 return session_handle (s);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700652}
653
654always_inline stream_session_t *
Florin Corasf8f516a2018-02-08 15:10:09 -0800655listen_session_get_from_handle (session_handle_t handle)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700656{
Florin Coras5c9083d2018-04-13 06:39:07 -0700657 return session_get_from_handle (handle);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700658}
659
Florin Coras371ca502018-02-21 12:07:41 -0800660always_inline void
Florin Coras5c9083d2018-04-13 06:39:07 -0700661listen_session_parse_handle (session_handle_t handle, u32 * index,
662 u32 * thread_index)
Florin Coras371ca502018-02-21 12:07:41 -0800663{
Florin Coras5c9083d2018-04-13 06:39:07 -0700664 session_parse_handle (handle, index, thread_index);
Florin Coras371ca502018-02-21 12:07:41 -0800665}
666
Florin Coras6cf30ad2017-04-04 23:08:23 -0700667always_inline stream_session_t *
Florin Coras5c9083d2018-04-13 06:39:07 -0700668listen_session_new (u8 thread_index, session_type_t type)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700669{
670 stream_session_t *s;
Florin Coras5c9083d2018-04-13 06:39:07 -0700671 s = session_alloc (thread_index);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700672 s->session_type = type;
673 s->session_state = SESSION_STATE_LISTENING;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700674 return s;
675}
676
677always_inline stream_session_t *
Florin Coras5c9083d2018-04-13 06:39:07 -0700678listen_session_get (u32 index)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700679{
Florin Coras5c9083d2018-04-13 06:39:07 -0700680 return session_get (index, 0);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700681}
682
683always_inline void
684listen_session_del (stream_session_t * s)
685{
Florin Coras5c9083d2018-04-13 06:39:07 -0700686 session_free (s);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700687}
688
Florin Coras3cbc04b2017-10-02 00:18:51 -0700689transport_connection_t *listen_session_get_transport (stream_session_t * s);
690
Florin Corascea194d2017-10-02 00:18:51 -0700691int
692listen_session_get_local_session_endpoint (stream_session_t * listener,
693 session_endpoint_t * sep);
694
Florin Corasfd542f12018-05-16 19:28:24 -0700695void session_flush_frames_main_thread (vlib_main_t * vm);
696
Florin Coras6cf30ad2017-04-04 23:08:23 -0700697always_inline u8
698session_manager_is_enabled ()
699{
700 return session_manager_main.is_enabled == 1;
701}
702
Florin Corascea194d2017-10-02 00:18:51 -0700703#define session_cli_return_if_not_enabled() \
704do { \
705 if (!session_manager_main.is_enabled) \
706 return clib_error_return(0, "session layer is not enabled"); \
707} while (0)
708
Dave Barach2a863912017-11-28 10:11:42 -0500709void session_node_enable_disable (u8 is_en);
710
Dave Barach68b0fb02017-02-28 15:15:56 -0500711#endif /* __included_session_h__ */
712
713/*
714 * fd.io coding-style-patch-verification: ON
715 *
716 * Local Variables:
717 * eval: (c-set-style "gnu")
718 * End:
719 */