session: support multiple worker binds
[vpp.git] / src / vnet / session / session.h
1 /*
2  * Copyright (c) 2017 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 <vnet/session/stream_session.h>
19 #include <vnet/session/session_lookup.h>
20 #include <vnet/session/transport_interface.h>
21 #include <vnet/session/session_debug.h>
22 #include <vnet/session/segment_manager.h>
23 #include <svm/queue.h>
24
25 #define HALF_OPEN_LOOKUP_INVALID_VALUE ((u64)~0)
26 #define INVALID_INDEX ((u32)~0)
27 #define SESSION_PROXY_LISTENER_INDEX ((u8)~0 - 1)
28 #define SESSION_LOCAL_HANDLE_PREFIX 0x7FFFFFFF
29
30 /* TODO decide how much since we have pre-data as well */
31 #define MAX_HDRS_LEN    100     /* Max number of bytes for headers */
32
33 typedef enum
34 {
35   FIFO_EVENT_APP_RX,
36   SESSION_IO_EVT_CT_RX,
37   FIFO_EVENT_APP_TX,
38   SESSION_IO_EVT_CT_TX,
39   FIFO_EVENT_DISCONNECT,
40   FIFO_EVENT_BUILTIN_RX,
41   FIFO_EVENT_RPC,
42   SESSION_CTRL_EVT_BOUND,
43   SESSION_CTRL_EVT_ACCEPTED,
44   SESSION_CTRL_EVT_ACCEPTED_REPLY,
45   SESSION_CTRL_EVT_CONNECTED,
46   SESSION_CTRL_EVT_CONNECTED_REPLY,
47   SESSION_CTRL_EVT_DISCONNECTED,
48   SESSION_CTRL_EVT_DISCONNECTED_REPLY,
49   SESSION_CTRL_EVT_RESET,
50   SESSION_CTRL_EVT_RESET_REPLY
51 } session_evt_type_t;
52
53 static inline const char *
54 fifo_event_type_str (session_evt_type_t et)
55 {
56   switch (et)
57     {
58     case FIFO_EVENT_APP_RX:
59       return "FIFO_EVENT_APP_RX";
60     case FIFO_EVENT_APP_TX:
61       return "FIFO_EVENT_APP_TX";
62     case FIFO_EVENT_DISCONNECT:
63       return "FIFO_EVENT_DISCONNECT";
64     case FIFO_EVENT_BUILTIN_RX:
65       return "FIFO_EVENT_BUILTIN_RX";
66     case FIFO_EVENT_RPC:
67       return "FIFO_EVENT_RPC";
68     default:
69       return "UNKNOWN FIFO EVENT";
70     }
71 }
72
73 typedef enum
74 {
75   SESSION_MQ_IO_EVT_RING,
76   SESSION_MQ_CTRL_EVT_RING,
77   SESSION_MQ_N_RINGS
78 } session_mq_rings_e;
79
80 #define foreach_session_input_error                                     \
81 _(NO_SESSION, "No session drops")                                       \
82 _(NO_LISTENER, "No listener for dst port drops")                        \
83 _(ENQUEUED, "Packets pushed into rx fifo")                              \
84 _(NOT_READY, "Session not ready packets")                               \
85 _(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
86 _(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
87 _(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
88 _(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair")   \
89 _(NO_SPACE, "Couldn't allocate a fifo pair")                            \
90 _(SEG_CREATE, "Couldn't create a new segment")
91
92 typedef enum
93 {
94 #define _(sym,str) SESSION_ERROR_##sym,
95   foreach_session_input_error
96 #undef _
97     SESSION_N_ERROR,
98 } session_error_t;
99
100 typedef struct
101 {
102   void *fp;
103   void *arg;
104 } session_rpc_args_t;
105
106 typedef u64 session_handle_t;
107
108 /* *INDENT-OFF* */
109 typedef struct
110 {
111   u8 event_type;
112   u8 postponed;
113   union
114   {
115     svm_fifo_t *fifo;
116     session_handle_t session_handle;
117     session_rpc_args_t rpc_args;
118     struct
119     {
120       u8 data[0];
121     };
122   };
123 } __clib_packed session_event_t;
124 /* *INDENT-ON* */
125
126 #define SESSION_MSG_NULL { }
127
128 typedef struct session_dgram_pre_hdr_
129 {
130   u32 data_length;
131   u32 data_offset;
132 } session_dgram_pre_hdr_t;
133
134 /* *INDENT-OFF* */
135 typedef CLIB_PACKED (struct session_dgram_header_
136 {
137   u32 data_length;
138   u32 data_offset;
139   ip46_address_t rmt_ip;
140   ip46_address_t lcl_ip;
141   u16 rmt_port;
142   u16 lcl_port;
143   u8 is_ip4;
144 }) session_dgram_hdr_t;
145 /* *INDENT-ON* */
146
147 #define SESSION_CONN_ID_LEN 37
148 #define SESSION_CONN_HDR_LEN 45
149
150 STATIC_ASSERT (sizeof (session_dgram_hdr_t) == (SESSION_CONN_ID_LEN + 8),
151                "session conn id wrong length");
152
153 typedef struct session_tx_context_
154 {
155   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
156   stream_session_t *s;
157   transport_proto_vft_t *transport_vft;
158   transport_connection_t *tc;
159   vlib_buffer_t *b;
160   u32 max_dequeue;
161   u32 snd_space;
162   u32 left_to_snd;
163   u32 tx_offset;
164   u32 max_len_to_snd;
165   u16 deq_per_first_buf;
166   u16 deq_per_buf;
167   u16 snd_mss;
168   u16 n_segs_per_evt;
169   u8 n_bufs_per_seg;
170     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
171   session_dgram_hdr_t hdr;
172 } session_tx_context_t;
173
174 /* Forward definition */
175 typedef struct _session_manager_main session_manager_main_t;
176
177 typedef int
178   (session_fifo_rx_fn) (vlib_main_t * vm, vlib_node_runtime_t * node,
179                         session_event_t * e0, stream_session_t * s0,
180                         int *n_tx_pkts);
181
182 extern session_fifo_rx_fn session_tx_fifo_peek_and_snd;
183 extern session_fifo_rx_fn session_tx_fifo_dequeue_and_snd;
184 extern session_fifo_rx_fn session_tx_fifo_dequeue_internal;
185
186 u8 session_node_lookup_fifo_event (svm_fifo_t * f, session_event_t * e);
187
188 struct _session_manager_main
189 {
190   /** Per worker thread session pools */
191   stream_session_t **sessions;
192
193   /** Per worker-thread session pool peekers rw locks */
194   clib_rwlock_t *peekers_rw_locks;
195
196   /** Per-proto, per-worker enqueue epoch counters */
197   u32 *current_enqueue_epoch[TRANSPORT_N_PROTO];
198
199   /** Per-proto, per-worker thread vector of sessions to enqueue */
200   u32 **session_to_enqueue[TRANSPORT_N_PROTO];
201
202   /** per-worker tx buffer free lists */
203   u32 **tx_buffers;
204
205   /** Per worker-thread vector of partially read events */
206   session_event_t **free_event_vector;
207
208   /** per-worker active event vectors */
209   session_event_t **pending_event_vector;
210
211   /** per-worker postponed disconnects */
212   session_event_t **pending_disconnects;
213
214   /** per-worker session context */
215   session_tx_context_t *ctx;
216
217   /** vpp fifo event queue */
218   svm_msg_q_t **vpp_event_queues;
219
220   /** Event queues memfd segment initialized only if so configured */
221   ssvm_private_t evt_qs_segment;
222
223   /** Unique segment name counter */
224   u32 unique_segment_name_counter;
225
226   /** Per transport rx function that can either dequeue or peek */
227   session_fifo_rx_fn **session_tx_fns;
228
229   /** Per session type output nodes. Could optimize to group nodes by
230    * fib but lookup would then require session type parsing in session node.
231    * Trade memory for speed, for now */
232   u32 *session_type_to_next;
233
234   /** Session manager is enabled */
235   u8 is_enabled;
236
237   /** vpp fifo event queue configured length */
238   u32 configured_event_queue_length;
239
240   /*
241    * Config parameters
242    */
243
244   /** Session ssvm segment configs*/
245   uword session_baseva;
246   uword session_va_space_size;
247   u32 evt_qs_segment_size;
248   u8 evt_qs_use_memfd_seg;
249
250   /** Session table size parameters */
251   u32 configured_v4_session_table_buckets;
252   u32 configured_v4_session_table_memory;
253   u32 configured_v4_halfopen_table_buckets;
254   u32 configured_v4_halfopen_table_memory;
255   u32 configured_v6_session_table_buckets;
256   u32 configured_v6_session_table_memory;
257   u32 configured_v6_halfopen_table_buckets;
258   u32 configured_v6_halfopen_table_memory;
259
260   /** Transport table (preallocation) size parameters */
261   u32 local_endpoints_table_memory;
262   u32 local_endpoints_table_buckets;
263
264   /** Preallocate session config parameter */
265   u32 preallocated_sessions;
266
267 #if SESSION_DEBUG
268   /**
269    * last event poll time by thread
270    * Debug only. Will cause false cache-line sharing as-is
271    */
272   f64 *last_event_poll_by_thread;
273 #endif
274
275 };
276
277 extern session_manager_main_t session_manager_main;
278 extern vlib_node_registration_t session_queue_node;
279 extern vlib_node_registration_t session_queue_process_node;
280
281 #define SESSION_Q_PROCESS_FLUSH_FRAMES  1
282 #define SESSION_Q_PROCESS_STOP          2
283
284 /*
285  * Session manager function
286  */
287 always_inline session_manager_main_t *
288 vnet_get_session_manager_main ()
289 {
290   return &session_manager_main;
291 }
292
293 always_inline u8
294 stream_session_is_valid (u32 si, u8 thread_index)
295 {
296   stream_session_t *s;
297   s = pool_elt_at_index (session_manager_main.sessions[thread_index], si);
298   if (s->thread_index != thread_index || s->session_index != si
299       /* || s->server_rx_fifo->master_session_index != si
300          || s->server_tx_fifo->master_session_index != si
301          || s->server_rx_fifo->master_thread_index != thread_index
302          || s->server_tx_fifo->master_thread_index != thread_index */ )
303     return 0;
304   return 1;
305 }
306
307 stream_session_t *session_alloc (u32 thread_index);
308 int session_alloc_fifos (segment_manager_t * sm, stream_session_t * s);
309 void session_free (stream_session_t * s);
310
311 always_inline stream_session_t *
312 session_get (u32 si, u32 thread_index)
313 {
314   ASSERT (stream_session_is_valid (si, thread_index));
315   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
316 }
317
318 always_inline stream_session_t *
319 session_get_if_valid (u64 si, u32 thread_index)
320 {
321   if (thread_index >= vec_len (session_manager_main.sessions))
322     return 0;
323
324   if (pool_is_free_index (session_manager_main.sessions[thread_index], si))
325     return 0;
326
327   ASSERT (stream_session_is_valid (si, thread_index));
328   return pool_elt_at_index (session_manager_main.sessions[thread_index], si);
329 }
330
331 always_inline session_handle_t
332 session_handle (stream_session_t * s)
333 {
334   return ((u64) s->thread_index << 32) | (u64) s->session_index;
335 }
336
337 always_inline u32
338 session_index_from_handle (session_handle_t handle)
339 {
340   return handle & 0xFFFFFFFF;
341 }
342
343 always_inline u32
344 session_thread_from_handle (session_handle_t handle)
345 {
346   return handle >> 32;
347 }
348
349 always_inline void
350 session_parse_handle (session_handle_t handle, u32 * index,
351                       u32 * thread_index)
352 {
353   *index = session_index_from_handle (handle);
354   *thread_index = session_thread_from_handle (handle);
355 }
356
357 always_inline stream_session_t *
358 session_get_from_handle (session_handle_t handle)
359 {
360   session_manager_main_t *smm = &session_manager_main;
361   u32 session_index, thread_index;
362   session_parse_handle (handle, &session_index, &thread_index);
363   return pool_elt_at_index (smm->sessions[thread_index], session_index);
364 }
365
366 always_inline stream_session_t *
367 session_get_from_handle_if_valid (session_handle_t handle)
368 {
369   u32 session_index, thread_index;
370   session_parse_handle (handle, &session_index, &thread_index);
371   return session_get_if_valid (session_index, thread_index);
372 }
373
374 always_inline u8
375 session_handle_is_local (session_handle_t handle)
376 {
377   if ((handle >> 32) == SESSION_LOCAL_HANDLE_PREFIX)
378     return 1;
379   return 0;
380 }
381
382 always_inline transport_proto_t
383 session_type_transport_proto (session_type_t st)
384 {
385   return (st >> 1);
386 }
387
388 always_inline u8
389 session_type_is_ip4 (session_type_t st)
390 {
391   return (st & 1);
392 }
393
394 always_inline transport_proto_t
395 session_get_transport_proto (stream_session_t * s)
396 {
397   return (s->session_type >> 1);
398 }
399
400 always_inline fib_protocol_t
401 session_get_fib_proto (stream_session_t * s)
402 {
403   u8 is_ip4 = s->session_type & 1;
404   return (is_ip4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6);
405 }
406
407 always_inline session_type_t
408 session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
409 {
410   return (proto << 1 | is_ip4);
411 }
412
413 always_inline u8
414 session_has_transport (stream_session_t * s)
415 {
416   return (session_get_transport_proto (s) != TRANSPORT_PROTO_NONE);
417 }
418
419 transport_service_type_t session_transport_service_type (stream_session_t *);
420 transport_tx_fn_type_t session_transport_tx_fn_type (stream_session_t *);
421 u8 session_tx_is_dgram (stream_session_t * s);
422
423 /**
424  * Acquires a lock that blocks a session pool from expanding.
425  *
426  * This is typically used for safely peeking into other threads'
427  * pools in order to clone elements. Lock should be dropped as soon
428  * as possible by calling @ref session_pool_remove_peeker.
429  *
430  * NOTE: Avoid using pool_elt_at_index while the lock is held because
431  * it may lead to free elt bitmap expansion/contraction!
432  */
433 always_inline void
434 session_pool_add_peeker (u32 thread_index)
435 {
436   session_manager_main_t *smm = &session_manager_main;
437   if (thread_index == vlib_get_thread_index ())
438     return;
439   clib_rwlock_reader_lock (&smm->peekers_rw_locks[thread_index]);
440 }
441
442 always_inline void
443 session_pool_remove_peeker (u32 thread_index)
444 {
445   session_manager_main_t *smm = &session_manager_main;
446   if (thread_index == vlib_get_thread_index ())
447     return;
448   clib_rwlock_reader_unlock (&smm->peekers_rw_locks[thread_index]);
449 }
450
451 /**
452  * Get session from handle and 'lock' pool resize if not in same thread
453  *
454  * Caller should drop the peek 'lock' as soon as possible.
455  */
456 always_inline stream_session_t *
457 session_get_from_handle_safe (u64 handle)
458 {
459   session_manager_main_t *smm = &session_manager_main;
460   u32 thread_index = session_thread_from_handle (handle);
461   if (thread_index == vlib_get_thread_index ())
462     {
463       return pool_elt_at_index (smm->sessions[thread_index],
464                                 session_index_from_handle (handle));
465     }
466   else
467     {
468       session_pool_add_peeker (thread_index);
469       /* Don't use pool_elt_at index. See @ref session_pool_add_peeker */
470       return smm->sessions[thread_index] + session_index_from_handle (handle);
471     }
472 }
473
474 always_inline u32
475 transport_max_rx_enqueue (transport_connection_t * tc)
476 {
477   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
478   return svm_fifo_max_enqueue (s->server_rx_fifo);
479 }
480
481 always_inline u32
482 transport_rx_fifo_size (transport_connection_t * tc)
483 {
484   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
485   return s->server_rx_fifo->nitems;
486 }
487
488 always_inline u32
489 transport_tx_fifo_size (transport_connection_t * tc)
490 {
491   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
492   return s->server_tx_fifo->nitems;
493 }
494
495 always_inline u32
496 session_get_index (stream_session_t * s)
497 {
498   return (s - session_manager_main.sessions[s->thread_index]);
499 }
500
501 always_inline stream_session_t *
502 session_clone_safe (u32 session_index, u32 thread_index)
503 {
504   stream_session_t *old_s, *new_s;
505   u32 current_thread_index = vlib_get_thread_index ();
506
507   /* If during the memcpy pool is reallocated AND the memory allocator
508    * decides to give the old chunk of memory to somebody in a hurry to
509    * scribble something on it, we have a problem. So add this thread as
510    * a session pool peeker.
511    */
512   session_pool_add_peeker (thread_index);
513   new_s = session_alloc (current_thread_index);
514   old_s = session_manager_main.sessions[thread_index] + session_index;
515   clib_memcpy (new_s, old_s, sizeof (*new_s));
516   session_pool_remove_peeker (thread_index);
517   new_s->thread_index = current_thread_index;
518   new_s->session_index = session_get_index (new_s);
519   return new_s;
520 }
521
522 transport_connection_t *session_get_transport (stream_session_t * s);
523
524 u32 session_tx_fifo_max_dequeue (transport_connection_t * tc);
525
526 int
527 session_enqueue_stream_connection (transport_connection_t * tc,
528                                    vlib_buffer_t * b, u32 offset,
529                                    u8 queue_event, u8 is_in_order);
530 int session_enqueue_dgram_connection (stream_session_t * s,
531                                       session_dgram_hdr_t * hdr,
532                                       vlib_buffer_t * b, u8 proto,
533                                       u8 queue_event);
534 int stream_session_peek_bytes (transport_connection_t * tc, u8 * buffer,
535                                u32 offset, u32 max_bytes);
536 u32 stream_session_dequeue_drop (transport_connection_t * tc, u32 max_bytes);
537
538 int session_stream_connect_notify (transport_connection_t * tc, u8 is_fail);
539 int session_dgram_connect_notify (transport_connection_t * tc,
540                                   u32 old_thread_index,
541                                   stream_session_t ** new_session);
542 int session_dequeue_notify (stream_session_t * s);
543 void stream_session_init_fifos_pointers (transport_connection_t * tc,
544                                          u32 rx_pointer, u32 tx_pointer);
545
546 void stream_session_accept_notify (transport_connection_t * tc);
547 void stream_session_disconnect_notify (transport_connection_t * tc);
548 void stream_session_delete_notify (transport_connection_t * tc);
549 void stream_session_reset_notify (transport_connection_t * tc);
550 int stream_session_accept (transport_connection_t * tc, u32 listener_index,
551                            u8 notify);
552 int session_open (u32 app_index, session_endpoint_t * tep, u32 opaque);
553 int session_listen (stream_session_t * s, session_endpoint_extended_t * sep);
554 int session_stop_listen (stream_session_t * s);
555 void stream_session_disconnect (stream_session_t * s);
556 void stream_session_disconnect_transport (stream_session_t * s);
557 void stream_session_cleanup (stream_session_t * s);
558 int session_send_io_evt_to_thread (svm_fifo_t * f,
559                                    session_evt_type_t evt_type);
560 int session_send_io_evt_to_thread_custom (svm_fifo_t * f, u32 thread_index,
561                                           session_evt_type_t evt_type);
562 void session_send_rpc_evt_to_thread (u32 thread_index, void *fp,
563                                      void *rpc_args);
564 ssvm_private_t *session_manager_get_evt_q_segment (void);
565
566 u8 *format_stream_session (u8 * s, va_list * args);
567 uword unformat_stream_session (unformat_input_t * input, va_list * args);
568 uword unformat_transport_connection (unformat_input_t * input,
569                                      va_list * args);
570
571 void session_register_transport (transport_proto_t transport_proto,
572                                  const transport_proto_vft_t * vft, u8 is_ip4,
573                                  u32 output_node);
574
575 always_inline void
576 transport_add_tx_event (transport_connection_t * tc)
577 {
578   stream_session_t *s = session_get (tc->s_index, tc->thread_index);
579   if (svm_fifo_has_event (s->server_tx_fifo))
580     return;
581   session_send_io_evt_to_thread (s->server_tx_fifo, FIFO_EVENT_APP_TX);
582 }
583
584 clib_error_t *vnet_session_enable_disable (vlib_main_t * vm, u8 is_en);
585
586 always_inline svm_msg_q_t *
587 session_manager_get_vpp_event_queue (u32 thread_index)
588 {
589   return session_manager_main.vpp_event_queues[thread_index];
590 }
591
592 int session_manager_flush_enqueue_events (u8 proto, u32 thread_index);
593 int session_manager_flush_all_enqueue_events (u8 transport_proto);
594
595 always_inline u64
596 listen_session_get_handle (stream_session_t * s)
597 {
598   ASSERT (s->session_state == SESSION_STATE_LISTENING);
599   return session_handle (s);
600 }
601
602 always_inline stream_session_t *
603 listen_session_get_from_handle (session_handle_t handle)
604 {
605   return session_get_from_handle (handle);
606 }
607
608 always_inline void
609 listen_session_parse_handle (session_handle_t handle, u32 * index,
610                              u32 * thread_index)
611 {
612   session_parse_handle (handle, index, thread_index);
613 }
614
615 always_inline stream_session_t *
616 listen_session_new (u8 thread_index, session_type_t type)
617 {
618   stream_session_t *s;
619   s = session_alloc (thread_index);
620   s->session_type = type;
621   s->session_state = SESSION_STATE_LISTENING;
622   return s;
623 }
624
625 always_inline stream_session_t *
626 listen_session_get (u32 index)
627 {
628   return session_get (index, 0);
629 }
630
631 always_inline void
632 listen_session_del (stream_session_t * s)
633 {
634   session_free (s);
635 }
636
637 transport_connection_t *listen_session_get_transport (stream_session_t * s);
638
639 int
640 listen_session_get_local_session_endpoint (stream_session_t * listener,
641                                            session_endpoint_t * sep);
642
643 void session_flush_frames_main_thread (vlib_main_t * vm);
644
645 always_inline u8
646 session_manager_is_enabled ()
647 {
648   return session_manager_main.is_enabled == 1;
649 }
650
651 #define session_cli_return_if_not_enabled()                             \
652 do {                                                                    \
653     if (!session_manager_main.is_enabled)                               \
654       return clib_error_return(0, "session layer is not enabled");      \
655 } while (0)
656
657 void session_node_enable_disable (u8 is_en);
658
659 #endif /* __included_session_h__ */
660
661 /*
662  * fd.io coding-style-patch-verification: ON
663  *
664  * Local Variables:
665  * eval: (c-set-style "gnu")
666  * End:
667  */