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