d2dc85efa4ec10dd1ea225e34c534117329e83c1
[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,
740                                       session_error_t err,
741                                       session_state_t opened_state)
742 {
743   u32 opaque = 0, new_ti, new_si;
744   app_worker_t *app_wrk;
745   session_t *s = 0;
746   u64 ho_handle;
747
748   /*
749    * Find connection handle and cleanup half-open table
750    */
751   ho_handle = session_lookup_half_open_handle (tc);
752   if (ho_handle == HALF_OPEN_LOOKUP_INVALID_VALUE)
753     {
754       SESSION_DBG ("half-open was removed!");
755       return -1;
756     }
757   session_lookup_del_half_open (tc);
758
759   /* Get the app's index from the handle we stored when opening connection
760    * and the opaque (api_context for external apps) from transport session
761    * index */
762   app_wrk = app_worker_get_if_valid (ho_handle >> 32);
763   if (!app_wrk)
764     return -1;
765
766   opaque = tc->s_index;
767
768   if (err)
769     return app_worker_connect_notify (app_wrk, s, err, opaque);
770
771   s = session_alloc_for_connection (tc);
772   s->session_state = SESSION_STATE_CONNECTING;
773   s->app_wrk_index = app_wrk->wrk_index;
774   new_si = s->session_index;
775   new_ti = s->thread_index;
776
777   if ((err = app_worker_init_connected (app_wrk, s)))
778     {
779       session_free (s);
780       app_worker_connect_notify (app_wrk, 0, err, opaque);
781       return -1;
782     }
783
784   s = session_get (new_si, new_ti);
785   s->session_state = opened_state;
786   session_lookup_add_connection (tc, session_handle (s));
787
788   if (app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, opaque))
789     {
790       s = session_get (new_si, new_ti);
791       session_free_w_fifos (s);
792       return -1;
793     }
794
795   return 0;
796 }
797
798 int
799 session_stream_connect_notify (transport_connection_t * tc,
800                                session_error_t err)
801 {
802   return session_stream_connect_notify_inline (tc, err, SESSION_STATE_READY);
803 }
804
805 int
806 session_ho_stream_connect_notify (transport_connection_t * tc,
807                                   session_error_t err)
808 {
809   return session_stream_connect_notify_inline (tc, err, SESSION_STATE_OPENED);
810 }
811
812 static void
813 session_switch_pool_reply (void *arg)
814 {
815   u32 session_index = pointer_to_uword (arg);
816   segment_manager_t *sm;
817   app_worker_t *app_wrk;
818   session_t *s;
819
820   s = session_get_if_valid (session_index, vlib_get_thread_index ());
821   if (!s)
822     return;
823
824   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
825   if (!app_wrk)
826     return;
827
828   /* Attach fifos to the right session and segment slice */
829   sm = app_worker_get_connect_segment_manager (app_wrk);
830   segment_manager_attach_fifo (sm, s->rx_fifo, s);
831   segment_manager_attach_fifo (sm, s->tx_fifo, s);
832
833   /* Notify app that it has data on the new session */
834   session_enqueue_notify (s);
835 }
836
837 typedef struct _session_switch_pool_args
838 {
839   u32 session_index;
840   u32 thread_index;
841   u32 new_thread_index;
842   u32 new_session_index;
843 } session_switch_pool_args_t;
844
845 /**
846  * Notify old thread of the session pool switch
847  */
848 static void
849 session_switch_pool (void *cb_args)
850 {
851   session_switch_pool_args_t *args = (session_switch_pool_args_t *) cb_args;
852   session_handle_t new_sh;
853   segment_manager_t *sm;
854   app_worker_t *app_wrk;
855   session_t *s;
856   void *rargs;
857
858   ASSERT (args->thread_index == vlib_get_thread_index ());
859   s = session_get (args->session_index, args->thread_index);
860
861   transport_cleanup (session_get_transport_proto (s), s->connection_index,
862                      s->thread_index);
863
864   new_sh = session_make_handle (args->new_session_index,
865                                 args->new_thread_index);
866
867   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
868   if (app_wrk)
869     {
870       /* Cleanup fifo segment slice state for fifos */
871       sm = app_worker_get_connect_segment_manager (app_wrk);
872       segment_manager_detach_fifo (sm, s->rx_fifo);
873       segment_manager_detach_fifo (sm, s->tx_fifo);
874
875       /* Notify app, using old session, about the migration event */
876       app_worker_migrate_notify (app_wrk, s, new_sh);
877     }
878
879   /* Trigger app read and fifo updates on the new thread */
880   rargs = uword_to_pointer (args->new_session_index, void *);
881   session_send_rpc_evt_to_thread (args->new_thread_index,
882                                   session_switch_pool_reply, rargs);
883
884   session_free (s);
885   clib_mem_free (cb_args);
886 }
887
888 /**
889  * Move dgram session to the right thread
890  */
891 int
892 session_dgram_connect_notify (transport_connection_t * tc,
893                               u32 old_thread_index, session_t ** new_session)
894 {
895   session_t *new_s;
896   session_switch_pool_args_t *rpc_args;
897
898   /*
899    * Clone half-open session to the right thread.
900    */
901   new_s = session_clone_safe (tc->s_index, old_thread_index);
902   new_s->connection_index = tc->c_index;
903   new_s->session_state = SESSION_STATE_READY;
904   new_s->flags |= SESSION_F_IS_MIGRATING;
905
906   session_lookup_add_connection (tc, session_handle (new_s));
907
908   /*
909    * Ask thread owning the old session to clean it up and make us the tx
910    * fifo owner
911    */
912   rpc_args = clib_mem_alloc (sizeof (*rpc_args));
913   rpc_args->new_session_index = new_s->session_index;
914   rpc_args->new_thread_index = new_s->thread_index;
915   rpc_args->session_index = tc->s_index;
916   rpc_args->thread_index = old_thread_index;
917   session_send_rpc_evt_to_thread (rpc_args->thread_index, session_switch_pool,
918                                   rpc_args);
919
920   tc->s_index = new_s->session_index;
921   new_s->connection_index = tc->c_index;
922   *new_session = new_s;
923   return 0;
924 }
925
926 /**
927  * Notification from transport that connection is being closed.
928  *
929  * A disconnect is sent to application but state is not removed. Once
930  * disconnect is acknowledged by application, session disconnect is called.
931  * Ultimately this leads to close being called on transport (passive close).
932  */
933 void
934 session_transport_closing_notify (transport_connection_t * tc)
935 {
936   app_worker_t *app_wrk;
937   session_t *s;
938
939   s = session_get (tc->s_index, tc->thread_index);
940   if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
941     return;
942   s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
943   app_wrk = app_worker_get (s->app_wrk_index);
944   app_worker_close_notify (app_wrk, s);
945 }
946
947 /**
948  * Notification from transport that connection is being deleted
949  *
950  * This removes the session if it is still valid. It should be called only on
951  * previously fully established sessions. For instance failed connects should
952  * call stream_session_connect_notify and indicate that the connect has
953  * failed.
954  */
955 void
956 session_transport_delete_notify (transport_connection_t * tc)
957 {
958   session_t *s;
959
960   /* App might've been removed already */
961   if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
962     return;
963
964   switch (s->session_state)
965     {
966     case SESSION_STATE_CREATED:
967       /* Session was created but accept notification was not yet sent to the
968        * app. Cleanup everything. */
969       session_lookup_del_session (s);
970       segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
971       session_free (s);
972       break;
973     case SESSION_STATE_ACCEPTING:
974     case SESSION_STATE_TRANSPORT_CLOSING:
975     case SESSION_STATE_CLOSING:
976     case SESSION_STATE_TRANSPORT_CLOSED:
977       /* If transport finishes or times out before we get a reply
978        * from the app, mark transport as closed and wait for reply
979        * before removing the session. Cleanup session table in advance
980        * because transport will soon be closed and closed sessions
981        * are assumed to have been removed from the lookup table */
982       session_lookup_del_session (s);
983       s->session_state = SESSION_STATE_TRANSPORT_DELETED;
984       session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
985       svm_fifo_dequeue_drop_all (s->tx_fifo);
986       break;
987     case SESSION_STATE_APP_CLOSED:
988       /* Cleanup lookup table as transport needs to still be valid.
989        * Program transport close to ensure that all session events
990        * have been cleaned up. Once transport close is called, the
991        * session is just removed because both transport and app have
992        * confirmed the close*/
993       session_lookup_del_session (s);
994       s->session_state = SESSION_STATE_TRANSPORT_DELETED;
995       session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
996       svm_fifo_dequeue_drop_all (s->tx_fifo);
997       session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
998       break;
999     case SESSION_STATE_TRANSPORT_DELETED:
1000       break;
1001     case SESSION_STATE_CLOSED:
1002       session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1003       session_delete (s);
1004       break;
1005     default:
1006       clib_warning ("session state %u", s->session_state);
1007       session_cleanup_notify (s, SESSION_CLEANUP_TRANSPORT);
1008       session_delete (s);
1009       break;
1010     }
1011 }
1012
1013 /**
1014  * Notification from transport that it is closed
1015  *
1016  * Should be called by transport, prior to calling delete notify, once it
1017  * knows that no more data will be exchanged. This could serve as an
1018  * early acknowledgment of an active close especially if transport delete
1019  * can be delayed a long time, e.g., tcp time-wait.
1020  */
1021 void
1022 session_transport_closed_notify (transport_connection_t * tc)
1023 {
1024   app_worker_t *app_wrk;
1025   session_t *s;
1026
1027   if (!(s = session_get_if_valid (tc->s_index, tc->thread_index)))
1028     return;
1029
1030   /* Transport thinks that app requested close but it actually didn't.
1031    * Can happen for tcp if fin and rst are received in close succession. */
1032   if (s->session_state == SESSION_STATE_READY)
1033     {
1034       session_transport_closing_notify (tc);
1035       svm_fifo_dequeue_drop_all (s->tx_fifo);
1036       s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
1037     }
1038   /* If app close has not been received or has not yet resulted in
1039    * a transport close, only mark the session transport as closed */
1040   else if (s->session_state <= SESSION_STATE_CLOSING)
1041     {
1042       s->session_state = SESSION_STATE_TRANSPORT_CLOSED;
1043     }
1044   /* If app also closed, switch to closed */
1045   else if (s->session_state == SESSION_STATE_APP_CLOSED)
1046     s->session_state = SESSION_STATE_CLOSED;
1047
1048   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1049   if (app_wrk)
1050     app_worker_transport_closed_notify (app_wrk, s);
1051 }
1052
1053 /**
1054  * Notify application that connection has been reset.
1055  */
1056 void
1057 session_transport_reset_notify (transport_connection_t * tc)
1058 {
1059   app_worker_t *app_wrk;
1060   session_t *s;
1061
1062   s = session_get (tc->s_index, tc->thread_index);
1063   svm_fifo_dequeue_drop_all (s->tx_fifo);
1064   if (s->session_state >= SESSION_STATE_TRANSPORT_CLOSING)
1065     return;
1066   s->session_state = SESSION_STATE_TRANSPORT_CLOSING;
1067   app_wrk = app_worker_get (s->app_wrk_index);
1068   app_worker_reset_notify (app_wrk, s);
1069 }
1070
1071 int
1072 session_stream_accept_notify (transport_connection_t * tc)
1073 {
1074   app_worker_t *app_wrk;
1075   session_t *s;
1076
1077   s = session_get (tc->s_index, tc->thread_index);
1078   app_wrk = app_worker_get_if_valid (s->app_wrk_index);
1079   if (!app_wrk)
1080     return -1;
1081   s->session_state = SESSION_STATE_ACCEPTING;
1082   if (app_worker_accept_notify (app_wrk, s))
1083     {
1084       /* On transport delete, no notifications should be sent. Unless, the
1085        * accept is retried and successful. */
1086       s->session_state = SESSION_STATE_CREATED;
1087       return -1;
1088     }
1089   return 0;
1090 }
1091
1092 /**
1093  * Accept a stream session. Optionally ping the server by callback.
1094  */
1095 int
1096 session_stream_accept (transport_connection_t * tc, u32 listener_index,
1097                        u32 thread_index, u8 notify)
1098 {
1099   session_t *s;
1100   int rv;
1101
1102   s = session_alloc_for_connection (tc);
1103   s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1104   s->session_state = SESSION_STATE_CREATED;
1105
1106   if ((rv = app_worker_init_accepted (s)))
1107     {
1108       session_free (s);
1109       return rv;
1110     }
1111
1112   session_lookup_add_connection (tc, session_handle (s));
1113
1114   /* Shoulder-tap the server */
1115   if (notify)
1116     {
1117       app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1118       if ((rv = app_worker_accept_notify (app_wrk, s)))
1119         {
1120           session_lookup_del_session (s);
1121           segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1122           session_free (s);
1123           return rv;
1124         }
1125     }
1126
1127   return 0;
1128 }
1129
1130 int
1131 session_dgram_accept (transport_connection_t * tc, u32 listener_index,
1132                       u32 thread_index)
1133 {
1134   app_worker_t *app_wrk;
1135   session_t *s;
1136   int rv;
1137
1138   s = session_alloc_for_connection (tc);
1139   s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1140
1141   if ((rv = app_worker_init_accepted (s)))
1142     {
1143       session_free (s);
1144       return rv;
1145     }
1146
1147   app_wrk = app_worker_get (s->app_wrk_index);
1148   if ((rv = app_worker_accept_notify (app_wrk, s)))
1149     {
1150       segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1151       session_free (s);
1152       return rv;
1153     }
1154
1155   s->session_state = SESSION_STATE_READY;
1156   session_lookup_add_connection (tc, session_handle (s));
1157
1158   return 0;
1159 }
1160
1161 int
1162 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1163 {
1164   transport_connection_t *tc;
1165   transport_endpoint_cfg_t *tep;
1166   app_worker_t *app_wrk;
1167   session_handle_t sh;
1168   session_t *s;
1169   int rv;
1170
1171   tep = session_endpoint_to_transport_cfg (rmt);
1172   rv = transport_connect (rmt->transport_proto, tep);
1173   if (rv < 0)
1174     {
1175       SESSION_DBG ("Transport failed to open connection.");
1176       return rv;
1177     }
1178
1179   tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1180
1181   /* For dgram type of service, allocate session and fifos now */
1182   app_wrk = app_worker_get (app_wrk_index);
1183   s = session_alloc_for_connection (tc);
1184   s->app_wrk_index = app_wrk->wrk_index;
1185   s->session_state = SESSION_STATE_OPENED;
1186   if (app_worker_init_connected (app_wrk, s))
1187     {
1188       session_free (s);
1189       return -1;
1190     }
1191
1192   sh = session_handle (s);
1193   session_lookup_add_connection (tc, sh);
1194   return app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, opaque);
1195 }
1196
1197 int
1198 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1199 {
1200   transport_connection_t *tc;
1201   transport_endpoint_cfg_t *tep;
1202   u64 handle;
1203   int rv;
1204
1205   tep = session_endpoint_to_transport_cfg (rmt);
1206   rv = transport_connect (rmt->transport_proto, tep);
1207   if (rv < 0)
1208     {
1209       SESSION_DBG ("Transport failed to open connection.");
1210       return rv;
1211     }
1212
1213   tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1214
1215   /* If transport offers a stream service, only allocate session once the
1216    * connection has been established.
1217    * Add connection to half-open table and save app and tc index. The
1218    * latter is needed to help establish the connection while the former
1219    * is needed when the connect notify comes and we have to notify the
1220    * external app
1221    */
1222   handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1223   session_lookup_add_half_open (tc, handle);
1224
1225   /* Store api_context (opaque) for when the reply comes. Not the nicest
1226    * thing but better than allocating a separate half-open pool.
1227    */
1228   tc->s_index = opaque;
1229   if (transport_half_open_has_fifos (rmt->transport_proto))
1230     return session_ho_stream_connect_notify (tc, 0 /* is_fail */ );
1231   return 0;
1232 }
1233
1234 int
1235 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1236 {
1237   session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1238   transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1239
1240   sep->app_wrk_index = app_wrk_index;
1241   sep->opaque = opaque;
1242
1243   return transport_connect (rmt->transport_proto, tep_cfg);
1244 }
1245
1246 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1247
1248 /* *INDENT-OFF* */
1249 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1250   session_open_vc,
1251   session_open_cl,
1252   session_open_app,
1253 };
1254 /* *INDENT-ON* */
1255
1256 /**
1257  * Ask transport to open connection to remote transport endpoint.
1258  *
1259  * Stores handle for matching request with reply since the call can be
1260  * asynchronous. For instance, for TCP the 3-way handshake must complete
1261  * before reply comes. Session is only created once connection is established.
1262  *
1263  * @param app_index Index of the application requesting the connect
1264  * @param st Session type requested.
1265  * @param tep Remote transport endpoint
1266  * @param opaque Opaque data (typically, api_context) the application expects
1267  *               on open completion.
1268  */
1269 int
1270 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1271 {
1272   transport_service_type_t tst;
1273   tst = transport_protocol_service_type (rmt->transport_proto);
1274   return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1275 }
1276
1277 /**
1278  * Ask transport to listen on session endpoint.
1279  *
1280  * @param s Session for which listen will be called. Note that unlike
1281  *          established sessions, listen sessions are not associated to a
1282  *          thread.
1283  * @param sep Local endpoint to be listened on.
1284  */
1285 int
1286 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1287 {
1288   transport_endpoint_t *tep;
1289   int tc_index;
1290   u32 s_index;
1291
1292   /* Transport bind/listen */
1293   tep = session_endpoint_to_transport (sep);
1294   s_index = ls->session_index;
1295   tc_index = transport_start_listen (session_get_transport_proto (ls),
1296                                      s_index, tep);
1297
1298   if (tc_index < 0)
1299     return tc_index;
1300
1301   /* Attach transport to session. Lookup tables are populated by the app
1302    * worker because local tables (for ct sessions) are not backed by a fib */
1303   ls = listen_session_get (s_index);
1304   ls->connection_index = tc_index;
1305
1306   return 0;
1307 }
1308
1309 /**
1310  * Ask transport to stop listening on local transport endpoint.
1311  *
1312  * @param s Session to stop listening on. It must be in state LISTENING.
1313  */
1314 int
1315 session_stop_listen (session_t * s)
1316 {
1317   transport_proto_t tp = session_get_transport_proto (s);
1318   transport_connection_t *tc;
1319
1320   if (s->session_state != SESSION_STATE_LISTENING)
1321     return SESSION_E_NOLISTEN;
1322
1323   tc = transport_get_listener (tp, s->connection_index);
1324
1325   /* If no transport, assume everything was cleaned up already */
1326   if (!tc)
1327     return SESSION_E_NONE;
1328
1329   if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1330     session_lookup_del_connection (tc);
1331
1332   transport_stop_listen (tp, s->connection_index);
1333   return 0;
1334 }
1335
1336 /**
1337  * Initialize session closing procedure.
1338  *
1339  * Request is always sent to session node to ensure that all outstanding
1340  * requests are served before transport is notified.
1341  */
1342 void
1343 session_close (session_t * s)
1344 {
1345   if (!s)
1346     return;
1347
1348   if (s->session_state >= SESSION_STATE_CLOSING)
1349     {
1350       /* Session will only be removed once both app and transport
1351        * acknowledge the close */
1352       if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1353           || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1354         session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1355       return;
1356     }
1357
1358   s->session_state = SESSION_STATE_CLOSING;
1359   session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1360 }
1361
1362 /**
1363  * Force a close without waiting for data to be flushed
1364  */
1365 void
1366 session_reset (session_t * s)
1367 {
1368   if (s->session_state >= SESSION_STATE_CLOSING)
1369     return;
1370   /* Drop all outstanding tx data */
1371   svm_fifo_dequeue_drop_all (s->tx_fifo);
1372   s->session_state = SESSION_STATE_CLOSING;
1373   session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_RESET);
1374 }
1375
1376 /**
1377  * Notify transport the session can be disconnected. This should eventually
1378  * result in a delete notification that allows us to cleanup session state.
1379  * Called for both active/passive disconnects.
1380  *
1381  * Must be called from the session's thread.
1382  */
1383 void
1384 session_transport_close (session_t * s)
1385 {
1386   if (s->session_state >= SESSION_STATE_APP_CLOSED)
1387     {
1388       if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1389         s->session_state = SESSION_STATE_CLOSED;
1390       /* If transport is already deleted, just free the session */
1391       else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1392         session_free_w_fifos (s);
1393       return;
1394     }
1395
1396   /* If the tx queue wasn't drained, the transport can continue to try
1397    * sending the outstanding data (in closed state it cannot). It MUST however
1398    * at one point, either after sending everything or after a timeout, call
1399    * delete notify. This will finally lead to the complete cleanup of the
1400    * session.
1401    */
1402   s->session_state = SESSION_STATE_APP_CLOSED;
1403
1404   transport_close (session_get_transport_proto (s), s->connection_index,
1405                    s->thread_index);
1406 }
1407
1408 /**
1409  * Force transport close
1410  */
1411 void
1412 session_transport_reset (session_t * s)
1413 {
1414   if (s->session_state >= SESSION_STATE_APP_CLOSED)
1415     {
1416       if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1417         s->session_state = SESSION_STATE_CLOSED;
1418       else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1419         session_free_w_fifos (s);
1420       return;
1421     }
1422
1423   s->session_state = SESSION_STATE_APP_CLOSED;
1424   transport_reset (session_get_transport_proto (s), s->connection_index,
1425                    s->thread_index);
1426 }
1427
1428 /**
1429  * Cleanup transport and session state.
1430  *
1431  * Notify transport of the cleanup and free the session. This should
1432  * be called only if transport reported some error and is already
1433  * closed.
1434  */
1435 void
1436 session_transport_cleanup (session_t * s)
1437 {
1438   /* Delete from main lookup table before we axe the the transport */
1439   session_lookup_del_session (s);
1440   if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1441     transport_cleanup (session_get_transport_proto (s), s->connection_index,
1442                        s->thread_index);
1443   /* Since we called cleanup, no delete notification will come. So, make
1444    * sure the session is properly freed. */
1445   segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1446   session_free (s);
1447 }
1448
1449 /**
1450  * Allocate event queues in the shared-memory segment
1451  *
1452  * That can either be a newly created memfd segment, that will need to be
1453  * mapped by all stack users, or the binary api's svm region. The latter is
1454  * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1455  * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1456  * vpp uses api svm region for event queues.
1457  */
1458 void
1459 session_vpp_event_queues_allocate (session_main_t * smm)
1460 {
1461   u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1462   ssvm_private_t *eqs = &smm->evt_qs_segment;
1463   uword eqs_size = 64 << 20;
1464   pid_t vpp_pid = getpid ();
1465   void *oldheap;
1466   int i;
1467
1468   if (smm->configured_event_queue_length)
1469     evt_q_length = smm->configured_event_queue_length;
1470
1471   if (smm->evt_qs_use_memfd_seg)
1472     {
1473       if (smm->evt_qs_segment_size)
1474         eqs_size = smm->evt_qs_segment_size;
1475
1476       eqs->ssvm_size = eqs_size;
1477       eqs->i_am_master = 1;
1478       eqs->my_pid = vpp_pid;
1479       eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1480       eqs->requested_va = smm->session_baseva;
1481
1482       if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1483         {
1484           clib_warning ("failed to initialize queue segment");
1485           return;
1486         }
1487     }
1488
1489   if (smm->evt_qs_use_memfd_seg)
1490     oldheap = ssvm_push_heap (eqs->sh);
1491   else
1492     oldheap = vl_msg_push_heap ();
1493
1494   for (i = 0; i < vec_len (smm->wrk); i++)
1495     {
1496       svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1497       svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1498         {evt_q_length, evt_size, 0}
1499         ,
1500         {evt_q_length >> 1, 256, 0}
1501       };
1502       cfg->consumer_pid = 0;
1503       cfg->n_rings = 2;
1504       cfg->q_nitems = evt_q_length;
1505       cfg->ring_cfgs = rc;
1506       smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1507       if (smm->evt_qs_use_memfd_seg)
1508         {
1509           if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1510             clib_warning ("eventfd returned");
1511         }
1512     }
1513
1514   if (smm->evt_qs_use_memfd_seg)
1515     ssvm_pop_heap (oldheap);
1516   else
1517     vl_msg_pop_heap (oldheap);
1518 }
1519
1520 ssvm_private_t *
1521 session_main_get_evt_q_segment (void)
1522 {
1523   session_main_t *smm = &session_main;
1524   if (smm->evt_qs_use_memfd_seg)
1525     return &smm->evt_qs_segment;
1526   return 0;
1527 }
1528
1529 u64
1530 session_segment_handle (session_t * s)
1531 {
1532   svm_fifo_t *f;
1533
1534   if (!s->rx_fifo)
1535     return SESSION_INVALID_HANDLE;
1536
1537   f = s->rx_fifo;
1538   return segment_manager_make_segment_handle (f->segment_manager,
1539                                               f->segment_index);
1540 }
1541
1542 /* *INDENT-OFF* */
1543 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1544     session_tx_fifo_peek_and_snd,
1545     session_tx_fifo_dequeue_and_snd,
1546     session_tx_fifo_dequeue_internal,
1547     session_tx_fifo_dequeue_and_snd
1548 };
1549 /* *INDENT-ON* */
1550
1551 void
1552 session_register_transport (transport_proto_t transport_proto,
1553                             const transport_proto_vft_t * vft, u8 is_ip4,
1554                             u32 output_node)
1555 {
1556   session_main_t *smm = &session_main;
1557   session_type_t session_type;
1558   u32 next_index = ~0;
1559
1560   session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1561
1562   vec_validate (smm->session_type_to_next, session_type);
1563   vec_validate (smm->session_tx_fns, session_type);
1564
1565   /* *INDENT-OFF* */
1566   if (output_node != ~0)
1567     {
1568       foreach_vlib_main (({
1569           next_index = vlib_node_add_next (this_vlib_main,
1570                                            session_queue_node.index,
1571                                            output_node);
1572       }));
1573     }
1574   /* *INDENT-ON* */
1575
1576   smm->session_type_to_next[session_type] = next_index;
1577   smm->session_tx_fns[session_type] =
1578     session_tx_fns[vft->transport_options.tx_type];
1579 }
1580
1581 transport_proto_t
1582 session_add_transport_proto (void)
1583 {
1584   session_main_t *smm = &session_main;
1585   session_worker_t *wrk;
1586   u32 thread;
1587
1588   smm->last_transport_proto_type += 1;
1589
1590   for (thread = 0; thread < vec_len (smm->wrk); thread++)
1591     {
1592       wrk = session_main_get_worker (thread);
1593       vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1594     }
1595
1596   return smm->last_transport_proto_type;
1597 }
1598
1599 transport_connection_t *
1600 session_get_transport (session_t * s)
1601 {
1602   if (s->session_state != SESSION_STATE_LISTENING)
1603     return transport_get_connection (session_get_transport_proto (s),
1604                                      s->connection_index, s->thread_index);
1605   else
1606     return transport_get_listener (session_get_transport_proto (s),
1607                                    s->connection_index);
1608 }
1609
1610 void
1611 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1612 {
1613   if (s->session_state != SESSION_STATE_LISTENING)
1614     return transport_get_endpoint (session_get_transport_proto (s),
1615                                    s->connection_index, s->thread_index, tep,
1616                                    is_lcl);
1617   else
1618     return transport_get_listener_endpoint (session_get_transport_proto (s),
1619                                             s->connection_index, tep, is_lcl);
1620 }
1621
1622 transport_connection_t *
1623 listen_session_get_transport (session_t * s)
1624 {
1625   return transport_get_listener (session_get_transport_proto (s),
1626                                  s->connection_index);
1627 }
1628
1629 void
1630 session_queue_run_on_main_thread (vlib_main_t * vm)
1631 {
1632   ASSERT (vlib_get_thread_index () == 0);
1633   vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1634                                 SESSION_Q_PROCESS_RUN_ON_MAIN, 0);
1635 }
1636
1637 static clib_error_t *
1638 session_manager_main_enable (vlib_main_t * vm)
1639 {
1640   segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1641   session_main_t *smm = &session_main;
1642   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1643   u32 num_threads, preallocated_sessions_per_worker;
1644   session_worker_t *wrk;
1645   int i;
1646
1647   num_threads = 1 /* main thread */  + vtm->n_threads;
1648
1649   if (num_threads < 1)
1650     return clib_error_return (0, "n_thread_stacks not set");
1651
1652   /* Allocate cache line aligned worker contexts */
1653   vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1654
1655   for (i = 0; i < num_threads; i++)
1656     {
1657       wrk = &smm->wrk[i];
1658       wrk->ctrl_head = clib_llist_make_head (wrk->event_elts, evt_list);
1659       wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1660       wrk->old_head = clib_llist_make_head (wrk->event_elts, evt_list);
1661       wrk->vm = vlib_mains[i];
1662       wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1663       wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
1664       vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1665
1666       if (num_threads > 1)
1667         clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1668     }
1669
1670   /* Allocate vpp event queues segment and queue */
1671   session_vpp_event_queues_allocate (smm);
1672
1673   /* Initialize fifo segment main baseva and timeout */
1674   sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1675   sm_args->size = smm->session_va_space_size;
1676   segment_manager_main_init (sm_args);
1677
1678   /* Preallocate sessions */
1679   if (smm->preallocated_sessions)
1680     {
1681       if (num_threads == 1)
1682         {
1683           pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1684         }
1685       else
1686         {
1687           int j;
1688           preallocated_sessions_per_worker =
1689             (1.1 * (f64) smm->preallocated_sessions /
1690              (f64) (num_threads - 1));
1691
1692           for (j = 1; j < num_threads; j++)
1693             {
1694               pool_init_fixed (smm->wrk[j].sessions,
1695                                preallocated_sessions_per_worker);
1696             }
1697         }
1698     }
1699
1700   session_lookup_init ();
1701   app_namespaces_init ();
1702   transport_init ();
1703
1704   smm->is_enabled = 1;
1705
1706   /* Enable transports */
1707   transport_enable_disable (vm, 1);
1708   return 0;
1709 }
1710
1711 void
1712 session_node_enable_disable (u8 is_en)
1713 {
1714   u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1715   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1716   u8 have_workers = vtm->n_threads != 0;
1717
1718   /* *INDENT-OFF* */
1719   foreach_vlib_main (({
1720     if (have_workers && ii == 0)
1721       {
1722         vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1723                              state);
1724         if (is_en)
1725           {
1726             vlib_node_t *n = vlib_get_node (this_vlib_main,
1727                                             session_queue_process_node.index);
1728             vlib_start_process (this_vlib_main, n->runtime_index);
1729           }
1730         else
1731           {
1732             vlib_process_signal_event_mt (this_vlib_main,
1733                                           session_queue_process_node.index,
1734                                           SESSION_Q_PROCESS_STOP, 0);
1735           }
1736
1737         continue;
1738       }
1739     vlib_node_set_state (this_vlib_main, session_queue_node.index,
1740                          state);
1741   }));
1742   /* *INDENT-ON* */
1743 }
1744
1745 clib_error_t *
1746 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1747 {
1748   clib_error_t *error = 0;
1749   if (is_en)
1750     {
1751       if (session_main.is_enabled)
1752         return 0;
1753
1754       error = session_manager_main_enable (vm);
1755       session_node_enable_disable (is_en);
1756     }
1757   else
1758     {
1759       session_main.is_enabled = 0;
1760       session_node_enable_disable (is_en);
1761     }
1762
1763   return error;
1764 }
1765
1766 clib_error_t *
1767 session_main_init (vlib_main_t * vm)
1768 {
1769   session_main_t *smm = &session_main;
1770
1771   smm->is_enabled = 0;
1772   smm->session_enable_asap = 0;
1773   smm->session_baseva = HIGH_SEGMENT_BASEVA;
1774
1775 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1776   smm->session_va_space_size = 128ULL << 30;
1777   smm->evt_qs_segment_size = 64 << 20;
1778 #else
1779   smm->session_va_space_size = 128 << 20;
1780   smm->evt_qs_segment_size = 1 << 20;
1781 #endif
1782
1783   smm->last_transport_proto_type = TRANSPORT_PROTO_QUIC;
1784
1785   return 0;
1786 }
1787
1788 static clib_error_t *
1789 session_main_loop_init (vlib_main_t * vm)
1790 {
1791   session_main_t *smm = &session_main;
1792   if (smm->session_enable_asap)
1793     {
1794       vlib_worker_thread_barrier_sync (vm);
1795       vnet_session_enable_disable (vm, 1 /* is_en */ );
1796       vlib_worker_thread_barrier_release (vm);
1797     }
1798   return 0;
1799 }
1800
1801 VLIB_INIT_FUNCTION (session_main_init);
1802 VLIB_MAIN_LOOP_ENTER_FUNCTION (session_main_loop_init);
1803
1804 static clib_error_t *
1805 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1806 {
1807   session_main_t *smm = &session_main;
1808   u32 nitems;
1809   uword tmp;
1810
1811   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1812     {
1813       if (unformat (input, "event-queue-length %d", &nitems))
1814         {
1815           if (nitems >= 2048)
1816             smm->configured_event_queue_length = nitems;
1817           else
1818             clib_warning ("event queue length %d too small, ignored", nitems);
1819         }
1820       else if (unformat (input, "preallocated-sessions %d",
1821                          &smm->preallocated_sessions))
1822         ;
1823       else if (unformat (input, "v4-session-table-buckets %d",
1824                          &smm->configured_v4_session_table_buckets))
1825         ;
1826       else if (unformat (input, "v4-halfopen-table-buckets %d",
1827                          &smm->configured_v4_halfopen_table_buckets))
1828         ;
1829       else if (unformat (input, "v6-session-table-buckets %d",
1830                          &smm->configured_v6_session_table_buckets))
1831         ;
1832       else if (unformat (input, "v6-halfopen-table-buckets %d",
1833                          &smm->configured_v6_halfopen_table_buckets))
1834         ;
1835       else if (unformat (input, "v4-session-table-memory %U",
1836                          unformat_memory_size, &tmp))
1837         {
1838           if (tmp >= 0x100000000)
1839             return clib_error_return (0, "memory size %llx (%lld) too large",
1840                                       tmp, tmp);
1841           smm->configured_v4_session_table_memory = tmp;
1842         }
1843       else if (unformat (input, "v4-halfopen-table-memory %U",
1844                          unformat_memory_size, &tmp))
1845         {
1846           if (tmp >= 0x100000000)
1847             return clib_error_return (0, "memory size %llx (%lld) too large",
1848                                       tmp, tmp);
1849           smm->configured_v4_halfopen_table_memory = tmp;
1850         }
1851       else if (unformat (input, "v6-session-table-memory %U",
1852                          unformat_memory_size, &tmp))
1853         {
1854           if (tmp >= 0x100000000)
1855             return clib_error_return (0, "memory size %llx (%lld) too large",
1856                                       tmp, tmp);
1857           smm->configured_v6_session_table_memory = tmp;
1858         }
1859       else if (unformat (input, "v6-halfopen-table-memory %U",
1860                          unformat_memory_size, &tmp))
1861         {
1862           if (tmp >= 0x100000000)
1863             return clib_error_return (0, "memory size %llx (%lld) too large",
1864                                       tmp, tmp);
1865           smm->configured_v6_halfopen_table_memory = tmp;
1866         }
1867       else if (unformat (input, "local-endpoints-table-memory %U",
1868                          unformat_memory_size, &tmp))
1869         {
1870           if (tmp >= 0x100000000)
1871             return clib_error_return (0, "memory size %llx (%lld) too large",
1872                                       tmp, tmp);
1873           smm->local_endpoints_table_memory = tmp;
1874         }
1875       else if (unformat (input, "local-endpoints-table-buckets %d",
1876                          &smm->local_endpoints_table_buckets))
1877         ;
1878       else if (unformat (input, "evt_qs_memfd_seg"))
1879         smm->evt_qs_use_memfd_seg = 1;
1880       else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1881                          &smm->evt_qs_segment_size))
1882         ;
1883       else if (unformat (input, "enable"))
1884         smm->session_enable_asap = 1;
1885       else
1886         return clib_error_return (0, "unknown input `%U'",
1887                                   format_unformat_error, input);
1888     }
1889   return 0;
1890 }
1891
1892 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1893
1894 /*
1895  * fd.io coding-style-patch-verification: ON
1896  *
1897  * Local Variables:
1898  * eval: (c-set-style "gnu")
1899  * End:
1900  */