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