session: fix feature disable
[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 initialized only if so configured */
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   /** vpp fifo event queue configured length */
175   u32 configured_event_queue_length;
176
177   /** Session ssvm segment configs*/
178   uword session_baseva;
179   uword session_va_space_size;
180   uword evt_qs_segment_size;
181   u8 evt_qs_use_memfd_seg;
182
183   /** Session table size parameters */
184   u32 configured_v4_session_table_buckets;
185   u32 configured_v4_session_table_memory;
186   u32 configured_v4_halfopen_table_buckets;
187   u32 configured_v4_halfopen_table_memory;
188   u32 configured_v6_session_table_buckets;
189   u32 configured_v6_session_table_memory;
190   u32 configured_v6_halfopen_table_buckets;
191   u32 configured_v6_halfopen_table_memory;
192
193   /** Transport table (preallocation) size parameters */
194   u32 local_endpoints_table_memory;
195   u32 local_endpoints_table_buckets;
196
197   /** Preallocate session config parameter */
198   u32 preallocated_sessions;
199
200 } session_main_t;
201
202 extern session_main_t session_main;
203 extern vlib_node_registration_t session_queue_node;
204 extern vlib_node_registration_t session_queue_process_node;
205 extern vlib_node_registration_t session_queue_pre_input_node;
206
207 typedef enum session_q_process_evt_
208 {
209   SESSION_Q_PROCESS_RUN_ON_MAIN = 1,
210   SESSION_Q_PROCESS_STOP
211 } session_q_process_evt_t;
212
213 #define TRANSPORT_PROTO_INVALID (session_main.last_transport_proto_type + 1)
214 #define TRANSPORT_N_PROTOS (session_main.last_transport_proto_type + 1)
215
216 static inline session_evt_elt_t *
217 session_evt_elt_alloc (session_worker_t * wrk)
218 {
219   session_evt_elt_t *elt;
220   pool_get (wrk->event_elts, elt);
221   return elt;
222 }
223
224 static inline void
225 session_evt_elt_free (session_worker_t * wrk, session_evt_elt_t * elt)
226 {
227   pool_put (wrk->event_elts, elt);
228 }
229
230 static inline void
231 session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
232 {
233   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
234                        pool_elt_at_index (wrk->event_elts, wrk->old_head));
235 }
236
237 static inline void
238 session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
239 {
240   clib_llist_add (wrk->event_elts, evt_list, elt,
241                   pool_elt_at_index (wrk->event_elts, wrk->old_head));
242 }
243
244
245 static inline u32
246 session_evt_ctrl_data_alloc (session_worker_t * wrk)
247 {
248   session_evt_ctrl_data_t *data;
249   pool_get (wrk->ctrl_evts_data, data);
250   return (data - wrk->ctrl_evts_data);
251 }
252
253 static inline session_evt_elt_t *
254 session_evt_alloc_ctrl (session_worker_t * wrk)
255 {
256   session_evt_elt_t *elt;
257   elt = session_evt_elt_alloc (wrk);
258   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
259                        pool_elt_at_index (wrk->event_elts, wrk->ctrl_head));
260   return elt;
261 }
262
263 static inline void *
264 session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
265 {
266   return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
267                                       elt->evt.ctrl_data_index));
268 }
269
270 static inline void
271 session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
272 {
273   ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
274   pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
275 }
276
277 static inline session_evt_elt_t *
278 session_evt_alloc_new (session_worker_t * wrk)
279 {
280   session_evt_elt_t *elt;
281   elt = session_evt_elt_alloc (wrk);
282   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
283                        pool_elt_at_index (wrk->event_elts, wrk->new_head));
284   return elt;
285 }
286
287 static inline session_evt_elt_t *
288 session_evt_alloc_old (session_worker_t * wrk)
289 {
290   session_evt_elt_t *elt;
291   elt = session_evt_elt_alloc (wrk);
292   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
293                        pool_elt_at_index (wrk->event_elts, wrk->old_head));
294   return elt;
295 }
296
297 session_t *session_alloc (u32 thread_index);
298 void session_free (session_t * s);
299 void session_free_w_fifos (session_t * s);
300 void session_cleanup_half_open (transport_proto_t tp,
301                                 session_handle_t ho_handle);
302 u8 session_is_valid (u32 si, u8 thread_index);
303
304 always_inline session_t *
305 session_get (u32 si, u32 thread_index)
306 {
307   ASSERT (session_is_valid (si, thread_index));
308   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
309 }
310
311 always_inline session_t *
312 session_get_if_valid (u64 si, u32 thread_index)
313 {
314   if (thread_index >= vec_len (session_main.wrk))
315     return 0;
316
317   if (pool_is_free_index (session_main.wrk[thread_index].sessions, si))
318     return 0;
319
320   ASSERT (session_is_valid (si, thread_index));
321   return pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
322 }
323
324 always_inline session_t *
325 session_get_from_handle (session_handle_t handle)
326 {
327   session_main_t *smm = &session_main;
328   u32 session_index, thread_index;
329   session_parse_handle (handle, &session_index, &thread_index);
330   return pool_elt_at_index (smm->wrk[thread_index].sessions, session_index);
331 }
332
333 always_inline session_t *
334 session_get_from_handle_if_valid (session_handle_t handle)
335 {
336   u32 session_index, thread_index;
337   session_parse_handle (handle, &session_index, &thread_index);
338   return session_get_if_valid (session_index, thread_index);
339 }
340
341 u64 session_segment_handle (session_t * s);
342
343 /**
344  * Acquires a lock that blocks a session pool from expanding.
345  *
346  * This is typically used for safely peeking into other threads'
347  * pools in order to clone elements. Lock should be dropped as soon
348  * as possible by calling @ref session_pool_remove_peeker.
349  *
350  * NOTE: Avoid using pool_elt_at_index while the lock is held because
351  * it may lead to free elt bitmap expansion/contraction!
352  */
353 always_inline void
354 session_pool_add_peeker (u32 thread_index)
355 {
356   session_worker_t *wrk = &session_main.wrk[thread_index];
357   if (thread_index == vlib_get_thread_index ())
358     return;
359   clib_rwlock_reader_lock (&wrk->peekers_rw_locks);
360 }
361
362 always_inline void
363 session_pool_remove_peeker (u32 thread_index)
364 {
365   session_worker_t *wrk = &session_main.wrk[thread_index];
366   if (thread_index == vlib_get_thread_index ())
367     return;
368   clib_rwlock_reader_unlock (&wrk->peekers_rw_locks);
369 }
370
371 /**
372  * Get session from handle and 'lock' pool resize if not in same thread
373  *
374  * Caller should drop the peek 'lock' as soon as possible.
375  */
376 always_inline session_t *
377 session_get_from_handle_safe (u64 handle)
378 {
379   u32 thread_index = session_thread_from_handle (handle);
380   session_worker_t *wrk = &session_main.wrk[thread_index];
381
382   if (thread_index == vlib_get_thread_index ())
383     {
384       return pool_elt_at_index (wrk->sessions,
385                                 session_index_from_handle (handle));
386     }
387   else
388     {
389       session_pool_add_peeker (thread_index);
390       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
391       return wrk->sessions + session_index_from_handle (handle);
392     }
393 }
394
395 always_inline u32
396 session_get_index (session_t * s)
397 {
398   return (s - session_main.wrk[s->thread_index].sessions);
399 }
400
401 always_inline session_t *
402 session_clone_safe (u32 session_index, u32 thread_index)
403 {
404   session_t *old_s, *new_s;
405   u32 current_thread_index = vlib_get_thread_index ();
406
407   /* If during the memcpy pool is reallocated AND the memory allocator
408    * decides to give the old chunk of memory to somebody in a hurry to
409    * scribble something on it, we have a problem. So add this thread as
410    * a session pool peeker.
411    */
412   session_pool_add_peeker (thread_index);
413   new_s = session_alloc (current_thread_index);
414   old_s = session_main.wrk[thread_index].sessions + session_index;
415   clib_memcpy_fast (new_s, old_s, sizeof (*new_s));
416   session_pool_remove_peeker (thread_index);
417   new_s->thread_index = current_thread_index;
418   new_s->session_index = session_get_index (new_s);
419   return new_s;
420 }
421
422 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
423 int session_listen (session_t * s, session_endpoint_cfg_t * sep);
424 int session_stop_listen (session_t * s);
425 void session_close (session_t * s);
426 void session_reset (session_t * s);
427 void session_transport_close (session_t * s);
428 void session_transport_reset (session_t * s);
429 void session_transport_cleanup (session_t * s);
430 int session_send_io_evt_to_thread (svm_fifo_t * f,
431                                    session_evt_type_t evt_type);
432 int session_enqueue_notify (session_t * s);
433 int session_dequeue_notify (session_t * s);
434 int session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
435                                           session_evt_type_t evt_type);
436 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
437                                      void *rpc_args);
438 void session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
439                                            void *rpc_args);
440 void session_add_self_custom_tx_evt (transport_connection_t * tc,
441                                      u8 has_prio);
442 void sesssion_reschedule_tx (transport_connection_t * tc);
443 transport_connection_t *session_get_transport (session_t * s);
444 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
445                            u8 is_lcl);
446
447 u8 *format_session (u8 * s, va_list * args);
448 uword unformat_session (unformat_input_t * input, va_list * args);
449 uword unformat_transport_connection (unformat_input_t * input,
450                                      va_list * args);
451
452 /*
453  * Interface to transport protos
454  */
455
456 int session_enqueue_stream_connection (transport_connection_t * tc,
457                                        vlib_buffer_t * b, u32 offset,
458                                        u8 queue_event, u8 is_in_order);
459 int session_enqueue_dgram_connection (session_t * s,
460                                       session_dgram_hdr_t * hdr,
461                                       vlib_buffer_t * b, u8 proto,
462                                       u8 queue_event);
463 int session_stream_connect_notify (transport_connection_t * tc,
464                                    session_error_t err);
465 int session_dgram_connect_notify (transport_connection_t * tc,
466                                   u32 old_thread_index,
467                                   session_t ** new_session);
468 int session_stream_accept_notify (transport_connection_t * tc);
469 void session_transport_closing_notify (transport_connection_t * tc);
470 void session_transport_delete_notify (transport_connection_t * tc);
471 void session_half_open_delete_notify (transport_proto_t tp,
472                                       session_handle_t ho_handle);
473 void session_transport_closed_notify (transport_connection_t * tc);
474 void session_transport_reset_notify (transport_connection_t * tc);
475 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
476                            u32 thread_index, u8 notify);
477 int session_dgram_accept (transport_connection_t * tc, u32 listener_index,
478                           u32 thread_index);
479 /**
480  * Initialize session layer for given transport proto and ip version
481  *
482  * Allocates per session type (transport proto + ip version) data structures
483  * and adds arc from session queue node to session type output node.
484  *
485  * @param transport_proto       transport proto to be registered
486  * @param vft                   virtual function table for transport
487  * @param is_ip4                flag that indicates if transports uses ipv4
488  *                              as underlying network layer
489  * @param output_node           output node for transport
490  */
491 void session_register_transport (transport_proto_t transport_proto,
492                                  const transport_proto_vft_t * vft, u8 is_ip4,
493                                  u32 output_node);
494 transport_proto_t session_add_transport_proto (void);
495 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
496                                 u32 offset, u32 max_bytes);
497 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
498
499 always_inline u32
500 transport_max_rx_enqueue (transport_connection_t * tc)
501 {
502   session_t *s = session_get (tc->s_index, tc->thread_index);
503   return svm_fifo_max_enqueue_prod (s->rx_fifo);
504 }
505
506 always_inline u32
507 transport_max_tx_dequeue (transport_connection_t * tc)
508 {
509   session_t *s = session_get (tc->s_index, tc->thread_index);
510   return svm_fifo_max_dequeue_cons (s->tx_fifo);
511 }
512
513 always_inline u32
514 transport_max_rx_dequeue (transport_connection_t * tc)
515 {
516   session_t *s = session_get (tc->s_index, tc->thread_index);
517   return svm_fifo_max_dequeue (s->rx_fifo);
518 }
519
520 always_inline u32
521 transport_rx_fifo_size (transport_connection_t * tc)
522 {
523   session_t *s = session_get (tc->s_index, tc->thread_index);
524   return svm_fifo_size (s->rx_fifo);
525 }
526
527 always_inline u32
528 transport_tx_fifo_size (transport_connection_t * tc)
529 {
530   session_t *s = session_get (tc->s_index, tc->thread_index);
531   return svm_fifo_size (s->tx_fifo);
532 }
533
534 always_inline u8
535 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
536 {
537   session_t *s = session_get (tc->c_index, tc->thread_index);
538   return svm_fifo_has_ooo_data (s->rx_fifo);
539 }
540
541 always_inline clib_time_type_t
542 transport_time_now (u32 thread_index)
543 {
544   return session_main.wrk[thread_index].last_vlib_time;
545 }
546
547 always_inline clib_us_time_t
548 transport_us_time_now (u32 thread_index)
549 {
550   return session_main.wrk[thread_index].last_vlib_us_time;
551 }
552
553 always_inline void
554 transport_add_tx_event (transport_connection_t * tc)
555 {
556   session_t *s = session_get (tc->s_index, tc->thread_index);
557   if (svm_fifo_has_event (s->tx_fifo))
558     return;
559   session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
560 }
561
562 /*
563  * Listen sessions
564  */
565
566 always_inline u64
567 listen_session_get_handle (session_t * s)
568 {
569   ASSERT (s->session_state == SESSION_STATE_LISTENING ||
570           session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
571   return session_handle (s);
572 }
573
574 always_inline session_t *
575 listen_session_get_from_handle (session_handle_t handle)
576 {
577   return session_get_from_handle (handle);
578 }
579
580 always_inline void
581 listen_session_parse_handle (session_handle_t handle, u32 * index,
582                              u32 * thread_index)
583 {
584   session_parse_handle (handle, index, thread_index);
585 }
586
587 always_inline session_t *
588 listen_session_alloc (u8 thread_index, session_type_t type)
589 {
590   session_t *s;
591   s = session_alloc (thread_index);
592   s->session_type = type;
593   s->session_state = SESSION_STATE_LISTENING;
594   return s;
595 }
596
597 always_inline session_t *
598 listen_session_get (u32 ls_index)
599 {
600   return session_get (ls_index, 0);
601 }
602
603 always_inline void
604 listen_session_free (session_t * s)
605 {
606   ASSERT (!s->rx_fifo);
607   session_free (s);
608 }
609
610 transport_connection_t *listen_session_get_transport (session_t * s);
611
612 /*
613  * Session layer functions
614  */
615
616 always_inline session_main_t *
617 vnet_get_session_main ()
618 {
619   return &session_main;
620 }
621
622 always_inline session_worker_t *
623 session_main_get_worker (u32 thread_index)
624 {
625   return &session_main.wrk[thread_index];
626 }
627
628 static inline session_worker_t *
629 session_main_get_worker_if_valid (u32 thread_index)
630 {
631   if (thread_index > vec_len (session_main.wrk))
632     return 0;
633   return &session_main.wrk[thread_index];
634 }
635
636 always_inline svm_msg_q_t *
637 session_main_get_vpp_event_queue (u32 thread_index)
638 {
639   return session_main.wrk[thread_index].vpp_event_queue;
640 }
641
642 always_inline u8
643 session_main_is_enabled ()
644 {
645   return session_main.is_enabled == 1;
646 }
647
648 #define session_cli_return_if_not_enabled()                             \
649 do {                                                                    \
650     if (!session_main.is_enabled)                                       \
651       return clib_error_return (0, "session layer is not enabled");     \
652 } while (0)
653
654 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
655 int session_main_flush_all_enqueue_events (u8 transport_proto);
656 void session_queue_run_on_main_thread (vlib_main_t * vm);
657
658 /**
659  * Add session node pending buffer with custom node
660  *
661  * @param thread_index  worker thread expected to send the buffer
662  * @param bi            buffer index
663  * @param next_node     next node edge index for buffer. Edge to next node
664  *                      must exist
665  */
666 always_inline void
667 session_add_pending_tx_buffer (u32 thread_index, u32 bi, u32 next_node)
668 {
669   session_worker_t *wrk = session_main_get_worker (thread_index);
670   vec_add1 (wrk->pending_tx_buffers, bi);
671   vec_add1 (wrk->pending_tx_nexts, next_node);
672 }
673
674 ssvm_private_t *session_main_get_evt_q_segment (void);
675 void session_node_enable_disable (u8 is_en);
676 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
677
678 session_t *session_alloc_for_connection (transport_connection_t * tc);
679
680 #endif /* __included_session_h__ */
681
682 /*
683  * fd.io coding-style-patch-verification: ON
684  *
685  * Local Variables:
686  * eval: (c-set-style "gnu")
687  * End:
688  */