session: api to add new transport types
[vpp.git] / src / vnet / session / session.c
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 /**
16  * @file
17  * @brief Session and session manager
18  */
19
20 #include <vnet/session/session.h>
21 #include <vnet/session/session_debug.h>
22 #include <vnet/session/application.h>
23 #include <vnet/dpo/load_balance.h>
24 #include <vnet/fib/ip4_fib.h>
25
26 session_main_t session_main;
27
28 static inline int
29 session_send_evt_to_thread (void *data, void *args, u32 thread_index,
30                             session_evt_type_t evt_type)
31 {
32   session_event_t *evt;
33   svm_msg_q_msg_t msg;
34   svm_msg_q_t *mq;
35
36   mq = session_main_get_vpp_event_queue (thread_index);
37   if (PREDICT_FALSE (svm_msg_q_lock (mq)))
38     return -1;
39   if (PREDICT_FALSE (svm_msg_q_is_full (mq)
40                      || svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
41     {
42       svm_msg_q_unlock (mq);
43       return -2;
44     }
45   switch (evt_type)
46     {
47     case SESSION_CTRL_EVT_RPC:
48       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
49       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
50       evt->rpc_args.fp = data;
51       evt->rpc_args.arg = args;
52       break;
53     case SESSION_IO_EVT_RX:
54     case SESSION_IO_EVT_TX:
55     case SESSION_IO_EVT_TX_FLUSH:
56     case SESSION_IO_EVT_BUILTIN_RX:
57       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
58       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
59       evt->session_index = *(u32 *) data;
60       break;
61     case SESSION_IO_EVT_BUILTIN_TX:
62     case SESSION_CTRL_EVT_CLOSE:
63     case SESSION_CTRL_EVT_RESET:
64       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
65       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
66       evt->session_handle = session_handle ((session_t *) data);
67       break;
68     default:
69       clib_warning ("evt unhandled!");
70       svm_msg_q_unlock (mq);
71       return -1;
72     }
73   evt->event_type = evt_type;
74
75   svm_msg_q_add_and_unlock (mq, &msg);
76   return 0;
77 }
78
79 int
80 session_send_io_evt_to_thread (svm_fifo_t * f, session_evt_type_t evt_type)
81 {
82   return session_send_evt_to_thread (&f->master_session_index, 0,
83                                      f->master_thread_index, evt_type);
84 }
85
86 int
87 session_send_io_evt_to_thread_custom (void *data, u32 thread_index,
88                                       session_evt_type_t evt_type)
89 {
90   return session_send_evt_to_thread (data, 0, thread_index, evt_type);
91 }
92
93 int
94 session_send_ctrl_evt_to_thread (session_t * s, session_evt_type_t evt_type)
95 {
96   /* only events supported are disconnect and reset */
97   ASSERT (evt_type == SESSION_CTRL_EVT_CLOSE
98           || evt_type == SESSION_CTRL_EVT_RESET);
99   return session_send_evt_to_thread (s, 0, s->thread_index, evt_type);
100 }
101
102 void
103 session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp,
104                                       void *rpc_args)
105 {
106   session_send_evt_to_thread (fp, rpc_args, thread_index,
107                               SESSION_CTRL_EVT_RPC);
108 }
109
110 void
111 session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
112 {
113   if (thread_index != vlib_get_thread_index ())
114     session_send_rpc_evt_to_thread_force (thread_index, fp, rpc_args);
115   else
116     {
117       void (*fnp) (void *) = fp;
118       fnp (rpc_args);
119     }
120 }
121
122 void
123 session_add_self_custom_tx_evt (transport_connection_t * tc, u8 has_prio)
124 {
125   session_t *s;
126
127   s = session_get (tc->s_index, tc->thread_index);
128   ASSERT (s->thread_index == vlib_get_thread_index ());
129   ASSERT (s->session_state != SESSION_STATE_TRANSPORT_DELETED);
130   if (!(s->flags & SESSION_F_CUSTOM_TX))
131     {
132       s->flags |= SESSION_F_CUSTOM_TX;
133       if (svm_fifo_set_event (s->tx_fifo)
134           || transport_connection_is_descheduled (tc))
135         {
136           session_worker_t *wrk;
137           session_evt_elt_t *elt;
138           wrk = session_main_get_worker (tc->thread_index);
139           if (has_prio)
140             elt = session_evt_alloc_new (wrk);
141           else
142             elt = session_evt_alloc_old (wrk);
143           elt->evt.session_index = tc->s_index;
144           elt->evt.event_type = SESSION_IO_EVT_TX;
145           tc->flags &= ~TRANSPORT_CONNECTION_F_DESCHED;
146         }
147     }
148 }
149
150 void
151 sesssion_reschedule_tx (transport_connection_t * tc)
152 {
153   session_worker_t *wrk = session_main_get_worker (tc->thread_index);
154   session_evt_elt_t *elt;
155
156   ASSERT (tc->thread_index == vlib_get_thread_index ());
157
158   elt = session_evt_alloc_new (wrk);
159   elt->evt.session_index = tc->s_index;
160   elt->evt.event_type = SESSION_IO_EVT_TX;
161 }
162
163 static void
164 session_program_transport_ctrl_evt (session_t * s, session_evt_type_t evt)
165 {
166   u32 thread_index = vlib_get_thread_index ();
167   session_evt_elt_t *elt;
168   session_worker_t *wrk;
169
170   /* If we are in the handler thread, or being called with the worker barrier
171    * held, just append a new event to pending disconnects vector. */
172   if (vlib_thread_is_main_w_barrier () || thread_index == s->thread_index)
173     {
174       wrk = session_main_get_worker (s->thread_index);
175       elt = session_evt_alloc_ctrl (wrk);
176       clib_memset (&elt->evt, 0, sizeof (session_event_t));
177       elt->evt.session_handle = session_handle (s);
178       elt->evt.event_type = evt;
179     }
180   else
181     session_send_ctrl_evt_to_thread (s, evt);
182 }
183
184 session_t *
185 session_alloc (u32 thread_index)
186 {
187   session_worker_t *wrk = &session_main.wrk[thread_index];
188   session_t *s;
189   u8 will_expand = 0;
190   pool_get_aligned_will_expand (wrk->sessions, will_expand,
191                                 CLIB_CACHE_LINE_BYTES);
192   /* If we have peekers, let them finish */
193   if (PREDICT_FALSE (will_expand && vlib_num_workers ()))
194     {
195       clib_rwlock_writer_lock (&wrk->peekers_rw_locks);
196       pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
197       clib_rwlock_writer_unlock (&wrk->peekers_rw_locks);
198     }
199   else
200     {
201       pool_get_aligned (wrk->sessions, s, CLIB_CACHE_LINE_BYTES);
202     }
203   clib_memset (s, 0, sizeof (*s));
204   s->session_index = s - wrk->sessions;
205   s->thread_index = thread_index;
206   s->app_index = APP_INVALID_INDEX;
207   return s;
208 }
209
210 void
211 session_free (session_t * s)
212 {
213   if (CLIB_DEBUG)
214     {
215       u8 thread_index = s->thread_index;
216       clib_memset (s, 0xFA, sizeof (*s));
217       pool_put (session_main.wrk[thread_index].sessions, s);
218       return;
219     }
220   SESSION_EVT (SESSION_EVT_FREE, s);
221   pool_put (session_main.wrk[s->thread_index].sessions, s);
222 }
223
224 u8
225 session_is_valid (u32 si, u8 thread_index)
226 {
227   session_t *s;
228   transport_connection_t *tc;
229
230   s = pool_elt_at_index (session_main.wrk[thread_index].sessions, si);
231
232   if (!s)
233     return 1;
234
235   if (s->thread_index != thread_index || s->session_index != si)
236     return 0;
237
238   if (s->session_state == SESSION_STATE_TRANSPORT_DELETED
239       || s->session_state <= SESSION_STATE_LISTENING)
240     return 1;
241
242   tc = session_get_transport (s);
243   if (s->connection_index != tc->c_index
244       || s->thread_index != tc->thread_index || tc->s_index != si)
245     return 0;
246
247   return 1;
248 }
249
250 static void
251 session_cleanup_notify (session_t * s, session_cleanup_ntf_t ntf)
252 {
253   app_worker_t *app_wrk;
254
255   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
256   if (!app_wrk)
257     return;
258   app_worker_cleanup_notify (app_wrk, s, ntf);
259 }
260
261 void
262 session_free_w_fifos (session_t * s)
263 {
264   session_cleanup_notify (s, SESSION_CLEANUP_SESSION);
265   segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
266   session_free (s);
267 }
268
269 /**
270  * Cleans up session and lookup table.
271  *
272  * Transport connection must still be valid.
273  */
274 static void
275 session_delete (session_t * s)
276 {
277   int rv;
278
279   /* Delete from the main lookup table. */
280   if ((rv = session_lookup_del_session (s)))
281     clib_warning ("session %u hash delete rv %d", s->session_index, rv);
282
283   session_free_w_fifos (s);
284 }
285
286 session_t *
287 session_alloc_for_connection (transport_connection_t * tc)
288 {
289   session_t *s;
290   u32 thread_index = tc->thread_index;
291
292   ASSERT (thread_index == vlib_get_thread_index ()
293           || transport_protocol_is_cl (tc->proto));
294
295   s = session_alloc (thread_index);
296   s->session_type = session_type_from_proto_and_ip (tc->proto, tc->is_ip4);
297   s->session_state = SESSION_STATE_CLOSED;
298
299   /* Attach transport to session and vice versa */
300   s->connection_index = tc->c_index;
301   tc->s_index = s->session_index;
302   return s;
303 }
304
305 /**
306  * Discards bytes from buffer chain
307  *
308  * It discards n_bytes_to_drop starting at first buffer after chain_b
309  */
310 always_inline void
311 session_enqueue_discard_chain_bytes (vlib_main_t * vm, vlib_buffer_t * b,
312                                      vlib_buffer_t ** chain_b,
313                                      u32 n_bytes_to_drop)
314 {
315   vlib_buffer_t *next = *chain_b;
316   u32 to_drop = n_bytes_to_drop;
317   ASSERT (b->flags & VLIB_BUFFER_NEXT_PRESENT);
318   while (to_drop && (next->flags & VLIB_BUFFER_NEXT_PRESENT))
319     {
320       next = vlib_get_buffer (vm, next->next_buffer);
321       if (next->current_length > to_drop)
322         {
323           vlib_buffer_advance (next, to_drop);
324           to_drop = 0;
325         }
326       else
327         {
328           to_drop -= next->current_length;
329           next->current_length = 0;
330         }
331     }
332   *chain_b = next;
333
334   if (to_drop == 0)
335     b->total_length_not_including_first_buffer -= n_bytes_to_drop;
336 }
337
338 /**
339  * Enqueue buffer chain tail
340  */
341 always_inline int
342 session_enqueue_chain_tail (session_t * s, vlib_buffer_t * b,
343                             u32 offset, u8 is_in_order)
344 {
345   vlib_buffer_t *chain_b;
346   u32 chain_bi, len, diff;
347   vlib_main_t *vm = vlib_get_main ();
348   u8 *data;
349   u32 written = 0;
350   int rv = 0;
351
352   if (is_in_order && offset)
353     {
354       diff = offset - b->current_length;
355       if (diff > b->total_length_not_including_first_buffer)
356         return 0;
357       chain_b = b;
358       session_enqueue_discard_chain_bytes (vm, b, &chain_b, diff);
359       chain_bi = vlib_get_buffer_index (vm, chain_b);
360     }
361   else
362     chain_bi = b->next_buffer;
363
364   do
365     {
366       chain_b = vlib_get_buffer (vm, chain_bi);
367       data = vlib_buffer_get_current (chain_b);
368       len = chain_b->current_length;
369       if (!len)
370         continue;
371       if (is_in_order)
372         {
373           rv = svm_fifo_enqueue (s->rx_fifo, len, data);
374           if (rv == len)
375             {
376               written += rv;
377             }
378           else if (rv < len)
379             {
380               return (rv > 0) ? (written + rv) : written;
381             }
382           else if (rv > len)
383             {
384               written += rv;
385
386               /* written more than what was left in chain */
387               if (written > b->total_length_not_including_first_buffer)
388                 return written;
389
390               /* drop the bytes that have already been delivered */
391               session_enqueue_discard_chain_bytes (vm, b, &chain_b, rv - len);
392             }
393         }
394       else
395         {
396           rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset, len, data);
397           if (rv)
398             {
399               clib_warning ("failed to enqueue multi-buffer seg");
400               return -1;
401             }
402           offset += len;
403         }
404     }
405   while ((chain_bi = (chain_b->flags & VLIB_BUFFER_NEXT_PRESENT)
406           ? chain_b->next_buffer : 0));
407
408   if (is_in_order)
409     return written;
410
411   return 0;
412 }
413
414 void
415 session_fifo_tuning (session_t * s, svm_fifo_t * f,
416                      session_ft_action_t act, u32 len)
417 {
418   if (s->flags & SESSION_F_CUSTOM_FIFO_TUNING)
419     {
420       app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
421       app_worker_session_fifo_tuning (app_wrk, s, f, act, len);
422       if (CLIB_ASSERT_ENABLE)
423         {
424           segment_manager_t *sm;
425           sm = segment_manager_get (f->segment_manager);
426           ASSERT (f->size >= 4096);
427           ASSERT (f->size <= sm->max_fifo_size);
428         }
429     }
430 }
431
432 /*
433  * Enqueue data for delivery to session peer. Does not notify peer of enqueue
434  * event but on request can queue notification events for later delivery by
435  * calling stream_server_flush_enqueue_events().
436  *
437  * @param tc Transport connection which is to be enqueued data
438  * @param b Buffer to be enqueued
439  * @param offset Offset at which to start enqueueing if out-of-order
440  * @param queue_event Flag to indicate if peer is to be notified or if event
441  *                    is to be queued. The former is useful when more data is
442  *                    enqueued and only one event is to be generated.
443  * @param is_in_order Flag to indicate if data is in order
444  * @return Number of bytes enqueued or a negative value if enqueueing failed.
445  */
446 int
447 session_enqueue_stream_connection (transport_connection_t * tc,
448                                    vlib_buffer_t * b, u32 offset,
449                                    u8 queue_event, u8 is_in_order)
450 {
451   session_t *s;
452   int enqueued = 0, rv, in_order_off;
453
454   s = session_get (tc->s_index, tc->thread_index);
455
456   if (is_in_order)
457     {
458       enqueued = svm_fifo_enqueue (s->rx_fifo,
459                                    b->current_length,
460                                    vlib_buffer_get_current (b));
461       if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT)
462                          && enqueued >= 0))
463         {
464           in_order_off = enqueued > b->current_length ? enqueued : 0;
465           rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
466           if (rv > 0)
467             enqueued += rv;
468         }
469     }
470   else
471     {
472       rv = svm_fifo_enqueue_with_offset (s->rx_fifo, offset,
473                                          b->current_length,
474                                          vlib_buffer_get_current (b));
475       if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && !rv))
476         session_enqueue_chain_tail (s, b, offset + b->current_length, 0);
477       /* if something was enqueued, report even this as success for ooo
478        * segment handling */
479       return rv;
480     }
481
482   if (queue_event)
483     {
484       /* Queue RX event on this fifo. Eventually these will need to be flushed
485        * by calling stream_server_flush_enqueue_events () */
486       session_worker_t *wrk;
487
488       wrk = session_main_get_worker (s->thread_index);
489       if (!(s->flags & SESSION_F_RX_EVT))
490         {
491           s->flags |= SESSION_F_RX_EVT;
492           vec_add1 (wrk->session_to_enqueue[tc->proto], s->session_index);
493         }
494
495       session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
496     }
497
498   return enqueued;
499 }
500
501 int
502 session_enqueue_dgram_connection (session_t * s,
503                                   session_dgram_hdr_t * hdr,
504                                   vlib_buffer_t * b, u8 proto, u8 queue_event)
505 {
506   int enqueued = 0, rv, in_order_off;
507
508   ASSERT (svm_fifo_max_enqueue_prod (s->rx_fifo)
509           >= b->current_length + sizeof (*hdr));
510
511   svm_fifo_enqueue (s->rx_fifo, sizeof (session_dgram_hdr_t), (u8 *) hdr);
512   enqueued = svm_fifo_enqueue (s->rx_fifo, b->current_length,
513                                vlib_buffer_get_current (b));
514   if (PREDICT_FALSE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) && enqueued >= 0))
515     {
516       in_order_off = enqueued > b->current_length ? enqueued : 0;
517       rv = session_enqueue_chain_tail (s, b, in_order_off, 1);
518       if (rv > 0)
519         enqueued += rv;
520     }
521   if (queue_event)
522     {
523       /* Queue RX event on this fifo. Eventually these will need to be flushed
524        * by calling stream_server_flush_enqueue_events () */
525       session_worker_t *wrk;
526
527       wrk = session_main_get_worker (s->thread_index);
528       if (!(s->flags & SESSION_F_RX_EVT))
529         {
530           s->flags |= SESSION_F_RX_EVT;
531           vec_add1 (wrk->session_to_enqueue[proto], s->session_index);
532         }
533
534       session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED, 0);
535     }
536   return enqueued;
537 }
538
539 int
540 session_tx_fifo_peek_bytes (transport_connection_t * tc, u8 * buffer,
541                             u32 offset, u32 max_bytes)
542 {
543   session_t *s = session_get (tc->s_index, tc->thread_index);
544   return svm_fifo_peek (s->tx_fifo, offset, max_bytes, buffer);
545 }
546
547 u32
548 session_tx_fifo_dequeue_drop (transport_connection_t * tc, u32 max_bytes)
549 {
550   session_t *s = session_get (tc->s_index, tc->thread_index);
551   u32 rv;
552
553   rv = svm_fifo_dequeue_drop (s->tx_fifo, max_bytes);
554   session_fifo_tuning (s, s->tx_fifo, SESSION_FT_ACTION_DEQUEUED, rv);
555
556   if (svm_fifo_needs_deq_ntf (s->tx_fifo, max_bytes))
557     session_dequeue_notify (s);
558
559   return rv;
560 }
561
562 static inline int
563 session_notify_subscribers (u32 app_index, session_t * s,
564                             svm_fifo_t * f, session_evt_type_t evt_type)
565 {
566   app_worker_t *app_wrk;
567   application_t *app;
568   int i;
569
570   app = application_get (app_index);
571   if (!app)
572     return -1;
573
574   for (i = 0; i < f->n_subscribers; i++)
575     {
576       app_wrk = application_get_worker (app, f->subscribers[i]);
577       if (!app_wrk)
578         continue;
579       if (app_worker_lock_and_send_event (app_wrk, s, evt_type))
580         return -1;
581     }
582
583   return 0;
584 }
585
586 /**
587  * Notify session peer that new data has been enqueued.
588  *
589  * @param s     Stream session for which the event is to be generated.
590  * @param lock  Flag to indicate if call should lock message queue.
591  *
592  * @return 0 on success or negative number if failed to send notification.
593  */
594 static inline int
595 session_enqueue_notify_inline (session_t * s)
596 {
597   app_worker_t *app_wrk;
598   u32 session_index;
599   u8 n_subscribers;
600
601   session_index = s->session_index;
602   n_subscribers = svm_fifo_n_subscribers (s->rx_fifo);
603
604   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
605   if (PREDICT_FALSE (!app_wrk))
606     {
607       SESSION_DBG ("invalid s->app_index = %d", s->app_wrk_index);
608       return 0;
609     }
610
611   SESSION_EVT (SESSION_EVT_ENQ, s, svm_fifo_max_dequeue_prod (s->rx_fifo));
612
613   s->flags &= ~SESSION_F_RX_EVT;
614   if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
615                                                      SESSION_IO_EVT_RX)))
616     return -1;
617
618   if (PREDICT_FALSE (n_subscribers))
619     {
620       s = session_get (session_index, vlib_get_thread_index ());
621       return session_notify_subscribers (app_wrk->app_index, s,
622                                          s->rx_fifo, SESSION_IO_EVT_RX);
623     }
624
625   return 0;
626 }
627
628 int
629 session_enqueue_notify (session_t * s)
630 {
631   return session_enqueue_notify_inline (s);
632 }
633
634 static void
635 session_enqueue_notify_rpc (void *arg)
636 {
637   u32 session_index = pointer_to_uword (arg);
638   session_t *s;
639
640   s = session_get_if_valid (session_index, vlib_get_thread_index ());
641   if (!s)
642     return;
643
644   session_enqueue_notify (s);
645 }
646
647 /**
648  * Like session_enqueue_notify, but can be called from a thread that does not
649  * own the session.
650  */
651 void
652 session_enqueue_notify_thread (session_handle_t sh)
653 {
654   u32 thread_index = session_thread_from_handle (sh);
655   u32 session_index = session_index_from_handle (sh);
656
657   /*
658    * Pass session index (u32) as opposed to handle (u64) in case pointers
659    * are not 64-bit.
660    */
661   session_send_rpc_evt_to_thread (thread_index,
662                                   session_enqueue_notify_rpc,
663                                   uword_to_pointer (session_index, void *));
664 }
665
666 int
667 session_dequeue_notify (session_t * s)
668 {
669   app_worker_t *app_wrk;
670
671   svm_fifo_clear_deq_ntf (s->tx_fifo);
672
673   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
674   if (PREDICT_FALSE (!app_wrk))
675     return -1;
676
677   if (PREDICT_FALSE (app_worker_lock_and_send_event (app_wrk, s,
678                                                      SESSION_IO_EVT_TX)))
679     return -1;
680
681   if (PREDICT_FALSE (s->tx_fifo->n_subscribers))
682     return session_notify_subscribers (app_wrk->app_index, s,
683                                        s->tx_fifo, SESSION_IO_EVT_TX);
684
685   return 0;
686 }
687
688 /**
689  * Flushes queue of sessions that are to be notified of new data
690  * enqueued events.
691  *
692  * @param thread_index Thread index for which the flush is to be performed.
693  * @return 0 on success or a positive number indicating the number of
694  *         failures due to API queue being full.
695  */
696 int
697 session_main_flush_enqueue_events (u8 transport_proto, u32 thread_index)
698 {
699   session_worker_t *wrk = session_main_get_worker (thread_index);
700   session_t *s;
701   int i, errors = 0;
702   u32 *indices;
703
704   indices = wrk->session_to_enqueue[transport_proto];
705
706   for (i = 0; i < vec_len (indices); i++)
707     {
708       s = session_get_if_valid (indices[i], thread_index);
709       if (PREDICT_FALSE (!s))
710         {
711           errors++;
712           continue;
713         }
714
715       session_fifo_tuning (s, s->rx_fifo, SESSION_FT_ACTION_ENQUEUED,
716                            0 /* TODO/not needed */ );
717
718       if (PREDICT_FALSE (session_enqueue_notify_inline (s)))
719         errors++;
720     }
721
722   vec_reset_length (indices);
723   wrk->session_to_enqueue[transport_proto] = indices;
724
725   return errors;
726 }
727
728 int
729 session_main_flush_all_enqueue_events (u8 transport_proto)
730 {
731   vlib_thread_main_t *vtm = vlib_get_thread_main ();
732   int i, errors = 0;
733   for (i = 0; i < 1 + vtm->n_threads; i++)
734     errors += session_main_flush_enqueue_events (transport_proto, i);
735   return errors;
736 }
737
738 static inline int
739 session_stream_connect_notify_inline (transport_connection_t * tc, u8 is_fail,
740                                       session_state_t opened_state)
741 {
742   u32 opaque = 0, new_ti, new_si;
743   app_worker_t *app_wrk;
744   session_t *s = 0;
745   u64 ho_handle;
746
747   /*
748    * Find connection handle and cleanup half-open table
749    */
750   ho_handle = session_lookup_half_open_handle (tc);
751   if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
752     {
753       SESSION_DBG ("half-open was removed!");
754       return -1;
755     }
756   session_lookup_del_half_open (tc);
757
758   /* Get the app's index from the handle we stored when opening connection
759    * and the opaque (api_context for external apps) from transport session
760    * index */
761   app_wrk = app_worker_get_if_valid (ho_handle >> 32);
762   if (!app_wrk)
763     return -1;
764
765   opaque = tc->s_index;
766
767   if (is_fail)
768     return app_worker_connect_notify (app_wrk, s, opaque);
769
770   s = session_alloc_for_connection (tc);
771   s->session_state = SESSION_STATE_CONNECTING;
772   s->app_wrk_index = app_wrk->wrk_index;
773   new_si = s->session_index;
774   new_ti = s->thread_index;
775
776   if (app_worker_init_connected (app_wrk, s))
777     {
778       session_free (s);
779       app_worker_connect_notify (app_wrk, 0, opaque);
780       return -1;
781     }
782
783   s = session_get (new_si, new_ti);
784   s->session_state = opened_state;
785   session_lookup_add_connection (tc, session_handle (s));
786
787   if (app_worker_connect_notify (app_wrk, s, opaque))
788     {
789       s = session_get (new_si, new_ti);
790       session_free_w_fifos (s);
791       return -1;
792     }
793
794   return 0;
795 }
796
797 int
798 session_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
799 {
800   return session_stream_connect_notify_inline (tc, is_fail,
801                                                SESSION_STATE_READY);
802 }
803
804 int
805 session_ho_stream_connect_notify (transport_connection_t * tc, u8 is_fail)
806 {
807   return session_stream_connect_notify_inline (tc, is_fail,
808                                                SESSION_STATE_OPENED);
809 }
810
811 typedef struct _session_switch_pool_args
812 {
813   u32 session_index;
814   u32 thread_index;
815   u32 new_thread_index;
816   u32 new_session_index;
817 } session_switch_pool_args_t;
818
819 /**
820  * Notify old thread of the session pool switch
821  */
822 static void
823 session_switch_pool (void *cb_args)
824 {
825   session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
826   app_worker_t *app_wrk;
827   session_t *s;
828
829   ASSERT (args->thread_index == vlib_get_thread_index ());
830   s = session_get (args->session_index, args->thread_index);
831   s->tx_fifo->master_session_index = args->new_session_index;
832   s->tx_fifo->master_thread_index = args->new_thread_index;
833   transport_cleanup (session_get_transport_proto (s), s->connection_index,
834                      s->thread_index);
835
836   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
837   if (app_wrk)
838     {
839       session_handle_t new_sh;
840       new_sh = session_make_handle (args->new_session_index,
841                                     args->new_thread_index);
842       app_worker_migrate_notify (app_wrk, s, new_sh);
843
844       /* Trigger app read on the new thread */
845       session_enqueue_notify_thread (new_sh);
846     }
847
848   session_free (s);
849   clib_mem_free (cb_args);
850 }
851
852 /**
853  * Move dgram session to the right thread
854  */
855 int
856 session_dgram_connect_notify (transport_connection_t * tc,
857                               u32 old_thread_index, session_t ** new_session)
858 {
859   session_t *new_s;
860   session_switch_pool_args_t *rpc_args;
861
862   /*
863    * Clone half-open session to the right thread.
864    */
865   new_s = session_clone_safe (tc->s_index, old_thread_index);
866   new_s->connection_index = tc->c_index;
867   new_s->rx_fifo->master_session_index = new_s->session_index;
868   new_s->rx_fifo->master_thread_index = new_s->thread_index;
869   new_s->session_state = SESSION_STATE_READY;
870   new_s->flags |= SESSION_F_IS_MIGRATING;
871   session_lookup_add_connection (tc, session_handle (new_s));
872
873   /*
874    * Ask thread owning the old session to clean it up and make us the tx
875    * fifo owner
876    */
877   rpc_args = clib_mem_alloc (sizeof (*rpc_args));
878   rpc_args->new_session_index = new_s->session_index;
879   rpc_args->new_thread_index = new_s->thread_index;
880   rpc_args->session_index = tc->s_index;
881   rpc_args->thread_index = old_thread_index;
882   session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
883                                   rpc_args);
884
885   tc->s_index = new_s->session_index;
886   new_s->connection_index = tc->c_index;
887   *new_session = new_s;
888   return 0;
889 }
890
891 /**
892  * Notification from transport that connection is being closed.
893  *
894  * A disconnect is sent to application but state is not removed. Once
895  * disconnect is acknowledged by application, session disconnect is called.
896  * Ultimately this leads to close being called on transport (passive close).
897  */
898 void
899 session_transport_closing_notify (transport_connection_t * tc)
900 {
901   app_worker_t *app_wrk;
902   session_t *s;
903
904   s = session_get (tc->s_index, tc->thread_index);
905   if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
906     return;
907   s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
908   app_wrk = app_worker_get (s->app_wrk_index);
909   app_worker_close_notify (app_wrk, s);
910 }
911
912 /**
913  * Notification from transport that connection is being deleted
914  *
915  * This removes the session if it is still valid. It should be called only on
916  * previously fully established sessions. For instance failed connects should
917  * call stream_session_connect_notify and indicate that the connect has
918  * failed.
919  */
920 void
921 session_transport_delete_notify (transport_connection_t * tc)
922 {
923   session_t *s;
924
925   /* App might've been removed already */
926   if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
927     return;
928
929   switch (s->session_state)
930     {
931     case SESSION_STATE_CREATED:
932       /* Session was created but accept notification was not yet sent to the
933        * app. Cleanup everything. */
934       session_lookup_del_session (s);
935       segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
936       session_free (s);
937       break;
938     case SESSION_STATE_ACCEPTING:
939     case SESSION_STATE_TRANSPORT_CLOSING:
940     case SESSION_STATE_CLOSING:
941     case SESSION_STATE_TRANSPORT_CLOSED:
942       /* If transport finishes or times out before we get a reply
943        * from the app, mark transport as closed and wait for reply
944        * before removing the session. Cleanup session table in advance
945        * because transport will soon be closed and closed sessions
946        * are assumed to have been removed from the lookup table */
947       session_lookup_del_session (s);
948       s->session_state = SESSION_STATE_TRANSPORT_DELETED;
949       session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
950       svm_fifo_dequeue_drop_all (s->tx_fifo);
951       break;
952     case SESSION_STATE_APP_CLOSED:
953       /* Cleanup lookup table as transport needs to still be valid.
954        * Program transport close to ensure that all session events
955        * have been cleaned up. Once transport close is called, the
956        * session is just removed because both transport and app have
957        * confirmed the close*/
958       session_lookup_del_session (s);
959       s->session_state = SESSION_STATE_TRANSPORT_DELETED;
960       session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
961       svm_fifo_dequeue_drop_all (s->tx_fifo);
962       session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
963       break;
964     case SESSION_STATE_TRANSPORT_DELETED:
965       break;
966     case SESSION_STATE_CLOSED:
967       session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
968       session_delete (s);
969       break;
970     default:
971       clib_warning ("session state %u", s->session_state);
972       session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
973       session_delete (s);
974       break;
975     }
976 }
977
978 /**
979  * Notification from transport that it is closed
980  *
981  * Should be called by transport, prior to calling delete notify, once it
982  * knows that no more data will be exchanged. This could serve as an
983  * early acknowledgment of an active close especially if transport delete
984  * can be delayed a long time, e.g., tcp time-wait.
985  */
986 void
987 session_transport_closed_notify (transport_connection_t * tc)
988 {
989   app_worker_t *app_wrk;
990   session_t *s;
991
992   if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
993     return;
994
995   /* Transport thinks that app requested close but it actually didn't.
996    * Can happen for tcp if fin and rst are received in close succession. */
997   if (s->session_state == SESSION_STATE_READY)
998     {
999       session_transport_closing_notify (tc);
1000       svm_fifo_dequeue_drop_all (s->tx_fifo);
1001       s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
1002     }
1003   /* If app close has not been received or has not yet resulted in
1004    * a transport close, only mark the session transport as closed */
1005   else if (s->session_state <= SESSION_STATE_CLOSING)
1006     {
1007       s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
1008     }
1009   /* If app also closed, switch to closed */
1010   else if (s->session_state == SESSION_STATE_APP_CLOSED)
1011     s->session_state = SESSION_STATE_CLOSED;
1012
1013   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1014   if (app_wrk)
1015     app_worker_transport_closed_notify (app_wrk, s);
1016 }
1017
1018 /**
1019  * Notify application that connection has been reset.
1020  */
1021 void
1022 session_transport_reset_notify (transport_connection_t * tc)
1023 {
1024   app_worker_t *app_wrk;
1025   session_t *s;
1026
1027   s = session_get (tc->s_index, tc->thread_index);
1028   svm_fifo_dequeue_drop_all (s->tx_fifo);
1029   if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1030     return;
1031   s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1032   app_wrk = app_worker_get (s->app_wrk_index);
1033   app_worker_reset_notify (app_wrk, s);
1034 }
1035
1036 int
1037 session_stream_accept_notify (transport_connection_t * tc)
1038 {
1039   app_worker_t *app_wrk;
1040   session_t *s;
1041
1042   s = session_get (tc->s_index, tc->thread_index);
1043   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1044   if (!app_wrk)
1045     return -1;
1046   s->session_state = SESSION_STATE_ACCEPTING;
1047   if (app_worker_accept_notify (app_wrk, s))
1048     {
1049       /* On transport delete, no notifications should be sent. Unless, the
1050        * accept is retried and successful. */
1051       s->session_state = SESSION_STATE_CREATED;
1052       return -1;
1053     }
1054   return 0;
1055 }
1056
1057 /**
1058  * Accept a stream session. Optionally ping the server by callback.
1059  */
1060 int
1061 session_stream_accept (transport_connection_t * tc, u32 listener_index,
1062                        u32 thread_index, u8 notify)
1063 {
1064   session_t *s;
1065   int rv;
1066
1067   s = session_alloc_for_connection (tc);
1068   s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1069   s->session_state = SESSION_STATE_CREATED;
1070
1071   if ((rv = app_worker_init_accepted (s)))
1072     return rv;
1073
1074   session_lookup_add_connection (tc, session_handle (s));
1075
1076   /* Shoulder-tap the server */
1077   if (notify)
1078     {
1079       app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1080       return app_worker_accept_notify (app_wrk, s);
1081     }
1082
1083   return 0;
1084 }
1085
1086 int
1087 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1088 {
1089   transport_connection_t *tc;
1090   transport_endpoint_cfg_t *tep;
1091   app_worker_t *app_wrk;
1092   session_handle_t sh;
1093   session_t *s;
1094   int rv;
1095
1096   tep = session_endpoint_to_transport_cfg (rmt);
1097   rv = transport_connect (rmt->transport_proto, tep);
1098   if (rv < 0)
1099     {
1100       SESSION_DBG ("Transport failed to open connection.");
1101       return VNET_API_ERROR_SESSION_CONNECT;
1102     }
1103
1104   tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1105
1106   /* For dgram type of service, allocate session and fifos now */
1107   app_wrk = app_worker_get (app_wrk_index);
1108   s = session_alloc_for_connection (tc);
1109   s->app_wrk_index = app_wrk->wrk_index;
1110   s->session_state = SESSION_STATE_OPENED;
1111   if (app_worker_init_connected (app_wrk, s))
1112     {
1113       session_free (s);
1114       return -1;
1115     }
1116
1117   sh = session_handle (s);
1118   session_lookup_add_connection (tc, sh);
1119   return app_worker_connect_notify (app_wrk, s, opaque);
1120 }
1121
1122 int
1123 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1124 {
1125   transport_connection_t *tc;
1126   transport_endpoint_cfg_t *tep;
1127   u64 handle;
1128   int rv;
1129
1130   tep = session_endpoint_to_transport_cfg (rmt);
1131   rv = transport_connect (rmt->transport_proto, tep);
1132   if (rv < 0)
1133     {
1134       SESSION_DBG ("Transport failed to open connection.");
1135       return VNET_API_ERROR_SESSION_CONNECT;
1136     }
1137
1138   tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1139
1140   /* If transport offers a stream service, only allocate session once the
1141    * connection has been established.
1142    * Add connection to half-open table and save app and tc index. The
1143    * latter is needed to help establish the connection while the former
1144    * is needed when the connect notify comes and we have to notify the
1145    * external app
1146    */
1147   handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1148   session_lookup_add_half_open (tc, handle);
1149
1150   /* Store api_context (opaque) for when the reply comes. Not the nicest
1151    * thing but better than allocating a separate half-open pool.
1152    */
1153   tc->s_index = opaque;
1154   if (transport_half_open_has_fifos (rmt->transport_proto))
1155     return session_ho_stream_connect_notify (tc, 0 /* is_fail */ );
1156   return 0;
1157 }
1158
1159 int
1160 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1161 {
1162   session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1163   transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1164
1165   sep->app_wrk_index = app_wrk_index;
1166   sep->opaque = opaque;
1167
1168   return transport_connect (rmt->transport_proto, tep_cfg);
1169 }
1170
1171 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1172
1173 /* *INDENT-OFF* */
1174 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1175   session_open_vc,
1176   session_open_cl,
1177   session_open_app,
1178 };
1179 /* *INDENT-ON* */
1180
1181 /**
1182  * Ask transport to open connection to remote transport endpoint.
1183  *
1184  * Stores handle for matching request with reply since the call can be
1185  * asynchronous. For instance, for TCP the 3-way handshake must complete
1186  * before reply comes. Session is only created once connection is established.
1187  *
1188  * @param app_index Index of the application requesting the connect
1189  * @param st Session type requested.
1190  * @param tep Remote transport endpoint
1191  * @param opaque Opaque data (typically, api_context) the application expects
1192  *               on open completion.
1193  */
1194 int
1195 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1196 {
1197   transport_service_type_t tst;
1198   tst = transport_protocol_service_type (rmt->transport_proto);
1199   return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1200 }
1201
1202 /**
1203  * Ask transport to listen on session endpoint.
1204  *
1205  * @param s Session for which listen will be called. Note that unlike
1206  *          established sessions, listen sessions are not associated to a
1207  *          thread.
1208  * @param sep Local endpoint to be listened on.
1209  */
1210 int
1211 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1212 {
1213   transport_endpoint_t *tep;
1214   u32 tc_index, s_index;
1215
1216   /* Transport bind/listen */
1217   tep = session_endpoint_to_transport (sep);
1218   s_index = ls->session_index;
1219   tc_index = transport_start_listen (session_get_transport_proto (ls),
1220                                      s_index, tep);
1221
1222   if (tc_index == (u32) ~ 0)
1223     return -1;
1224
1225   /* Attach transport to session. Lookup tables are populated by the app
1226    * worker because local tables (for ct sessions) are not backed by a fib */
1227   ls = listen_session_get (s_index);
1228   ls->connection_index = tc_index;
1229
1230   return 0;
1231 }
1232
1233 /**
1234  * Ask transport to stop listening on local transport endpoint.
1235  *
1236  * @param s Session to stop listening on. It must be in state LISTENING.
1237  */
1238 int
1239 session_stop_listen (session_t * s)
1240 {
1241   transport_proto_t tp = session_get_transport_proto (s);
1242   transport_connection_t *tc;
1243
1244   if (s->session_state != SESSION_STATE_LISTENING)
1245     return -1;
1246
1247   tc = transport_get_listener (tp, s->connection_index);
1248   if (!tc)
1249     return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
1250
1251   if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1252     session_lookup_del_connection (tc);
1253   transport_stop_listen (tp, s->connection_index);
1254   return 0;
1255 }
1256
1257 /**
1258  * Initialize session closing procedure.
1259  *
1260  * Request is always sent to session node to ensure that all outstanding
1261  * requests are served before transport is notified.
1262  */
1263 void
1264 session_close (session_t * s)
1265 {
1266   if (!s)
1267     return;
1268
1269   if (s->session_state >= SESSION_STATE_CLOSING)
1270     {
1271       /* Session will only be removed once both app and transport
1272        * acknowledge the close */
1273       if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1274           || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1275         session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1276       return;
1277     }
1278
1279   s->session_state = SESSION_STATE_CLOSING;
1280   session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1281 }
1282
1283 /**
1284  * Force a close without waiting for data to be flushed
1285  */
1286 void
1287 session_reset (session_t * s)
1288 {
1289   if (s->session_state >= SESSION_STATE_CLOSING)
1290     return;
1291   /* Drop all outstanding tx data */
1292   svm_fifo_dequeue_drop_all (s->tx_fifo);
1293   s->session_state = SESSION_STATE_CLOSING;
1294   session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_RESET);
1295 }
1296
1297 /**
1298  * Notify transport the session can be disconnected. This should eventually
1299  * result in a delete notification that allows us to cleanup session state.
1300  * Called for both active/passive disconnects.
1301  *
1302  * Must be called from the session's thread.
1303  */
1304 void
1305 session_transport_close (session_t * s)
1306 {
1307   if (s->session_state >= SESSION_STATE_APP_CLOSED)
1308     {
1309       if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1310         s->session_state = SESSION_STATE_CLOSED;
1311       /* If transport is already deleted, just free the session */
1312       else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1313         session_free_w_fifos (s);
1314       return;
1315     }
1316
1317   /* If the tx queue wasn't drained, the transport can continue to try
1318    * sending the outstanding data (in closed state it cannot). It MUST however
1319    * at one point, either after sending everything or after a timeout, call
1320    * delete notify. This will finally lead to the complete cleanup of the
1321    * session.
1322    */
1323   s->session_state = SESSION_STATE_APP_CLOSED;
1324
1325   transport_close (session_get_transport_proto (s), s->connection_index,
1326                    s->thread_index);
1327 }
1328
1329 /**
1330  * Force transport close
1331  */
1332 void
1333 session_transport_reset (session_t * s)
1334 {
1335   if (s->session_state >= SESSION_STATE_APP_CLOSED)
1336     {
1337       if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1338         s->session_state = SESSION_STATE_CLOSED;
1339       else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1340         session_free_w_fifos (s);
1341       return;
1342     }
1343
1344   s->session_state = SESSION_STATE_APP_CLOSED;
1345   transport_reset (session_get_transport_proto (s), s->connection_index,
1346                    s->thread_index);
1347 }
1348
1349 /**
1350  * Cleanup transport and session state.
1351  *
1352  * Notify transport of the cleanup and free the session. This should
1353  * be called only if transport reported some error and is already
1354  * closed.
1355  */
1356 void
1357 session_transport_cleanup (session_t * s)
1358 {
1359   /* Delete from main lookup table before we axe the the transport */
1360   session_lookup_del_session (s);
1361   if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1362     transport_cleanup (session_get_transport_proto (s), s->connection_index,
1363                        s->thread_index);
1364   /* Since we called cleanup, no delete notification will come. So, make
1365    * sure the session is properly freed. */
1366   segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1367   session_free (s);
1368 }
1369
1370 /**
1371  * Allocate event queues in the shared-memory segment
1372  *
1373  * That can either be a newly created memfd segment, that will need to be
1374  * mapped by all stack users, or the binary api's svm region. The latter is
1375  * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1376  * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1377  * vpp uses api svm region for event queues.
1378  */
1379 void
1380 session_vpp_event_queues_allocate (session_main_t * smm)
1381 {
1382   u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1383   ssvm_private_t *eqs = &smm->evt_qs_segment;
1384   uword eqs_size = 64 << 20;
1385   pid_t vpp_pid = getpid ();
1386   void *oldheap;
1387   int i;
1388
1389   if (smm->configured_event_queue_length)
1390     evt_q_length = smm->configured_event_queue_length;
1391
1392   if (smm->evt_qs_use_memfd_seg)
1393     {
1394       if (smm->evt_qs_segment_size)
1395         eqs_size = smm->evt_qs_segment_size;
1396
1397       eqs->ssvm_size = eqs_size;
1398       eqs->i_am_master = 1;
1399       eqs->my_pid = vpp_pid;
1400       eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1401       eqs->requested_va = smm->session_baseva;
1402
1403       if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1404         {
1405           clib_warning ("failed to initialize queue segment");
1406           return;
1407         }
1408     }
1409
1410   if (smm->evt_qs_use_memfd_seg)
1411     oldheap = ssvm_push_heap (eqs->sh);
1412   else
1413     oldheap = vl_msg_push_heap ();
1414
1415   for (i = 0; i < vec_len (smm->wrk); i++)
1416     {
1417       svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1418       svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1419         {evt_q_length, evt_size, 0}
1420         ,
1421         {evt_q_length >> 1, 256, 0}
1422       };
1423       cfg->consumer_pid = 0;
1424       cfg->n_rings = 2;
1425       cfg->q_nitems = evt_q_length;
1426       cfg->ring_cfgs = rc;
1427       smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1428       if (smm->evt_qs_use_memfd_seg)
1429         {
1430           if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1431             clib_warning ("eventfd returned");
1432         }
1433     }
1434
1435   if (smm->evt_qs_use_memfd_seg)
1436     ssvm_pop_heap (oldheap);
1437   else
1438     vl_msg_pop_heap (oldheap);
1439 }
1440
1441 ssvm_private_t *
1442 session_main_get_evt_q_segment (void)
1443 {
1444   session_main_t *smm = &session_main;
1445   if (smm->evt_qs_use_memfd_seg)
1446     return &smm->evt_qs_segment;
1447   return 0;
1448 }
1449
1450 u64
1451 session_segment_handle (session_t * s)
1452 {
1453   svm_fifo_t *f;
1454
1455   if (!s->rx_fifo)
1456     return SESSION_INVALID_HANDLE;
1457
1458   f = s->rx_fifo;
1459   return segment_manager_make_segment_handle (f->segment_manager,
1460                                               f->segment_index);
1461 }
1462
1463 /* *INDENT-OFF* */
1464 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1465     session_tx_fifo_peek_and_snd,
1466     session_tx_fifo_dequeue_and_snd,
1467     session_tx_fifo_dequeue_internal,
1468     session_tx_fifo_dequeue_and_snd
1469 };
1470 /* *INDENT-ON* */
1471
1472 void
1473 session_register_transport (transport_proto_t transport_proto,
1474                             const transport_proto_vft_t * vft, u8 is_ip4,
1475                             u32 output_node)
1476 {
1477   session_main_t *smm = &session_main;
1478   session_type_t session_type;
1479   u32 next_index = ~0;
1480
1481   session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1482
1483   vec_validate (smm->session_type_to_next, session_type);
1484   vec_validate (smm->session_tx_fns, session_type);
1485
1486   /* *INDENT-OFF* */
1487   if (output_node != ~0)
1488     {
1489       foreach_vlib_main (({
1490           next_index = vlib_node_add_next (this_vlib_main,
1491                                            session_queue_node.index,
1492                                            output_node);
1493       }));
1494     }
1495   /* *INDENT-ON* */
1496
1497   smm->session_type_to_next[session_type] = next_index;
1498   smm->session_tx_fns[session_type] =
1499     session_tx_fns[vft->transport_options.tx_type];
1500 }
1501
1502 transport_proto_t
1503 session_add_transport_proto (void)
1504 {
1505   session_main_t *smm = &session_main;
1506   session_worker_t *wrk;
1507   u32 thread;
1508
1509   smm->last_transport_proto_type += 1;
1510
1511   for (thread = 0; thread < vec_len (smm->wrk); thread++)
1512     {
1513       wrk = session_main_get_worker (thread);
1514       vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1515     }
1516
1517   return smm->last_transport_proto_type;
1518 }
1519
1520 transport_connection_t *
1521 session_get_transport (session_t * s)
1522 {
1523   if (s->session_state != SESSION_STATE_LISTENING)
1524     return transport_get_connection (session_get_transport_proto (s),
1525                                      s->connection_index, s->thread_index);
1526   else
1527     return transport_get_listener (session_get_transport_proto (s),
1528                                    s->connection_index);
1529 }
1530
1531 void
1532 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1533 {
1534   if (s->session_state != SESSION_STATE_LISTENING)
1535     return transport_get_endpoint (session_get_transport_proto (s),
1536                                    s->connection_index, s->thread_index, tep,
1537                                    is_lcl);
1538   else
1539     return transport_get_listener_endpoint (session_get_transport_proto (s),
1540                                             s->connection_index, tep, is_lcl);
1541 }
1542
1543 transport_connection_t *
1544 listen_session_get_transport (session_t * s)
1545 {
1546   return transport_get_listener (session_get_transport_proto (s),
1547                                  s->connection_index);
1548 }
1549
1550 void
1551 session_flush_frames_main_thread (vlib_main_t * vm)
1552 {
1553   ASSERT (vlib_get_thread_index () == 0);
1554   vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1555                                 SESSION_Q_PROCESS_FLUSH_FRAMES, 0);
1556 }
1557
1558 static clib_error_t *
1559 session_manager_main_enable (vlib_main_t * vm)
1560 {
1561   segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1562   session_main_t *smm = &session_main;
1563   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1564   u32 num_threads, preallocated_sessions_per_worker;
1565   session_worker_t *wrk;
1566   int i;
1567
1568   num_threads = 1 /* main thread */  + vtm->n_threads;
1569
1570   if (num_threads < 1)
1571     return clib_error_return (0, "n_thread_stacks not set");
1572
1573   smm->last_transport_proto_type = TRANSPORT_PROTO_QUIC;
1574   /* Allocate cache line aligned worker contexts */
1575   vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1576
1577   for (i = 0; i < num_threads; i++)
1578     {
1579       wrk = &smm->wrk[i];
1580       wrk->ctrl_head = clib_llist_make_head (wrk->event_elts, evt_list);
1581       wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1582       wrk->old_head = clib_llist_make_head (wrk->event_elts, evt_list);
1583       wrk->vm = vlib_mains[i];
1584       wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1585       wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
1586       vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1587
1588       if (num_threads > 1)
1589         clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1590     }
1591
1592   /* Allocate vpp event queues segment and queue */
1593   session_vpp_event_queues_allocate (smm);
1594
1595   /* Initialize fifo segment main baseva and timeout */
1596   sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1597   sm_args->size = smm->session_va_space_size;
1598   segment_manager_main_init (sm_args);
1599
1600   /* Preallocate sessions */
1601   if (smm->preallocated_sessions)
1602     {
1603       if (num_threads == 1)
1604         {
1605           pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1606         }
1607       else
1608         {
1609           int j;
1610           preallocated_sessions_per_worker =
1611             (1.1 * (f64) smm->preallocated_sessions /
1612              (f64) (num_threads - 1));
1613
1614           for (j = 1; j < num_threads; j++)
1615             {
1616               pool_init_fixed (smm->wrk[j].sessions,
1617                                preallocated_sessions_per_worker);
1618             }
1619         }
1620     }
1621
1622   session_lookup_init ();
1623   app_namespaces_init ();
1624   transport_init ();
1625
1626   smm->is_enabled = 1;
1627
1628   /* Enable transports */
1629   transport_enable_disable (vm, 1);
1630   return 0;
1631 }
1632
1633 void
1634 session_node_enable_disable (u8 is_en)
1635 {
1636   u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1637   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1638   u8 have_workers = vtm->n_threads != 0;
1639
1640   /* *INDENT-OFF* */
1641   foreach_vlib_main (({
1642     if (have_workers && ii == 0)
1643       {
1644         vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1645                              state);
1646         if (is_en)
1647           {
1648             vlib_node_t *n = vlib_get_node (this_vlib_main,
1649                                             session_queue_process_node.index);
1650             vlib_start_process (this_vlib_main, n->runtime_index);
1651           }
1652         else
1653           {
1654             vlib_process_signal_event_mt (this_vlib_main,
1655                                           session_queue_process_node.index,
1656                                           SESSION_Q_PROCESS_STOP, 0);
1657           }
1658
1659         continue;
1660       }
1661     vlib_node_set_state (this_vlib_main, session_queue_node.index,
1662                          state);
1663   }));
1664   /* *INDENT-ON* */
1665 }
1666
1667 clib_error_t *
1668 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1669 {
1670   clib_error_t *error = 0;
1671   if (is_en)
1672     {
1673       if (session_main.is_enabled)
1674         return 0;
1675
1676       error = session_manager_main_enable (vm);
1677       session_node_enable_disable (is_en);
1678     }
1679   else
1680     {
1681       session_main.is_enabled = 0;
1682       session_node_enable_disable (is_en);
1683     }
1684
1685   return error;
1686 }
1687
1688 clib_error_t *
1689 session_manager_main_init (vlib_main_t * vm)
1690 {
1691   session_main_t *smm = &session_main;
1692   smm->session_baseva = HIGH_SEGMENT_BASEVA;
1693 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1694   smm->session_va_space_size = 128ULL << 30;
1695   smm->evt_qs_segment_size = 64 << 20;
1696 #else
1697   smm->session_va_space_size = 128 << 20;
1698   smm->evt_qs_segment_size = 1 << 20;
1699 #endif
1700   smm->is_enabled = 0;
1701   smm->session_enable_asap = 0;
1702   return 0;
1703 }
1704
1705 static clib_error_t *
1706 session_main_init (vlib_main_t * vm)
1707 {
1708   session_main_t *smm = &session_main;
1709   if (smm->session_enable_asap)
1710     {
1711       vlib_worker_thread_barrier_sync (vm);
1712       vnet_session_enable_disable (vm, 1 /* is_en */ );
1713       vlib_worker_thread_barrier_release (vm);
1714     }
1715   return 0;
1716 }
1717
1718 VLIB_INIT_FUNCTION (session_manager_main_init);
1719 VLIB_MAIN_LOOP_ENTER_FUNCTION (session_main_init);
1720
1721 static clib_error_t *
1722 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1723 {
1724   session_main_t *smm = &session_main;
1725   u32 nitems;
1726   uword tmp;
1727
1728   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1729     {
1730       if (unformat (input, "event-queue-length %d", &nitems))
1731         {
1732           if (nitems >= 2048)
1733             smm->configured_event_queue_length = nitems;
1734           else
1735             clib_warning ("event queue length %d too small, ignored", nitems);
1736         }
1737       else if (unformat (input, "preallocated-sessions %d",
1738                          &smm->preallocated_sessions))
1739         ;
1740       else if (unformat (input, "v4-session-table-buckets %d",
1741                          &smm->configured_v4_session_table_buckets))
1742         ;
1743       else if (unformat (input, "v4-halfopen-table-buckets %d",
1744                          &smm->configured_v4_halfopen_table_buckets))
1745         ;
1746       else if (unformat (input, "v6-session-table-buckets %d",
1747                          &smm->configured_v6_session_table_buckets))
1748         ;
1749       else if (unformat (input, "v6-halfopen-table-buckets %d",
1750                          &smm->configured_v6_halfopen_table_buckets))
1751         ;
1752       else if (unformat (input, "v4-session-table-memory %U",
1753                          unformat_memory_size, &tmp))
1754         {
1755           if (tmp >= 0x100000000)
1756             return clib_error_return (0, "memory size %llx (%lld) too large",
1757                                       tmp, tmp);
1758           smm->configured_v4_session_table_memory = tmp;
1759         }
1760       else if (unformat (input, "v4-halfopen-table-memory %U",
1761                          unformat_memory_size, &tmp))
1762         {
1763           if (tmp >= 0x100000000)
1764             return clib_error_return (0, "memory size %llx (%lld) too large",
1765                                       tmp, tmp);
1766           smm->configured_v4_halfopen_table_memory = tmp;
1767         }
1768       else if (unformat (input, "v6-session-table-memory %U",
1769                          unformat_memory_size, &tmp))
1770         {
1771           if (tmp >= 0x100000000)
1772             return clib_error_return (0, "memory size %llx (%lld) too large",
1773                                       tmp, tmp);
1774           smm->configured_v6_session_table_memory = tmp;
1775         }
1776       else if (unformat (input, "v6-halfopen-table-memory %U",
1777                          unformat_memory_size, &tmp))
1778         {
1779           if (tmp >= 0x100000000)
1780             return clib_error_return (0, "memory size %llx (%lld) too large",
1781                                       tmp, tmp);
1782           smm->configured_v6_halfopen_table_memory = tmp;
1783         }
1784       else if (unformat (input, "local-endpoints-table-memory %U",
1785                          unformat_memory_size, &tmp))
1786         {
1787           if (tmp >= 0x100000000)
1788             return clib_error_return (0, "memory size %llx (%lld) too large",
1789                                       tmp, tmp);
1790           smm->local_endpoints_table_memory = tmp;
1791         }
1792       else if (unformat (input, "local-endpoints-table-buckets %d",
1793                          &smm->local_endpoints_table_buckets))
1794         ;
1795       else if (unformat (input, "evt_qs_memfd_seg"))
1796         smm->evt_qs_use_memfd_seg = 1;
1797       else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1798                          &smm->evt_qs_segment_size))
1799         ;
1800       else if (unformat (input, "enable"))
1801         smm->session_enable_asap = 1;
1802       else
1803         return clib_error_return (0, "unknown input `%U'",
1804                                   format_unformat_error, input);
1805     }
1806   return 0;
1807 }
1808
1809 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1810
1811 /*
1812  * fd.io coding-style-patch-verification: ON
1813  *
1814  * Local Variables:
1815  * eval: (c-set-style "gnu")
1816  * End:
1817  */