session: update fifo slice on session migration
[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     return rv;
1108
1109   session_lookup_add_connection (tc, session_handle (s));
1110
1111   /* Shoulder-tap the server */
1112   if (notify)
1113     {
1114       app_worker_t *app_wrk = app_worker_get (s->app_wrk_index);
1115       return app_worker_accept_notify (app_wrk, s);
1116     }
1117
1118   return 0;
1119 }
1120
1121 int
1122 session_dgram_accept (transport_connection_t * tc, u32 listener_index,
1123                       u32 thread_index)
1124 {
1125   app_worker_t *app_wrk;
1126   session_t *s;
1127   int rv;
1128
1129   s = session_alloc_for_connection (tc);
1130   s->listener_handle = ((u64) thread_index << 32) | (u64) listener_index;
1131
1132   if ((rv = app_worker_init_accepted (s)))
1133     {
1134       session_free (s);
1135       return rv;
1136     }
1137
1138   app_wrk = app_worker_get (s->app_wrk_index);
1139   if ((rv = app_worker_accept_notify (app_wrk, s)))
1140     {
1141       session_free_w_fifos (s);
1142       return rv;
1143     }
1144
1145   s->session_state = SESSION_STATE_READY;
1146   session_lookup_add_connection (tc, session_handle (s));
1147
1148   return 0;
1149 }
1150
1151 int
1152 session_open_cl (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1153 {
1154   transport_connection_t *tc;
1155   transport_endpoint_cfg_t *tep;
1156   app_worker_t *app_wrk;
1157   session_handle_t sh;
1158   session_t *s;
1159   int rv;
1160
1161   tep = session_endpoint_to_transport_cfg (rmt);
1162   rv = transport_connect (rmt->transport_proto, tep);
1163   if (rv < 0)
1164     {
1165       SESSION_DBG ("Transport failed to open connection.");
1166       return rv;
1167     }
1168
1169   tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1170
1171   /* For dgram type of service, allocate session and fifos now */
1172   app_wrk = app_worker_get (app_wrk_index);
1173   s = session_alloc_for_connection (tc);
1174   s->app_wrk_index = app_wrk->wrk_index;
1175   s->session_state = SESSION_STATE_OPENED;
1176   if (app_worker_init_connected (app_wrk, s))
1177     {
1178       session_free (s);
1179       return -1;
1180     }
1181
1182   sh = session_handle (s);
1183   session_lookup_add_connection (tc, sh);
1184   return app_worker_connect_notify (app_wrk, s, SESSION_E_NONE, opaque);
1185 }
1186
1187 int
1188 session_open_vc (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1189 {
1190   transport_connection_t *tc;
1191   transport_endpoint_cfg_t *tep;
1192   u64 handle;
1193   int rv;
1194
1195   tep = session_endpoint_to_transport_cfg (rmt);
1196   rv = transport_connect (rmt->transport_proto, tep);
1197   if (rv < 0)
1198     {
1199       SESSION_DBG ("Transport failed to open connection.");
1200       return rv;
1201     }
1202
1203   tc = transport_get_half_open (rmt->transport_proto, (u32) rv);
1204
1205   /* If transport offers a stream service, only allocate session once the
1206    * connection has been established.
1207    * Add connection to half-open table and save app and tc index. The
1208    * latter is needed to help establish the connection while the former
1209    * is needed when the connect notify comes and we have to notify the
1210    * external app
1211    */
1212   handle = (((u64) app_wrk_index) << 32) | (u64) tc->c_index;
1213   session_lookup_add_half_open (tc, handle);
1214
1215   /* Store api_context (opaque) for when the reply comes. Not the nicest
1216    * thing but better than allocating a separate half-open pool.
1217    */
1218   tc->s_index = opaque;
1219   if (transport_half_open_has_fifos (rmt->transport_proto))
1220     return session_ho_stream_connect_notify (tc, 0 /* is_fail */ );
1221   return 0;
1222 }
1223
1224 int
1225 session_open_app (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1226 {
1227   session_endpoint_cfg_t *sep = (session_endpoint_cfg_t *) rmt;
1228   transport_endpoint_cfg_t *tep_cfg = session_endpoint_to_transport_cfg (sep);
1229
1230   sep->app_wrk_index = app_wrk_index;
1231   sep->opaque = opaque;
1232
1233   return transport_connect (rmt->transport_proto, tep_cfg);
1234 }
1235
1236 typedef int (*session_open_service_fn) (u32, session_endpoint_t *, u32);
1237
1238 /* *INDENT-OFF* */
1239 static session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES] = {
1240   session_open_vc,
1241   session_open_cl,
1242   session_open_app,
1243 };
1244 /* *INDENT-ON* */
1245
1246 /**
1247  * Ask transport to open connection to remote transport endpoint.
1248  *
1249  * Stores handle for matching request with reply since the call can be
1250  * asynchronous. For instance, for TCP the 3-way handshake must complete
1251  * before reply comes. Session is only created once connection is established.
1252  *
1253  * @param app_index Index of the application requesting the connect
1254  * @param st Session type requested.
1255  * @param tep Remote transport endpoint
1256  * @param opaque Opaque data (typically, api_context) the application expects
1257  *               on open completion.
1258  */
1259 int
1260 session_open (u32 app_wrk_index, session_endpoint_t * rmt, u32 opaque)
1261 {
1262   transport_service_type_t tst;
1263   tst = transport_protocol_service_type (rmt->transport_proto);
1264   return session_open_srv_fns[tst] (app_wrk_index, rmt, opaque);
1265 }
1266
1267 /**
1268  * Ask transport to listen on session endpoint.
1269  *
1270  * @param s Session for which listen will be called. Note that unlike
1271  *          established sessions, listen sessions are not associated to a
1272  *          thread.
1273  * @param sep Local endpoint to be listened on.
1274  */
1275 int
1276 session_listen (session_t * ls, session_endpoint_cfg_t * sep)
1277 {
1278   transport_endpoint_t *tep;
1279   int tc_index;
1280   u32 s_index;
1281
1282   /* Transport bind/listen */
1283   tep = session_endpoint_to_transport (sep);
1284   s_index = ls->session_index;
1285   tc_index = transport_start_listen (session_get_transport_proto (ls),
1286                                      s_index, tep);
1287
1288   if (tc_index < 0)
1289     return tc_index;
1290
1291   /* Attach transport to session. Lookup tables are populated by the app
1292    * worker because local tables (for ct sessions) are not backed by a fib */
1293   ls = listen_session_get (s_index);
1294   ls->connection_index = tc_index;
1295
1296   return 0;
1297 }
1298
1299 /**
1300  * Ask transport to stop listening on local transport endpoint.
1301  *
1302  * @param s Session to stop listening on. It must be in state LISTENING.
1303  */
1304 int
1305 session_stop_listen (session_t * s)
1306 {
1307   transport_proto_t tp = session_get_transport_proto (s);
1308   transport_connection_t *tc;
1309
1310   if (s->session_state != SESSION_STATE_LISTENING)
1311     return SESSION_E_NOLISTEN;
1312
1313   tc = transport_get_listener (tp, s->connection_index);
1314
1315   /* If no transport, assume everything was cleaned up already */
1316   if (!tc)
1317     return SESSION_E_NONE;
1318
1319   if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
1320     session_lookup_del_connection (tc);
1321
1322   transport_stop_listen (tp, s->connection_index);
1323   return 0;
1324 }
1325
1326 /**
1327  * Initialize session closing procedure.
1328  *
1329  * Request is always sent to session node to ensure that all outstanding
1330  * requests are served before transport is notified.
1331  */
1332 void
1333 session_close (session_t * s)
1334 {
1335   if (!s)
1336     return;
1337
1338   if (s->session_state >= SESSION_STATE_CLOSING)
1339     {
1340       /* Session will only be removed once both app and transport
1341        * acknowledge the close */
1342       if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED
1343           || s->session_state == SESSION_STATE_TRANSPORT_DELETED)
1344         session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1345       return;
1346     }
1347
1348   s->session_state = SESSION_STATE_CLOSING;
1349   session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_CLOSE);
1350 }
1351
1352 /**
1353  * Force a close without waiting for data to be flushed
1354  */
1355 void
1356 session_reset (session_t * s)
1357 {
1358   if (s->session_state >= SESSION_STATE_CLOSING)
1359     return;
1360   /* Drop all outstanding tx data */
1361   svm_fifo_dequeue_drop_all (s->tx_fifo);
1362   s->session_state = SESSION_STATE_CLOSING;
1363   session_program_transport_ctrl_evt (s, SESSION_CTRL_EVT_RESET);
1364 }
1365
1366 /**
1367  * Notify transport the session can be disconnected. This should eventually
1368  * result in a delete notification that allows us to cleanup session state.
1369  * Called for both active/passive disconnects.
1370  *
1371  * Must be called from the session's thread.
1372  */
1373 void
1374 session_transport_close (session_t * s)
1375 {
1376   if (s->session_state >= SESSION_STATE_APP_CLOSED)
1377     {
1378       if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1379         s->session_state = SESSION_STATE_CLOSED;
1380       /* If transport is already deleted, just free the session */
1381       else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1382         session_free_w_fifos (s);
1383       return;
1384     }
1385
1386   /* If the tx queue wasn't drained, the transport can continue to try
1387    * sending the outstanding data (in closed state it cannot). It MUST however
1388    * at one point, either after sending everything or after a timeout, call
1389    * delete notify. This will finally lead to the complete cleanup of the
1390    * session.
1391    */
1392   s->session_state = SESSION_STATE_APP_CLOSED;
1393
1394   transport_close (session_get_transport_proto (s), s->connection_index,
1395                    s->thread_index);
1396 }
1397
1398 /**
1399  * Force transport close
1400  */
1401 void
1402 session_transport_reset (session_t * s)
1403 {
1404   if (s->session_state >= SESSION_STATE_APP_CLOSED)
1405     {
1406       if (s->session_state == SESSION_STATE_TRANSPORT_CLOSED)
1407         s->session_state = SESSION_STATE_CLOSED;
1408       else if (s->session_state >= SESSION_STATE_TRANSPORT_DELETED)
1409         session_free_w_fifos (s);
1410       return;
1411     }
1412
1413   s->session_state = SESSION_STATE_APP_CLOSED;
1414   transport_reset (session_get_transport_proto (s), s->connection_index,
1415                    s->thread_index);
1416 }
1417
1418 /**
1419  * Cleanup transport and session state.
1420  *
1421  * Notify transport of the cleanup and free the session. This should
1422  * be called only if transport reported some error and is already
1423  * closed.
1424  */
1425 void
1426 session_transport_cleanup (session_t * s)
1427 {
1428   /* Delete from main lookup table before we axe the the transport */
1429   session_lookup_del_session (s);
1430   if (s->session_state != SESSION_STATE_TRANSPORT_DELETED)
1431     transport_cleanup (session_get_transport_proto (s), s->connection_index,
1432                        s->thread_index);
1433   /* Since we called cleanup, no delete notification will come. So, make
1434    * sure the session is properly freed. */
1435   segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1436   session_free (s);
1437 }
1438
1439 /**
1440  * Allocate event queues in the shared-memory segment
1441  *
1442  * That can either be a newly created memfd segment, that will need to be
1443  * mapped by all stack users, or the binary api's svm region. The latter is
1444  * assumed to be already mapped. NOTE that this assumption DOES NOT hold if
1445  * api clients bootstrap shm api over sockets (i.e. use memfd segments) and
1446  * vpp uses api svm region for event queues.
1447  */
1448 void
1449 session_vpp_event_queues_allocate (session_main_t * smm)
1450 {
1451   u32 evt_q_length = 2048, evt_size = sizeof (session_event_t);
1452   ssvm_private_t *eqs = &smm->evt_qs_segment;
1453   uword eqs_size = 64 << 20;
1454   pid_t vpp_pid = getpid ();
1455   void *oldheap;
1456   int i;
1457
1458   if (smm->configured_event_queue_length)
1459     evt_q_length = smm->configured_event_queue_length;
1460
1461   if (smm->evt_qs_use_memfd_seg)
1462     {
1463       if (smm->evt_qs_segment_size)
1464         eqs_size = smm->evt_qs_segment_size;
1465
1466       eqs->ssvm_size = eqs_size;
1467       eqs->i_am_master = 1;
1468       eqs->my_pid = vpp_pid;
1469       eqs->name = format (0, "%s%c", "evt-qs-segment", 0);
1470       eqs->requested_va = smm->session_baseva;
1471
1472       if (ssvm_master_init (eqs, SSVM_SEGMENT_MEMFD))
1473         {
1474           clib_warning ("failed to initialize queue segment");
1475           return;
1476         }
1477     }
1478
1479   if (smm->evt_qs_use_memfd_seg)
1480     oldheap = ssvm_push_heap (eqs->sh);
1481   else
1482     oldheap = vl_msg_push_heap ();
1483
1484   for (i = 0; i < vec_len (smm->wrk); i++)
1485     {
1486       svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
1487       svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
1488         {evt_q_length, evt_size, 0}
1489         ,
1490         {evt_q_length >> 1, 256, 0}
1491       };
1492       cfg->consumer_pid = 0;
1493       cfg->n_rings = 2;
1494       cfg->q_nitems = evt_q_length;
1495       cfg->ring_cfgs = rc;
1496       smm->wrk[i].vpp_event_queue = svm_msg_q_alloc (cfg);
1497       if (smm->evt_qs_use_memfd_seg)
1498         {
1499           if (svm_msg_q_alloc_consumer_eventfd (smm->wrk[i].vpp_event_queue))
1500             clib_warning ("eventfd returned");
1501         }
1502     }
1503
1504   if (smm->evt_qs_use_memfd_seg)
1505     ssvm_pop_heap (oldheap);
1506   else
1507     vl_msg_pop_heap (oldheap);
1508 }
1509
1510 ssvm_private_t *
1511 session_main_get_evt_q_segment (void)
1512 {
1513   session_main_t *smm = &session_main;
1514   if (smm->evt_qs_use_memfd_seg)
1515     return &smm->evt_qs_segment;
1516   return 0;
1517 }
1518
1519 u64
1520 session_segment_handle (session_t * s)
1521 {
1522   svm_fifo_t *f;
1523
1524   if (!s->rx_fifo)
1525     return SESSION_INVALID_HANDLE;
1526
1527   f = s->rx_fifo;
1528   return segment_manager_make_segment_handle (f->segment_manager,
1529                                               f->segment_index);
1530 }
1531
1532 /* *INDENT-OFF* */
1533 static session_fifo_rx_fn *session_tx_fns[TRANSPORT_TX_N_FNS] = {
1534     session_tx_fifo_peek_and_snd,
1535     session_tx_fifo_dequeue_and_snd,
1536     session_tx_fifo_dequeue_internal,
1537     session_tx_fifo_dequeue_and_snd
1538 };
1539 /* *INDENT-ON* */
1540
1541 void
1542 session_register_transport (transport_proto_t transport_proto,
1543                             const transport_proto_vft_t * vft, u8 is_ip4,
1544                             u32 output_node)
1545 {
1546   session_main_t *smm = &session_main;
1547   session_type_t session_type;
1548   u32 next_index = ~0;
1549
1550   session_type = session_type_from_proto_and_ip (transport_proto, is_ip4);
1551
1552   vec_validate (smm->session_type_to_next, session_type);
1553   vec_validate (smm->session_tx_fns, session_type);
1554
1555   /* *INDENT-OFF* */
1556   if (output_node != ~0)
1557     {
1558       foreach_vlib_main (({
1559           next_index = vlib_node_add_next (this_vlib_main,
1560                                            session_queue_node.index,
1561                                            output_node);
1562       }));
1563     }
1564   /* *INDENT-ON* */
1565
1566   smm->session_type_to_next[session_type] = next_index;
1567   smm->session_tx_fns[session_type] =
1568     session_tx_fns[vft->transport_options.tx_type];
1569 }
1570
1571 transport_proto_t
1572 session_add_transport_proto (void)
1573 {
1574   session_main_t *smm = &session_main;
1575   session_worker_t *wrk;
1576   u32 thread;
1577
1578   smm->last_transport_proto_type += 1;
1579
1580   for (thread = 0; thread < vec_len (smm->wrk); thread++)
1581     {
1582       wrk = session_main_get_worker (thread);
1583       vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1584     }
1585
1586   return smm->last_transport_proto_type;
1587 }
1588
1589 transport_connection_t *
1590 session_get_transport (session_t * s)
1591 {
1592   if (s->session_state != SESSION_STATE_LISTENING)
1593     return transport_get_connection (session_get_transport_proto (s),
1594                                      s->connection_index, s->thread_index);
1595   else
1596     return transport_get_listener (session_get_transport_proto (s),
1597                                    s->connection_index);
1598 }
1599
1600 void
1601 session_get_endpoint (session_t * s, transport_endpoint_t * tep, u8 is_lcl)
1602 {
1603   if (s->session_state != SESSION_STATE_LISTENING)
1604     return transport_get_endpoint (session_get_transport_proto (s),
1605                                    s->connection_index, s->thread_index, tep,
1606                                    is_lcl);
1607   else
1608     return transport_get_listener_endpoint (session_get_transport_proto (s),
1609                                             s->connection_index, tep, is_lcl);
1610 }
1611
1612 transport_connection_t *
1613 listen_session_get_transport (session_t * s)
1614 {
1615   return transport_get_listener (session_get_transport_proto (s),
1616                                  s->connection_index);
1617 }
1618
1619 void
1620 session_queue_run_on_main_thread (vlib_main_t * vm)
1621 {
1622   ASSERT (vlib_get_thread_index () == 0);
1623   vlib_process_signal_event_mt (vm, session_queue_process_node.index,
1624                                 SESSION_Q_PROCESS_RUN_ON_MAIN, 0);
1625 }
1626
1627 static clib_error_t *
1628 session_manager_main_enable (vlib_main_t * vm)
1629 {
1630   segment_manager_main_init_args_t _sm_args = { 0 }, *sm_args = &_sm_args;
1631   session_main_t *smm = &session_main;
1632   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1633   u32 num_threads, preallocated_sessions_per_worker;
1634   session_worker_t *wrk;
1635   int i;
1636
1637   num_threads = 1 /* main thread */  + vtm->n_threads;
1638
1639   if (num_threads < 1)
1640     return clib_error_return (0, "n_thread_stacks not set");
1641
1642   /* Allocate cache line aligned worker contexts */
1643   vec_validate_aligned (smm->wrk, num_threads - 1, CLIB_CACHE_LINE_BYTES);
1644
1645   for (i = 0; i < num_threads; i++)
1646     {
1647       wrk = &smm->wrk[i];
1648       wrk->ctrl_head = clib_llist_make_head (wrk->event_elts, evt_list);
1649       wrk->new_head = clib_llist_make_head (wrk->event_elts, evt_list);
1650       wrk->old_head = clib_llist_make_head (wrk->event_elts, evt_list);
1651       wrk->vm = vlib_mains[i];
1652       wrk->last_vlib_time = vlib_time_now (vlib_mains[i]);
1653       wrk->last_vlib_us_time = wrk->last_vlib_time * CLIB_US_TIME_FREQ;
1654       vec_validate (wrk->session_to_enqueue, smm->last_transport_proto_type);
1655
1656       if (num_threads > 1)
1657         clib_rwlock_init (&smm->wrk[i].peekers_rw_locks);
1658     }
1659
1660   /* Allocate vpp event queues segment and queue */
1661   session_vpp_event_queues_allocate (smm);
1662
1663   /* Initialize fifo segment main baseva and timeout */
1664   sm_args->baseva = smm->session_baseva + smm->evt_qs_segment_size;
1665   sm_args->size = smm->session_va_space_size;
1666   segment_manager_main_init (sm_args);
1667
1668   /* Preallocate sessions */
1669   if (smm->preallocated_sessions)
1670     {
1671       if (num_threads == 1)
1672         {
1673           pool_init_fixed (smm->wrk[0].sessions, smm->preallocated_sessions);
1674         }
1675       else
1676         {
1677           int j;
1678           preallocated_sessions_per_worker =
1679             (1.1 * (f64) smm->preallocated_sessions /
1680              (f64) (num_threads - 1));
1681
1682           for (j = 1; j < num_threads; j++)
1683             {
1684               pool_init_fixed (smm->wrk[j].sessions,
1685                                preallocated_sessions_per_worker);
1686             }
1687         }
1688     }
1689
1690   session_lookup_init ();
1691   app_namespaces_init ();
1692   transport_init ();
1693
1694   smm->is_enabled = 1;
1695
1696   /* Enable transports */
1697   transport_enable_disable (vm, 1);
1698   return 0;
1699 }
1700
1701 void
1702 session_node_enable_disable (u8 is_en)
1703 {
1704   u8 state = is_en ? VLIB_NODE_STATE_POLLING : VLIB_NODE_STATE_DISABLED;
1705   vlib_thread_main_t *vtm = vlib_get_thread_main ();
1706   u8 have_workers = vtm->n_threads != 0;
1707
1708   /* *INDENT-OFF* */
1709   foreach_vlib_main (({
1710     if (have_workers && ii == 0)
1711       {
1712         vlib_node_set_state (this_vlib_main, session_queue_process_node.index,
1713                              state);
1714         if (is_en)
1715           {
1716             vlib_node_t *n = vlib_get_node (this_vlib_main,
1717                                             session_queue_process_node.index);
1718             vlib_start_process (this_vlib_main, n->runtime_index);
1719           }
1720         else
1721           {
1722             vlib_process_signal_event_mt (this_vlib_main,
1723                                           session_queue_process_node.index,
1724                                           SESSION_Q_PROCESS_STOP, 0);
1725           }
1726
1727         continue;
1728       }
1729     vlib_node_set_state (this_vlib_main, session_queue_node.index,
1730                          state);
1731   }));
1732   /* *INDENT-ON* */
1733 }
1734
1735 clib_error_t *
1736 vnet_session_enable_disable (vlib_main_t * vm, u8 is_en)
1737 {
1738   clib_error_t *error = 0;
1739   if (is_en)
1740     {
1741       if (session_main.is_enabled)
1742         return 0;
1743
1744       error = session_manager_main_enable (vm);
1745       session_node_enable_disable (is_en);
1746     }
1747   else
1748     {
1749       session_main.is_enabled = 0;
1750       session_node_enable_disable (is_en);
1751     }
1752
1753   return error;
1754 }
1755
1756 clib_error_t *
1757 session_main_init (vlib_main_t * vm)
1758 {
1759   session_main_t *smm = &session_main;
1760
1761   smm->is_enabled = 0;
1762   smm->session_enable_asap = 0;
1763   smm->session_baseva = HIGH_SEGMENT_BASEVA;
1764
1765 #if (HIGH_SEGMENT_BASEVA > (4ULL << 30))
1766   smm->session_va_space_size = 128ULL << 30;
1767   smm->evt_qs_segment_size = 64 << 20;
1768 #else
1769   smm->session_va_space_size = 128 << 20;
1770   smm->evt_qs_segment_size = 1 << 20;
1771 #endif
1772
1773   smm->last_transport_proto_type = TRANSPORT_PROTO_QUIC;
1774
1775   return 0;
1776 }
1777
1778 static clib_error_t *
1779 session_main_loop_init (vlib_main_t * vm)
1780 {
1781   session_main_t *smm = &session_main;
1782   if (smm->session_enable_asap)
1783     {
1784       vlib_worker_thread_barrier_sync (vm);
1785       vnet_session_enable_disable (vm, 1 /* is_en */ );
1786       vlib_worker_thread_barrier_release (vm);
1787     }
1788   return 0;
1789 }
1790
1791 VLIB_INIT_FUNCTION (session_main_init);
1792 VLIB_MAIN_LOOP_ENTER_FUNCTION (session_main_loop_init);
1793
1794 static clib_error_t *
1795 session_config_fn (vlib_main_t * vm, unformat_input_t * input)
1796 {
1797   session_main_t *smm = &session_main;
1798   u32 nitems;
1799   uword tmp;
1800
1801   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1802     {
1803       if (unformat (input, "event-queue-length %d", &nitems))
1804         {
1805           if (nitems >= 2048)
1806             smm->configured_event_queue_length = nitems;
1807           else
1808             clib_warning ("event queue length %d too small, ignored", nitems);
1809         }
1810       else if (unformat (input, "preallocated-sessions %d",
1811                          &smm->preallocated_sessions))
1812         ;
1813       else if (unformat (input, "v4-session-table-buckets %d",
1814                          &smm->configured_v4_session_table_buckets))
1815         ;
1816       else if (unformat (input, "v4-halfopen-table-buckets %d",
1817                          &smm->configured_v4_halfopen_table_buckets))
1818         ;
1819       else if (unformat (input, "v6-session-table-buckets %d",
1820                          &smm->configured_v6_session_table_buckets))
1821         ;
1822       else if (unformat (input, "v6-halfopen-table-buckets %d",
1823                          &smm->configured_v6_halfopen_table_buckets))
1824         ;
1825       else if (unformat (input, "v4-session-table-memory %U",
1826                          unformat_memory_size, &tmp))
1827         {
1828           if (tmp >= 0x100000000)
1829             return clib_error_return (0, "memory size %llx (%lld) too large",
1830                                       tmp, tmp);
1831           smm->configured_v4_session_table_memory = tmp;
1832         }
1833       else if (unformat (input, "v4-halfopen-table-memory %U",
1834                          unformat_memory_size, &tmp))
1835         {
1836           if (tmp >= 0x100000000)
1837             return clib_error_return (0, "memory size %llx (%lld) too large",
1838                                       tmp, tmp);
1839           smm->configured_v4_halfopen_table_memory = tmp;
1840         }
1841       else if (unformat (input, "v6-session-table-memory %U",
1842                          unformat_memory_size, &tmp))
1843         {
1844           if (tmp >= 0x100000000)
1845             return clib_error_return (0, "memory size %llx (%lld) too large",
1846                                       tmp, tmp);
1847           smm->configured_v6_session_table_memory = tmp;
1848         }
1849       else if (unformat (input, "v6-halfopen-table-memory %U",
1850                          unformat_memory_size, &tmp))
1851         {
1852           if (tmp >= 0x100000000)
1853             return clib_error_return (0, "memory size %llx (%lld) too large",
1854                                       tmp, tmp);
1855           smm->configured_v6_halfopen_table_memory = tmp;
1856         }
1857       else if (unformat (input, "local-endpoints-table-memory %U",
1858                          unformat_memory_size, &tmp))
1859         {
1860           if (tmp >= 0x100000000)
1861             return clib_error_return (0, "memory size %llx (%lld) too large",
1862                                       tmp, tmp);
1863           smm->local_endpoints_table_memory = tmp;
1864         }
1865       else if (unformat (input, "local-endpoints-table-buckets %d",
1866                          &smm->local_endpoints_table_buckets))
1867         ;
1868       else if (unformat (input, "evt_qs_memfd_seg"))
1869         smm->evt_qs_use_memfd_seg = 1;
1870       else if (unformat (input, "evt_qs_seg_size %U", unformat_memory_size,
1871                          &smm->evt_qs_segment_size))
1872         ;
1873       else if (unformat (input, "enable"))
1874         smm->session_enable_asap = 1;
1875       else
1876         return clib_error_return (0, "unknown input `%U'",
1877                                   format_unformat_error, input);
1878     }
1879   return 0;
1880 }
1881
1882 VLIB_CONFIG_FUNCTION (session_config_fn, "session");
1883
1884 /*
1885  * fd.io coding-style-patch-verification: ON
1886  *
1887  * Local Variables:
1888  * eval: (c-set-style "gnu")
1889  * End:
1890  */