session: session enable in multiworker
[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 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair")   \
34 _(NO_SPACE, "Couldn't allocate a fifo pair")                            \
35 _(SEG_CREATE, "Couldn't create a new segment")
36
37 typedef enum
38 {
39 #define _(sym,str) SESSION_ERROR_##sym,
40   foreach_session_input_error
41 #undef _
42     SESSION_N_ERROR,
43 } session_error_t;
44
45 typedef struct session_tx_context_
46 {
47   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
48   session_t *s;
49   transport_proto_vft_t *transport_vft;
50   transport_connection_t *tc;
51   u32 max_dequeue;
52   u32 snd_space;
53   u32 left_to_snd;
54   u32 tx_offset;
55   u32 max_len_to_snd;
56   u16 deq_per_first_buf;
57   u16 deq_per_buf;
58   u16 snd_mss;
59   u16 n_segs_per_evt;
60   u8 n_bufs_per_seg;
61     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
62   session_dgram_hdr_t hdr;
63 } session_tx_context_t;
64
65 typedef struct session_evt_elt
66 {
67   clib_llist_anchor_t evt_list;
68   session_event_t evt;
69 } session_evt_elt_t;
70
71 typedef struct session_ctrl_evt_data_
72 {
73   u8 data[SESSION_CTRL_MSG_MAX_SIZE];
74 } session_evt_ctrl_data_t;
75
76 typedef struct session_worker_
77 {
78   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
79
80   /** Worker session pool */
81   session_t *sessions;
82
83   /** vpp event message queue for worker */
84   svm_msg_q_t *vpp_event_queue;
85
86   /** vlib_time_now last time around the track */
87   clib_time_type_t last_vlib_time;
88
89   /** vlib_time_now rounded to us precision and as u64 */
90   clib_us_time_t last_vlib_us_time;
91
92   /** Convenience pointer to this worker's vlib_main */
93   vlib_main_t *vm;
94
95   /** Per-proto vector of sessions to enqueue */
96   u32 *session_to_enqueue[TRANSPORT_N_PROTO];
97
98   /** Context for session tx */
99   session_tx_context_t ctx;
100
101   /** Vector of tx buffer free lists */
102   u32 *tx_buffers;
103
104   /** Pool of session event list elements */
105   session_evt_elt_t *event_elts;
106
107   /** Pool of ctrl events data buffers */
108   session_evt_ctrl_data_t *ctrl_evts_data;
109
110   /** Head of control events list */
111   clib_llist_index_t ctrl_head;
112
113   /** Head of list of elements */
114   clib_llist_index_t new_head;
115
116   /** Head of list of pending events */
117   clib_llist_index_t old_head;
118
119   /** Peekers rw lock */
120   clib_rwlock_t peekers_rw_locks;
121
122   /** Vector of buffers to be sent */
123   u32 *pending_tx_buffers;
124
125   /** Vector of nexts for the pending tx buffers */
126   u16 *pending_tx_nexts;
127
128 #if SESSION_DEBUG
129   /** last event poll time by thread */
130   clib_time_type_t last_event_poll;
131 #endif
132 } session_worker_t;
133
134 typedef int (session_fifo_rx_fn) (session_worker_t * wrk,
135                                   vlib_node_runtime_t * node,
136                                   session_evt_elt_t * e, int *n_tx_packets);
137
138 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
139 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
140 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
141
142 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
143
144 typedef struct session_main_
145 {
146   /** Worker contexts */
147   session_worker_t *wrk;
148
149   /** Event queues memfd segment initialized only if so configured */
150   ssvm_private_t evt_qs_segment;
151
152   /** Unique segment name counter */
153   u32 unique_segment_name_counter;
154
155   /** Per transport rx function that can either dequeue or peek */
156   session_fifo_rx_fn **session_tx_fns;
157
158   /** Per session type output nodes. Could optimize to group nodes by
159    * fib but lookup would then require session type parsing in session node.
160    * Trade memory for speed, for now */
161   u32 *session_type_to_next;
162
163   /*
164    * Config parameters
165    */
166
167   /** Session manager is enabled */
168   u8 is_enabled;
169   /** Enable session manager at startup */
170   u8 session_enable_asap;
171
172   /** vpp fifo event queue configured length */
173   u32 configured_event_queue_length;
174
175   /** Session ssvm segment configs*/
176   uword session_baseva;
177   uword session_va_space_size;
178   uword evt_qs_segment_size;
179   u8 evt_qs_use_memfd_seg;
180
181   /** Session table size parameters */
182   u32 configured_v4_session_table_buckets;
183   u32 configured_v4_session_table_memory;
184   u32 configured_v4_halfopen_table_buckets;
185   u32 configured_v4_halfopen_table_memory;
186   u32 configured_v6_session_table_buckets;
187   u32 configured_v6_session_table_memory;
188   u32 configured_v6_halfopen_table_buckets;
189   u32 configured_v6_halfopen_table_memory;
190
191   /** Transport table (preallocation) size parameters */
192   u32 local_endpoints_table_memory;
193   u32 local_endpoints_table_buckets;
194
195   /** Preallocate session config parameter */
196   u32 preallocated_sessions;
197
198 } session_main_t;
199
200 extern session_main_t session_main;
201 extern vlib_node_registration_t session_queue_node;
202 extern vlib_node_registration_t session_queue_process_node;
203 extern vlib_node_registration_t session_queue_pre_input_node;
204
205 #define SESSION_Q_PROCESS_FLUSH_FRAMES  1
206 #define SESSION_Q_PROCESS_STOP          2
207
208 static inline session_evt_elt_t *
209 session_evt_elt_alloc (session_worker_t * wrk)
210 {
211   session_evt_elt_t *elt;
212   pool_get (wrk->event_elts, elt);
213   return elt;
214 }
215
216 static inline void
217 session_evt_elt_free (session_worker_t * wrk, session_evt_elt_t * elt)
218 {
219   pool_put (wrk->event_elts, elt);
220 }
221
222 static inline void
223 session_evt_add_old (session_worker_t * wrk, session_evt_elt_t * elt)
224 {
225   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
226                        pool_elt_at_index (wrk->event_elts, wrk->old_head));
227 }
228
229 static inline void
230 session_evt_add_head_old (session_worker_t * wrk, session_evt_elt_t * elt)
231 {
232   clib_llist_add (wrk->event_elts, evt_list, elt,
233                   pool_elt_at_index (wrk->event_elts, wrk->old_head));
234 }
235
236
237 static inline u32
238 session_evt_ctrl_data_alloc (session_worker_t * wrk)
239 {
240   session_evt_ctrl_data_t *data;
241   pool_get (wrk->ctrl_evts_data, data);
242   return (data - wrk->ctrl_evts_data);
243 }
244
245 static inline session_evt_elt_t *
246 session_evt_alloc_ctrl (session_worker_t * wrk)
247 {
248   session_evt_elt_t *elt;
249   elt = session_evt_elt_alloc (wrk);
250   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
251                        pool_elt_at_index (wrk->event_elts, wrk->ctrl_head));
252   return elt;
253 }
254
255 static inline void *
256 session_evt_ctrl_data (session_worker_t * wrk, session_evt_elt_t * elt)
257 {
258   return (void *) (pool_elt_at_index (wrk->ctrl_evts_data,
259                                       elt->evt.ctrl_data_index));
260 }
261
262 static inline void
263 session_evt_ctrl_data_free (session_worker_t * wrk, session_evt_elt_t * elt)
264 {
265   ASSERT (elt->evt.event_type > SESSION_IO_EVT_BUILTIN_TX);
266   pool_put_index (wrk->ctrl_evts_data, elt->evt.ctrl_data_index);
267 }
268
269 static inline session_evt_elt_t *
270 session_evt_alloc_new (session_worker_t * wrk)
271 {
272   session_evt_elt_t *elt;
273   elt = session_evt_elt_alloc (wrk);
274   clib_llist_add_tail (wrk->event_elts, evt_list, elt,
275                        pool_elt_at_index (wrk->event_elts, wrk->new_head));
276   return elt;
277 }
278
279 static inline session_evt_elt_t *
280 session_evt_alloc_old (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->old_head));
286   return elt;
287 }
288
289 always_inline u8
290 session_is_valid (u32 si, u8 thread_index)
291 {
292   session_t *s;
293   s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
294   if (s->session_state == SESSION_STATE_CLOSED)
295     return 1;
296
297   if (s->thread_index != thread_index || s->session_index != si)
298     return 0;
299   return 1;
300 }
301
302 session_t *session_alloc (u32 thread_index);
303 void session_free (session_t * s);
304 void session_free_w_fifos (session_t * s);
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 transport_connection_t *session_get_transport (session_t * s);
445 void session_get_endpoint (session_t * s, transport_endpoint_t * tep,
446                            u8 is_lcl);
447
448 u8 *format_session (u8 * s, va_list * args);
449 uword unformat_session (unformat_input_t * input, va_list * args);
450 uword unformat_transport_connection (unformat_input_t * input,
451                                      va_list * args);
452
453 /*
454  * Interface to transport protos
455  */
456
457 int session_enqueue_stream_connection (transport_connection_t * tc,
458                                        vlib_buffer_t * b, u32 offset,
459                                        u8 queue_event, u8 is_in_order);
460 int session_enqueue_dgram_connection (session_t * s,
461                                       session_dgram_hdr_t * hdr,
462                                       vlib_buffer_t * b, u8 proto,
463                                       u8 queue_event);
464 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
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_transport_closed_notify (transport_connection_t * tc);
472 void session_transport_reset_notify (transport_connection_t * tc);
473 int session_stream_accept (transport_connection_t * tc, u32 listener_index,
474                            u32 thread_index, u8 notify);
475 void session_register_transport (transport_proto_t transport_proto,
476                                  const transport_proto_vft_t * vft, u8 is_ip4,
477                                  u32 output_node);
478 int session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
479                                 u32 offset, u32 max_bytes);
480 u32 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
481
482 always_inline u32
483 transport_max_rx_enqueue (transport_connection_t * tc)
484 {
485   session_t *s = session_get (tc->s_index, tc->thread_index);
486   return svm_fifo_max_enqueue_prod (s->rx_fifo);
487 }
488
489 always_inline u32
490 transport_max_tx_dequeue (transport_connection_t * tc)
491 {
492   session_t *s = session_get (tc->s_index, tc->thread_index);
493   return svm_fifo_max_dequeue_cons (s->tx_fifo);
494 }
495
496 always_inline u32
497 transport_max_rx_dequeue (transport_connection_t * tc)
498 {
499   session_t *s = session_get (tc->s_index, tc->thread_index);
500   return svm_fifo_max_dequeue (s->rx_fifo);
501 }
502
503 always_inline u32
504 transport_rx_fifo_size (transport_connection_t * tc)
505 {
506   session_t *s = session_get (tc->s_index, tc->thread_index);
507   return s->rx_fifo->nitems;
508 }
509
510 always_inline u32
511 transport_tx_fifo_size (transport_connection_t * tc)
512 {
513   session_t *s = session_get (tc->s_index, tc->thread_index);
514   return s->tx_fifo->nitems;
515 }
516
517 always_inline u8
518 transport_rx_fifo_has_ooo_data (transport_connection_t * tc)
519 {
520   session_t *s = session_get (tc->c_index, tc->thread_index);
521   return svm_fifo_has_ooo_data (s->rx_fifo);
522 }
523
524 always_inline clib_time_type_t
525 transport_time_now (u32 thread_index)
526 {
527   return session_main.wrk[thread_index].last_vlib_time;
528 }
529
530 always_inline clib_us_time_t
531 transport_us_time_now (u32 thread_index)
532 {
533   return session_main.wrk[thread_index].last_vlib_us_time;
534 }
535
536 always_inline void
537 transport_add_tx_event (transport_connection_t * tc)
538 {
539   session_t *s = session_get (tc->s_index, tc->thread_index);
540   if (svm_fifo_has_event (s->tx_fifo))
541     return;
542   session_send_io_evt_to_thread (s->tx_fifo, SESSION_IO_EVT_TX);
543 }
544
545 /*
546  * Listen sessions
547  */
548
549 always_inline u64
550 listen_session_get_handle (session_t * s)
551 {
552   ASSERT (s->session_state == SESSION_STATE_LISTENING ||
553           session_get_transport_proto (s) == TRANSPORT_PROTO_QUIC);
554   return session_handle (s);
555 }
556
557 always_inline session_t *
558 listen_session_get_from_handle (session_handle_t handle)
559 {
560   return session_get_from_handle (handle);
561 }
562
563 always_inline void
564 listen_session_parse_handle (session_handle_t handle, u32 * index,
565                              u32 * thread_index)
566 {
567   session_parse_handle (handle, index, thread_index);
568 }
569
570 always_inline session_t *
571 listen_session_alloc (u8 thread_index, session_type_t type)
572 {
573   session_t *s;
574   s = session_alloc (thread_index);
575   s->session_type = type;
576   s->session_state = SESSION_STATE_LISTENING;
577   return s;
578 }
579
580 always_inline session_t *
581 listen_session_get (u32 ls_index)
582 {
583   return session_get (ls_index, 0);
584 }
585
586 always_inline void
587 listen_session_free (session_t * s)
588 {
589   session_free (s);
590 }
591
592 transport_connection_t *listen_session_get_transport (session_t * s);
593
594 /*
595  * Session layer functions
596  */
597
598 always_inline session_main_t *
599 vnet_get_session_main ()
600 {
601   return &session_main;
602 }
603
604 always_inline session_worker_t *
605 session_main_get_worker (u32 thread_index)
606 {
607   return &session_main.wrk[thread_index];
608 }
609
610 static inline session_worker_t *
611 session_main_get_worker_if_valid (u32 thread_index)
612 {
613   if (pool_is_free_index (session_main.wrk, thread_index))
614     return 0;
615   return &session_main.wrk[thread_index];
616 }
617
618 always_inline svm_msg_q_t *
619 session_main_get_vpp_event_queue (u32 thread_index)
620 {
621   return session_main.wrk[thread_index].vpp_event_queue;
622 }
623
624 always_inline u8
625 session_main_is_enabled ()
626 {
627   return session_main.is_enabled == 1;
628 }
629
630 #define session_cli_return_if_not_enabled()                             \
631 do {                                                                    \
632     if (!session_main.is_enabled)                                       \
633       return clib_error_return (0, "session layer is not enabled");     \
634 } while (0)
635
636 int session_main_flush_enqueue_events (u8 proto, u32 thread_index);
637 int session_main_flush_all_enqueue_events (u8 transport_proto);
638 void session_flush_frames_main_thread (vlib_main_t * vm);
639
640 always_inline void
641 session_add_pending_tx_buffer (session_type_t st, u32 thread_index, u32 bi)
642 {
643   session_worker_t *wrk = session_main_get_worker (thread_index);
644   vec_add1 (wrk->pending_tx_buffers, bi);
645   vec_add1 (wrk->pending_tx_nexts, session_main.session_type_to_next[st]);
646 }
647
648 ssvm_private_t *session_main_get_evt_q_segment (void);
649 void session_node_enable_disable (u8 is_en);
650 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
651
652 #endif /* __included_session_h__ */
653
654 /*
655  * fd.io coding-style-patch-verification: ON
656  *
657  * Local Variables:
658  * eval: (c-set-style "gnu")
659  * End:
660  */