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