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