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