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