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