tls: fix multi threaded medium scale test (VPP-1457)
[vpp.git] / src / vnet / session / session.h
1 /*
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
18 #include <vnet/session/stream_session.h>
19 #include <vnet/session/session_lookup.h>
20 #include <vnet/session/transport_interface.h>
21 #include <vnet/session/session_debug.h>
22 #include <vnet/session/segment_manager.h>
23 #include <svm/queue.h>
24
25 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
26 #define INVALID_INDEX ((u32)~0)
27 #define SESSION_PROXY_LISTENER_INDEX ((u8)~0 - 1)
28 #define SESSION_LOCAL_HANDLE_PREFIX 0x7FFFFFFF
29
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
33 typedef enum
34 {
35   FIFO_EVENT_APP_RX,
36   SESSION_IO_EVT_CT_RX,
37   FIFO_EVENT_APP_TX,
38   SESSION_IO_EVT_CT_TX,
39   FIFO_EVENT_DISCONNECT,
40   FIFO_EVENT_BUILTIN_RX,
41   FIFO_EVENT_BUILTIN_TX,
42   FIFO_EVENT_RPC,
43   SESSION_CTRL_EVT_BOUND,
44   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
52 } session_evt_type_t;
53
54 static inline const char *
55 fifo_event_type_str (session_evt_type_t et)
56 {
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";
63     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
74 typedef 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
81 #define foreach_session_input_error                                     \
82 _(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")   \
90 _(NO_SPACE, "Couldn't allocate a fifo pair")                            \
91 _(SEG_CREATE, "Couldn't create a new segment")
92
93 typedef 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
101 typedef struct
102 {
103   void *fp;
104   void *arg;
105 } session_rpc_args_t;
106
107 typedef u64 session_handle_t;
108
109 /* *INDENT-OFF* */
110 typedef struct
111 {
112   u8 event_type;
113   u8 postponed;
114   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   };
124 } __clib_packed session_event_t;
125 /* *INDENT-ON* */
126
127 #define SESSION_MSG_NULL { }
128
129 typedef struct session_dgram_pre_hdr_
130 {
131   u32 data_length;
132   u32 data_offset;
133 } session_dgram_pre_hdr_t;
134
135 /* *INDENT-OFF* */
136 typedef 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
151 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
152                "session conn id wrong length");
153
154 typedef 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;
169   u16 n_segs_per_evt;
170   u8 n_bufs_per_seg;
171     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
172   session_dgram_hdr_t hdr;
173 } session_tx_context_t;
174
175 /* Forward definition */
176 typedef struct _session_manager_main session_manager_main_t;
177
178 typedef int
179   (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
180                         session_event_t * e0, stream_session_t * s0,
181                         int *n_tx_pkts);
182
183 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
184 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
185 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
186
187 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
188
189 struct _session_manager_main
190 {
191   /** Per worker thread session pools */
192   stream_session_t **sessions;
193
194   /** Per worker-thread session pool peekers rw locks */
195   clib_rwlock_t *peekers_rw_locks;
196
197   /** Per-proto, per-worker enqueue epoch counters */
198   u64 *current_enqueue_epoch[TRANSPORT_N_PROTO];
199
200   /** Per-proto, per-worker thread vector of sessions to enqueue */
201   u32 **session_to_enqueue[TRANSPORT_N_PROTO];
202
203   /** per-worker tx buffer free lists */
204   u32 **tx_buffers;
205
206   /** Per worker-thread vector of partially read events */
207   session_event_t **free_event_vector;
208
209   /** per-worker active event vectors */
210   session_event_t **pending_event_vector;
211
212   /** per-worker postponed disconnects */
213   session_event_t **pending_disconnects;
214
215   /** per-worker session context */
216   session_tx_context_t *ctx;
217
218   /** vpp fifo event queue */
219   svm_msg_q_t **vpp_event_queues;
220
221   /** Event queues memfd segment initialized only if so configured */
222   ssvm_private_t evt_qs_segment;
223
224   /** Unique segment name counter */
225   u32 unique_segment_name_counter;
226
227   /** Per transport rx function that can either dequeue or peek */
228   session_fifo_rx_fn **session_tx_fns;
229
230   /** Per session type output nodes. Could optimize to group nodes by
231    * fib but lookup would then require session type parsing in session node.
232    * Trade memory for speed, for now */
233   u32 *session_type_to_next;
234
235   /** Session manager is enabled */
236   u8 is_enabled;
237
238   /** vpp fifo event queue configured length */
239   u32 configured_event_queue_length;
240
241   /*
242    * Config parameters
243    */
244
245   /** Session ssvm segment configs*/
246   uword session_baseva;
247   uword session_va_space_size;
248   u32 evt_qs_segment_size;
249   u8 evt_qs_use_memfd_seg;
250
251   /** Session table size parameters */
252   u32 configured_v4_session_table_buckets;
253   u32 configured_v4_session_table_memory;
254   u32 configured_v4_halfopen_table_buckets;
255   u32 configured_v4_halfopen_table_memory;
256   u32 configured_v6_session_table_buckets;
257   u32 configured_v6_session_table_memory;
258   u32 configured_v6_halfopen_table_buckets;
259   u32 configured_v6_halfopen_table_memory;
260
261   /** Transport table (preallocation) size parameters */
262   u32 local_endpoints_table_memory;
263   u32 local_endpoints_table_buckets;
264
265   /** Preallocate session config parameter */
266   u32 preallocated_sessions;
267
268 #if SESSION_DEBUG
269   /**
270    * last event poll time by thread
271    * Debug only. Will cause false cache-line sharing as-is
272    */
273   f64 *last_event_poll_by_thread;
274 #endif
275
276 };
277
278 extern session_manager_main_t session_manager_main;
279 extern vlib_node_registration_t session_queue_node;
280 extern vlib_node_registration_t session_queue_process_node;
281
282 #define SESSION_Q_PROCESS_FLUSH_FRAMES  1
283 #define SESSION_Q_PROCESS_STOP          2
284
285 /*
286  * Session manager function
287  */
288 always_inline session_manager_main_t *
289 vnet_get_session_manager_main ()
290 {
291   return &session_manager_main;
292 }
293
294 always_inline u8
295 stream_session_is_valid (u32 si, u8 thread_index)
296 {
297   stream_session_t *s;
298   s = pool_elt_at_index (session_manager_main.sessions[thread_index], si);
299   if (s->thread_index != thread_index || s->session_index != si
300       /* || s->server_rx_fifo->master_session_index != si
301          || s->server_tx_fifo->master_session_index != si
302          || s->server_rx_fifo->master_thread_index != thread_index
303          || s->server_tx_fifo->master_thread_index != thread_index */ )
304     return 0;
305   return 1;
306 }
307
308 stream_session_t *session_alloc (u32 thread_index);
309 int session_alloc_fifos (segment_manager_t * sm, stream_session_t * s);
310 void session_free (stream_session_t * s);
311 void session_free_w_fifos (stream_session_t * s);
312
313 always_inline stream_session_t *
314 session_get (u32 si, u32 thread_index)
315 {
316   ASSERT (stream_session_is_valid (si, thread_index));
317   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
318 }
319
320 always_inline stream_session_t *
321 session_get_if_valid (u64 si, u32 thread_index)
322 {
323   if (thread_index >= vec_len (session_manager_main.sessions))
324     return 0;
325
326   if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
327     return 0;
328
329   ASSERT (stream_session_is_valid (si, thread_index));
330   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
331 }
332
333 always_inline session_handle_t
334 session_handle (stream_session_t * s)
335 {
336   return ((u64) s->thread_index << 32) | (u64) s->session_index;
337 }
338
339 always_inline u32
340 session_index_from_handle (session_handle_t handle)
341 {
342   return handle & 0xFFFFFFFF;
343 }
344
345 always_inline u32
346 session_thread_from_handle (session_handle_t handle)
347 {
348   return handle >> 32;
349 }
350
351 always_inline void
352 session_parse_handle (session_handle_t handle, u32 * index,
353                       u32 * thread_index)
354 {
355   *index = session_index_from_handle (handle);
356   *thread_index = session_thread_from_handle (handle);
357 }
358
359 always_inline stream_session_t *
360 session_get_from_handle (session_handle_t handle)
361 {
362   session_manager_main_t *smm = &session_manager_main;
363   u32 session_index, thread_index;
364   session_parse_handle (handle, &session_index, &thread_index);
365   return pool_elt_at_index (smm->sessions[thread_index], session_index);
366 }
367
368 always_inline stream_session_t *
369 session_get_from_handle_if_valid (session_handle_t handle)
370 {
371   u32 session_index, thread_index;
372   session_parse_handle (handle, &session_index, &thread_index);
373   return session_get_if_valid (session_index, thread_index);
374 }
375
376 always_inline u8
377 session_handle_is_local (session_handle_t handle)
378 {
379   if ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX)
380     return 1;
381   return 0;
382 }
383
384 always_inline transport_proto_t
385 session_type_transport_proto (session_type_t st)
386 {
387   return (st >> 1);
388 }
389
390 always_inline u8
391 session_type_is_ip4 (session_type_t st)
392 {
393   return (st & 1);
394 }
395
396 always_inline transport_proto_t
397 session_get_transport_proto (stream_session_t * s)
398 {
399   return (s->session_type >> 1);
400 }
401
402 always_inline fib_protocol_t
403 session_get_fib_proto (stream_session_t * s)
404 {
405   u8 is_ip4 = s->session_type & 1;
406   return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
407 }
408
409 always_inline session_type_t
410 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
411 {
412   return (proto << 1 | is_ip4);
413 }
414
415 always_inline u8
416 session_has_transport (stream_session_t * s)
417 {
418   return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
419 }
420
421 transport_service_type_t session_transport_service_type (stream_session_t *);
422 transport_tx_fn_type_t session_transport_tx_fn_type (stream_session_t *);
423 u8 session_tx_is_dgram (stream_session_t * s);
424
425 /**
426  * Acquires a lock that blocks a session pool from expanding.
427  *
428  * This is typically used for safely peeking into other threads'
429  * pools in order to clone elements. Lock should be dropped as soon
430  * as possible by calling @ref session_pool_remove_peeker.
431  *
432  * NOTE: Avoid using pool_elt_at_index while the lock is held because
433  * it may lead to free elt bitmap expansion/contraction!
434  */
435 always_inline void
436 session_pool_add_peeker (u32 thread_index)
437 {
438   session_manager_main_t *smm = &session_manager_main;
439   if (thread_index == vlib_get_thread_index ())
440     return;
441   clib_rwlock_reader_lock (&smm->peekers_rw_locks[thread_index]);
442 }
443
444 always_inline void
445 session_pool_remove_peeker (u32 thread_index)
446 {
447   session_manager_main_t *smm = &session_manager_main;
448   if (thread_index == vlib_get_thread_index ())
449     return;
450   clib_rwlock_reader_unlock (&smm->peekers_rw_locks[thread_index]);
451 }
452
453 /**
454  * Get session from handle and 'lock' pool resize if not in same thread
455  *
456  * Caller should drop the peek 'lock' as soon as possible.
457  */
458 always_inline stream_session_t *
459 session_get_from_handle_safe (u64 handle)
460 {
461   session_manager_main_t *smm = &session_manager_main;
462   u32 thread_index = session_thread_from_handle (handle);
463   if (thread_index == vlib_get_thread_index ())
464     {
465       return pool_elt_at_index (smm->sessions[thread_index],
466                                 session_index_from_handle (handle));
467     }
468   else
469     {
470       session_pool_add_peeker (thread_index);
471       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
472       return smm->sessions[thread_index] + session_index_from_handle (handle);
473     }
474 }
475
476 always_inline u32
477 transport_max_rx_enqueue (transport_connection_t * tc)
478 {
479   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
480   return svm_fifo_max_enqueue (s->server_rx_fifo);
481 }
482
483 always_inline u32
484 transport_rx_fifo_size (transport_connection_t * tc)
485 {
486   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
487   return s->server_rx_fifo->nitems;
488 }
489
490 always_inline u32
491 transport_tx_fifo_size (transport_connection_t * tc)
492 {
493   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
494   return s->server_tx_fifo->nitems;
495 }
496
497 always_inline u32
498 session_get_index (stream_session_t * s)
499 {
500   return (s - session_manager_main.sessions[s->thread_index]);
501 }
502
503 always_inline stream_session_t *
504 session_clone_safe (u32 session_index, u32 thread_index)
505 {
506   stream_session_t *old_s, *new_s;
507   u32 current_thread_index = vlib_get_thread_index ();
508
509   /* If during the memcpy pool is reallocated AND the memory allocator
510    * decides to give the old chunk of memory to somebody in a hurry to
511    * scribble something on it, we have a problem. So add this thread as
512    * a session pool peeker.
513    */
514   session_pool_add_peeker (thread_index);
515   new_s = session_alloc (current_thread_index);
516   old_s = session_manager_main.sessions[thread_index] + session_index;
517   clib_memcpy (new_s, old_s, sizeof (*new_s));
518   session_pool_remove_peeker (thread_index);
519   new_s->thread_index = current_thread_index;
520   new_s->session_index = session_get_index (new_s);
521   return new_s;
522 }
523
524 transport_connection_t *session_get_transport (stream_session_t * s);
525
526 u32 session_tx_fifo_max_dequeue (transport_connection_t * tc);
527
528 int
529 session_enqueue_stream_connection (transport_connection_t * tc,
530                                    vlib_buffer_t * b, u32 offset,
531                                    u8 queue_event, u8 is_in_order);
532 int session_enqueue_dgram_connection (stream_session_t * s,
533                                       session_dgram_hdr_t * hdr,
534                                       vlib_buffer_t * b, u8 proto,
535                                       u8 queue_event);
536 int stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
537                                u32 offset, u32 max_bytes);
538 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
539
540 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
541 int session_dgram_connect_notify (transport_connection_t * tc,
542                                   u32 old_thread_index,
543                                   stream_session_t ** new_session);
544 int session_dequeue_notify (stream_session_t * s);
545 void stream_session_init_fifos_pointers (transport_connection_t * tc,
546                                          u32 rx_pointer, u32 tx_pointer);
547
548 void stream_session_accept_notify (transport_connection_t * tc);
549 void stream_session_disconnect_notify (transport_connection_t * tc);
550 void stream_session_delete_notify (transport_connection_t * tc);
551 void stream_session_reset_notify (transport_connection_t * tc);
552 int stream_session_accept (transport_connection_t * tc, u32 listener_index,
553                            u8 notify);
554 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
555 int session_listen (stream_session_t * s, session_endpoint_extended_t * sep);
556 int session_stop_listen (stream_session_t * s);
557 void stream_session_disconnect (stream_session_t * s);
558 void stream_session_disconnect_transport (stream_session_t * s);
559 void stream_session_cleanup (stream_session_t * s);
560 int session_send_io_evt_to_thread (svm_fifo_t * f,
561                                    session_evt_type_t evt_type);
562 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
563                                           session_evt_type_t evt_type);
564 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
565                                      void *rpc_args);
566
567 ssvm_private_t *session_manager_get_evt_q_segment (void);
568
569 u8 *format_stream_session (u8 * s, va_list * args);
570 uword unformat_stream_session (unformat_input_t * input, va_list * args);
571 uword unformat_transport_connection (unformat_input_t * input,
572                                      va_list * args);
573
574 void session_register_transport (transport_proto_t transport_proto,
575                                  const transport_proto_vft_t * vft, u8 is_ip4,
576                                  u32 output_node);
577
578 always_inline void
579 transport_add_tx_event (transport_connection_t * tc)
580 {
581   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
582   if (svm_fifo_has_event (s->server_tx_fifo))
583     return;
584   session_send_io_evt_to_thread (s->server_tx_fifo, FIFO_EVENT_APP_TX);
585 }
586
587 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
588
589 always_inline svm_msg_q_t *
590 session_manager_get_vpp_event_queue (u32 thread_index)
591 {
592   return session_manager_main.vpp_event_queues[thread_index];
593 }
594
595 int session_manager_flush_enqueue_events (u8 proto, u32 thread_index);
596 int session_manager_flush_all_enqueue_events (u8 transport_proto);
597
598 always_inline u64
599 listen_session_get_handle (stream_session_t * s)
600 {
601   ASSERT (s->session_state == SESSION_STATE_LISTENING);
602   return session_handle (s);
603 }
604
605 always_inline stream_session_t *
606 listen_session_get_from_handle (session_handle_t handle)
607 {
608   return session_get_from_handle (handle);
609 }
610
611 always_inline void
612 listen_session_parse_handle (session_handle_t handle, u32 * index,
613                              u32 * thread_index)
614 {
615   session_parse_handle (handle, index, thread_index);
616 }
617
618 always_inline stream_session_t *
619 listen_session_new (u8 thread_index, session_type_t type)
620 {
621   stream_session_t *s;
622   s = session_alloc (thread_index);
623   s->session_type = type;
624   s->session_state = SESSION_STATE_LISTENING;
625   return s;
626 }
627
628 always_inline stream_session_t *
629 listen_session_get (u32 index)
630 {
631   return session_get (index, 0);
632 }
633
634 always_inline void
635 listen_session_del (stream_session_t * s)
636 {
637   session_free (s);
638 }
639
640 transport_connection_t *listen_session_get_transport (stream_session_t * s);
641
642 int
643 listen_session_get_local_session_endpoint (stream_session_t * listener,
644                                            session_endpoint_t * sep);
645
646 void session_flush_frames_main_thread (vlib_main_t * vm);
647
648 always_inline u8
649 session_manager_is_enabled ()
650 {
651   return session_manager_main.is_enabled == 1;
652 }
653
654 #define session_cli_return_if_not_enabled()                             \
655 do {                                                                    \
656     if (!session_manager_main.is_enabled)                               \
657       return clib_error_return(0, "session layer is not enabled");      \
658 } while (0)
659
660 void session_node_enable_disable (u8 is_en);
661
662 #endif /* __included_session_h__ */
663
664 /*
665  * fd.io coding-style-patch-verification: ON
666  *
667  * Local Variables:
668  * eval: (c-set-style "gnu")
669  * End:
670  */