session: add startup option to poll in main
[vpp.git] / src / vnet / session / session.h
1 /*
2  * Copyright (c) 2017-2019 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 <vppinfra/llist.h>
19 #include <vnet/session/session_types.h>
20 #include <vnet/session/session_lookup.h>
21 #include <vnet/session/session_debug.h>
22 #include <svm/message_queue.h>
23 #include <svm/ssvm.h>
24
25 #define foreach_session_input_error                                     \
26 _(NO_SESSION, "No session drops")                                       \
27 _(NO_LISTENER, "No listener for dst port drops")                        \
28 _(ENQUEUED, "Packets pushed into rx fifo")                              \
29 _(NOT_READY, "Session not ready packets")                               \
30 _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
31 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
32 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
33
34 typedef enum
35 {
36 #define _(sym,str) SESSION_ERROR_##sym,
37   foreach_session_input_error
38 #undef _
39     SESSION_N_ERROR,
40 } session_input_error_t;
41
42 typedef struct session_tx_context_
43 {
44   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
45   session_t *s;
46   transport_proto_vft_t *transport_vft;
47   transport_connection_t *tc;
48   transport_send_params_t sp;
49   u32 max_dequeue;
50   u32 left_to_snd;
51   u32 max_len_to_snd;
52   u16 deq_per_first_buf;
53   u16 deq_per_buf;
54   u16 n_segs_per_evt;
55   u16 n_bufs_needed;
56   u8 n_bufs_per_seg;
57     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
58   session_dgram_hdr_t hdr;
59 } session_tx_context_t;
60
61 typedef struct session_evt_elt
62 {
63   clib_llist_anchor_t evt_list;
64   session_event_t evt;
65 } session_evt_elt_t;
66
67 typedef struct session_ctrl_evt_data_
68 {
69   u8 data[SESSION_CTRL_MSG_MAX_SIZE];
70 } session_evt_ctrl_data_t;
71
72 typedef struct session_worker_
73 {
74   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
75
76   /** Worker session pool */
77   session_t *sessions;
78
79   /** vpp event message queue for worker */
80   svm_msg_q_t *vpp_event_queue;
81
82   /** vlib_time_now last time around the track */
83   clib_time_type_t last_vlib_time;
84
85   /** vlib_time_now rounded to us precision and as u64 */
86   clib_us_time_t last_vlib_us_time;
87
88   /** Convenience pointer to this worker's vlib_main */
89   vlib_main_t *vm;
90
91   /** Per-proto vector of sessions to enqueue */
92   u32 **session_to_enqueue;
93
94   /** Context for session tx */
95   session_tx_context_t ctx;
96
97   /** Vector of tx buffer free lists */
98   u32 *tx_buffers;
99
100   /** Pool of session event list elements */
101   session_evt_elt_t *event_elts;
102
103   /** Pool of ctrl events data buffers */
104   session_evt_ctrl_data_t *ctrl_evts_data;
105
106   /** Head of control events list */
107   clib_llist_index_t ctrl_head;
108
109   /** Head of list of elements */
110   clib_llist_index_t new_head;
111
112   /** Head of list of pending events */
113   clib_llist_index_t old_head;
114
115   /** Peekers rw lock */
116   clib_rwlock_t peekers_rw_locks;
117
118   /** Vector of buffers to be sent */
119   u32 *pending_tx_buffers;
120
121   /** Vector of nexts for the pending tx buffers */
122   u16 *pending_tx_nexts;
123
124 #if SESSION_DEBUG
125   /** last event poll time by thread */
126   clib_time_type_t last_event_poll;
127 #endif
128 } session_worker_t;
129
130 typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
131                                   vlib_node_runtime_t * node,
132                                   session_evt_elt_t * e, int *n_tx_packets);
133
134 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
135 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
136 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
137
138 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
139
140 typedef struct session_main_
141 {
142   /** Worker contexts */
143   session_worker_t *wrk;
144
145   /** Event queues memfd segment */
146   ssvm_private_t evt_qs_segment;
147
148   /** Unique segment name counter */
149   u32 unique_segment_name_counter;
150
151   /** Per transport rx function that can either dequeue or peek */
152   session_fifo_rx_fn **session_tx_fns;
153
154   /** Per session type output nodes. Could optimize to group nodes by
155    * fib but lookup would then require session type parsing in session node.
156    * Trade memory for speed, for now */
157   u32 *session_type_to_next;
158
159   transport_proto_t last_transport_proto_type;
160
161   /*
162    * Config parameters
163    */
164
165   /** Session manager is enabled */
166   u8 is_enabled;
167
168   /** Session manager initialized (not necessarily enabled) */
169   u8 is_initialized;
170
171   /** Enable session manager at startup */
172   u8 session_enable_asap;
173
174   /** Poll session node in main thread */
175   u8 poll_main;
176
177   /** vpp fifo event queue configured length */
178   u32 configured_event_queue_length;
179
180   /** Session ssvm segment configs*/
181   uword session_baseva;
182   uword session_va_space_size;
183   uword evt_qs_segment_size;
184
185   /** Session table size parameters */
186   u32 configured_v4_session_table_buckets;
187   u32 configured_v4_session_table_memory;
188   u32 configured_v4_halfopen_table_buckets;
189   u32 configured_v4_halfopen_table_memory;
190   u32 configured_v6_session_table_buckets;
191   u32 configured_v6_session_table_memory;
192   u32 configured_v6_halfopen_table_buckets;
193   u32 configured_v6_halfopen_table_memory;
194
195   /** Transport table (preallocation) size parameters */
196   u32 local_endpoints_table_memory;
197   u32 local_endpoints_table_buckets;
198
199   /** Preallocate session config parameter */
200   u32 preallocated_sessions;
201
202 } session_main_t;
203
204 extern session_main_t session_main;
205 extern vlib_node_registration_t session_queue_node;
206 extern vlib_node_registration_t session_queue_process_node;
207 extern vlib_node_registration_t session_queue_pre_input_node;
208
209 typedef enum session_q_process_evt_
210 {
211   SESSION_Q_PROCESS_RUN_ON_MAIN = 1,
212   SESSION_Q_PROCESS_STOP
213 } session_q_process_evt_t;
214
215 #define TRANSPORT_PROTO_INVALID (session_main.last_transport_proto_type + 1)
216 #define TRANSPORT_N_PROTOS (session_main.last_transport_proto_type + 1)
217
218 static inline session_evt_elt_t *
219 session_evt_elt_alloc (session_worker_t * wrk)
220 {
221   session_evt_elt_t *elt;
222   pool_get (wrk->event_elts, elt);
223   return elt;
224 }
225
226 static inline void
227 session_evt_elt_free (session_worker_t * wrk, session_evt_elt_t * elt)
228 {
229   pool_put (wrk->event_elts, elt);
230 }
231
232 static inline void
233 session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
234 {
235   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
236                        pool_elt_at_index (wrk->event_elts, wrk->old_head));
237 }
238
239 static inline void
240 session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
241 {
242   clib_llist_add (wrk->event_elts, evt_list, elt,
243                   pool_elt_at_index (wrk->event_elts, wrk->old_head));
244 }
245
246
247 static inline u32
248 session_evt_ctrl_data_alloc (session_worker_t * wrk)
249 {
250   session_evt_ctrl_data_t *data;
251   pool_get (wrk->ctrl_evts_data, data);
252   return (data - wrk->ctrl_evts_data);
253 }
254
255 static inline session_evt_elt_t *
256 session_evt_alloc_ctrl (session_worker_t * wrk)
257 {
258   session_evt_elt_t *elt;
259   elt = session_evt_elt_alloc (wrk);
260   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
261                        pool_elt_at_index (wrk->event_elts, wrk->ctrl_head));
262   return elt;
263 }
264
265 static inline void *
266 session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
267 {
268   return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
269                                       elt->evt.ctrl_data_index));
270 }
271
272 static inline void
273 session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
274 {
275   ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
276   pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
277 }
278
279 static inline session_evt_elt_t *
280 session_evt_alloc_new (session_worker_t * wrk)
281 {
282   session_evt_elt_t *elt;
283   elt = session_evt_elt_alloc (wrk);
284   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
285                        pool_elt_at_index (wrk->event_elts, wrk->new_head));
286   return elt;
287 }
288
289 static inline session_evt_elt_t *
290 session_evt_alloc_old (session_worker_t * wrk)
291 {
292   session_evt_elt_t *elt;
293   elt = session_evt_elt_alloc (wrk);
294   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
295                        pool_elt_at_index (wrk->event_elts, wrk->old_head));
296   return elt;
297 }
298
299 session_t *session_alloc (u32 thread_index);
300 void session_free (session_t * s);
301 void session_free_w_fifos (session_t * s);
302 void session_cleanup_half_open (transport_proto_t tp,
303                                 session_handle_t ho_handle);
304 u8 session_is_valid (u32 si, u8 thread_index);
305
306 always_inline session_t *
307 session_get (u32 si, u32 thread_index)
308 {
309   ASSERT (session_is_valid (si, thread_index));
310   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
311 }
312
313 always_inline session_t *
314 session_get_if_valid (u64 si, u32 thread_index)
315 {
316   if (thread_index >= vec_len (session_main.wrk))
317     return 0;
318
319   if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
320     return 0;
321
322   ASSERT (session_is_valid (si, thread_index));
323   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
324 }
325
326 always_inline session_t *
327 session_get_from_handle (session_handle_t handle)
328 {
329   session_main_t *smm = &session_main;
330   u32 session_index, thread_index;
331   session_parse_handle (handle, &session_index, &thread_index);
332   return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
333 }
334
335 always_inline session_t *
336 session_get_from_handle_if_valid (session_handle_t handle)
337 {
338   u32 session_index, thread_index;
339   session_parse_handle (handle, &session_index, &thread_index);
340   return session_get_if_valid (session_index, thread_index);
341 }
342
343 u64 session_segment_handle (session_t * s);
344
345 /**
346  * Acquires a lock that blocks a session pool from expanding.
347  *
348  * This is typically used for safely peeking into other threads'
349  * pools in order to clone elements. Lock should be dropped as soon
350  * as possible by calling @ref session_pool_remove_peeker.
351  *
352  * NOTE: Avoid using pool_elt_at_index while the lock is held because
353  * it may lead to free elt bitmap expansion/contraction!
354  */
355 always_inline void
356 session_pool_add_peeker (u32 thread_index)
357 {
358   session_worker_t *wrk = &session_main.wrk[thread_index];
359   if (thread_index == vlib_get_thread_index ())
360     return;
361   clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
362 }
363
364 always_inline void
365 session_pool_remove_peeker (u32 thread_index)
366 {
367   session_worker_t *wrk = &session_main.wrk[thread_index];
368   if (thread_index == vlib_get_thread_index ())
369     return;
370   clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
371 }
372
373 /**
374  * Get session from handle and 'lock' pool resize if not in same thread
375  *
376  * Caller should drop the peek 'lock' as soon as possible.
377  */
378 always_inline session_t *
379 session_get_from_handle_safe (u64 handle)
380 {
381   u32 thread_index = session_thread_from_handle (handle);
382   session_worker_t *wrk = &session_main.wrk[thread_index];
383
384   if (thread_index == vlib_get_thread_index ())
385     {
386       return pool_elt_at_index (wrk->sessions,
387                                 session_index_from_handle (handle));
388     }
389   else
390     {
391       session_pool_add_peeker (thread_index);
392       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
393       return wrk->sessions + session_index_from_handle (handle);
394     }
395 }
396
397 always_inline u32
398 session_get_index (session_t * s)
399 {
400   return (s - session_main.wrk[s->thread_index].sessions);
401 }
402
403 always_inline session_t *
404 session_clone_safe (u32 session_index, u32 thread_index)
405 {
406   session_t *old_s, *new_s;
407   u32 current_thread_index = vlib_get_thread_index ();
408
409   /* If during the memcpy pool is reallocated AND the memory allocator
410    * decides to give the old chunk of memory to somebody in a hurry to
411    * scribble something on it, we have a problem. So add this thread as
412    * a session pool peeker.
413    */
414   session_pool_add_peeker (thread_index);
415   new_s = session_alloc (current_thread_index);
416   old_s = session_main.wrk[thread_index].sessions + session_index;
417   clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
418   session_pool_remove_peeker (thread_index);
419   new_s->thread_index = current_thread_index;
420   new_s->session_index = session_get_index (new_s);
421   return new_s;
422 }
423
424 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
425 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
426 int session_stop_listen (session_t * s);
427 void session_close (session_t * s);
428 void session_reset (session_t * s);
429 void session_transport_close (session_t * s);
430 void session_transport_reset (session_t * s);
431 void session_transport_cleanup (session_t * s);
432 int session_send_io_evt_to_thread (svm_fifo_t * f,
433                                    session_evt_type_t evt_type);
434 int session_enqueue_notify (session_t * s);
435 int session_dequeue_notify (session_t * s);
436 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
437                                           session_evt_type_t evt_type);
438 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
439                                      void *rpc_args);
440 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
441                                            void *rpc_args);
442 void session_add_self_custom_tx_evt (transport_connection_t * tc,
443                                      u8 has_prio);
444 void sesssion_reschedule_tx (transport_connection_t * tc);
445 transport_connection_t *session_get_transport (session_t * s);
446 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
447                            u8 is_lcl);
448
449 u8 *format_session (u8 * s, va_list * args);
450 uword unformat_session (unformat_input_t * input, va_list * args);
451 uword unformat_transport_connection (unformat_input_t * input,
452                                      va_list * args);
453
454 /*
455  * Interface to transport protos
456  */
457
458 int session_enqueue_stream_connection (transport_connection_t * tc,
459                                        vlib_buffer_t * b, u32 offset,
460                                        u8 queue_event, u8 is_in_order);
461 int session_enqueue_dgram_connection (session_t * s,
462                                       session_dgram_hdr_t * hdr,
463                                       vlib_buffer_t * b, u8 proto,
464                                       u8 queue_event);
465 int session_stream_connect_notify (transport_connection_t * tc,
466                                    session_error_t err);
467 int session_dgram_connect_notify (transport_connection_t * tc,
468                                   u32 old_thread_index,
469                                   session_t ** new_session);
470 int session_stream_accept_notify (transport_connection_t * tc);
471 void session_transport_closing_notify (transport_connection_t * tc);
472 void session_transport_delete_notify (transport_connection_t * tc);
473 void session_half_open_delete_notify (transport_proto_t tp,
474                                       session_handle_t ho_handle);
475 void session_transport_closed_notify (transport_connection_t * tc);
476 void session_transport_reset_notify (transport_connection_t * tc);
477 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
478                            u32 thread_index, u8 notify);
479 int session_dgram_accept (transport_connection_t * tc, u32 listener_index,
480                           u32 thread_index);
481 /**
482  * Initialize session layer for given transport proto and ip version
483  *
484  * Allocates per session type (transport proto + ip version) data structures
485  * and adds arc from session queue node to session type output node.
486  *
487  * @param transport_proto       transport proto to be registered
488  * @param vft                   virtual function table for transport
489  * @param is_ip4                flag that indicates if transports uses ipv4
490  *                              as underlying network layer
491  * @param output_node           output node for transport
492  */
493 void session_register_transport (transport_proto_t transport_proto,
494                                  const transport_proto_vft_t * vft, u8 is_ip4,
495                                  u32 output_node);
496 transport_proto_t session_add_transport_proto (void);
497 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
498                                 u32 offset, u32 max_bytes);
499 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
500
501 always_inline u32
502 transport_max_rx_enqueue (transport_connection_t * tc)
503 {
504   session_t *s = session_get (tc->s_index, tc->thread_index);
505   return svm_fifo_max_enqueue_prod (s->rx_fifo);
506 }
507
508 always_inline u32
509 transport_max_tx_dequeue (transport_connection_t * tc)
510 {
511   session_t *s = session_get (tc->s_index, tc->thread_index);
512   return svm_fifo_max_dequeue_cons (s->tx_fifo);
513 }
514
515 always_inline u32
516 transport_max_rx_dequeue (transport_connection_t * tc)
517 {
518   session_t *s = session_get (tc->s_index, tc->thread_index);
519   return svm_fifo_max_dequeue (s->rx_fifo);
520 }
521
522 always_inline u32
523 transport_rx_fifo_size (transport_connection_t * tc)
524 {
525   session_t *s = session_get (tc->s_index, tc->thread_index);
526   return svm_fifo_size (s->rx_fifo);
527 }
528
529 always_inline u32
530 transport_tx_fifo_size (transport_connection_t * tc)
531 {
532   session_t *s = session_get (tc->s_index, tc->thread_index);
533   return svm_fifo_size (s->tx_fifo);
534 }
535
536 always_inline u8
537 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
538 {
539   session_t *s = session_get (tc->c_index, tc->thread_index);
540   return svm_fifo_has_ooo_data (s->rx_fifo);
541 }
542
543 always_inline clib_time_type_t
544 transport_time_now (u32 thread_index)
545 {
546   return session_main.wrk[thread_index].last_vlib_time;
547 }
548
549 always_inline clib_us_time_t
550 transport_us_time_now (u32 thread_index)
551 {
552   return session_main.wrk[thread_index].last_vlib_us_time;
553 }
554
555 always_inline void
556 transport_add_tx_event (transport_connection_t * tc)
557 {
558   session_t *s = session_get (tc->s_index, tc->thread_index);
559   if (svm_fifo_has_event (s->tx_fifo))
560     return;
561   session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
562 }
563
564 /*
565  * Listen sessions
566  */
567
568 always_inline u64
569 listen_session_get_handle (session_t * s)
570 {
571   ASSERT (s->session_state == SESSION_STATE_LISTENING ||
572           session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
573   return session_handle (s);
574 }
575
576 always_inline session_t *
577 listen_session_get_from_handle (session_handle_t handle)
578 {
579   return session_get_from_handle (handle);
580 }
581
582 always_inline void
583 listen_session_parse_handle (session_handle_t handle, u32 * index,
584                              u32 * thread_index)
585 {
586   session_parse_handle (handle, index, thread_index);
587 }
588
589 always_inline session_t *
590 listen_session_alloc (u8 thread_index, session_type_t type)
591 {
592   session_t *s;
593   s = session_alloc (thread_index);
594   s->session_type = type;
595   s->session_state = SESSION_STATE_LISTENING;
596   return s;
597 }
598
599 always_inline session_t *
600 listen_session_get (u32 ls_index)
601 {
602   return session_get (ls_index, 0);
603 }
604
605 always_inline void
606 listen_session_free (session_t * s)
607 {
608   ASSERT (!s->rx_fifo);
609   session_free (s);
610 }
611
612 transport_connection_t *listen_session_get_transport (session_t * s);
613
614 /*
615  * Session layer functions
616  */
617
618 always_inline session_main_t *
619 vnet_get_session_main ()
620 {
621   return &session_main;
622 }
623
624 always_inline session_worker_t *
625 session_main_get_worker (u32 thread_index)
626 {
627   return &session_main.wrk[thread_index];
628 }
629
630 static inline session_worker_t *
631 session_main_get_worker_if_valid (u32 thread_index)
632 {
633   if (thread_index > vec_len (session_main.wrk))
634     return 0;
635   return &session_main.wrk[thread_index];
636 }
637
638 always_inline svm_msg_q_t *
639 session_main_get_vpp_event_queue (u32 thread_index)
640 {
641   return session_main.wrk[thread_index].vpp_event_queue;
642 }
643
644 always_inline u8
645 session_main_is_enabled ()
646 {
647   return session_main.is_enabled == 1;
648 }
649
650 #define session_cli_return_if_not_enabled()                             \
651 do {                                                                    \
652     if (!session_main.is_enabled)                                       \
653       return clib_error_return (0, "session layer is not enabled");     \
654 } while (0)
655
656 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
657 int session_main_flush_all_enqueue_events (u8 transport_proto);
658 void session_queue_run_on_main_thread (vlib_main_t * vm);
659
660 /**
661  * Add session node pending buffer with custom node
662  *
663  * @param thread_index  worker thread expected to send the buffer
664  * @param bi            buffer index
665  * @param next_node     next node edge index for buffer. Edge to next node
666  *                      must exist
667  */
668 always_inline void
669 session_add_pending_tx_buffer (u32 thread_index, u32 bi, u32 next_node)
670 {
671   session_worker_t *wrk = session_main_get_worker (thread_index);
672   vec_add1 (wrk->pending_tx_buffers, bi);
673   vec_add1 (wrk->pending_tx_nexts, next_node);
674 }
675
676 ssvm_private_t *session_main_get_evt_q_segment (void);
677 void session_node_enable_disable (u8 is_en);
678 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
679
680 session_t *session_alloc_for_connection (transport_connection_t * tc);
681
682 #endif /* __included_session_h__ */
683
684 /*
685  * fd.io coding-style-patch-verification: ON
686  *
687  * Local Variables:
688  * eval: (c-set-style "gnu")
689  * End:
690  */