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