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