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