session: close app wrk socket on delete
[vpp.git] / src / vnet / session / application.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 #include <vnet/session/application.h>
17 #include <vnet/session/application_interface.h>
18 #include <vnet/session/application_namespace.h>
19 #include <vnet/session/application_local.h>
20 #include <vnet/session/session.h>
21
22 static app_main_t app_main;
23
24 #define app_interface_check_thread_and_barrier(_fn, _arg)               \
25   if (PREDICT_FALSE (!vlib_thread_is_main_w_barrier ()))                \
26     {                                                                   \
27       vlib_rpc_call_main_thread (_fn, (u8 *) _arg, sizeof(*_arg));      \
28       return 0;                                                         \
29     }
30
31 static app_listener_t *
32 app_listener_alloc (application_t * app)
33 {
34   app_listener_t *app_listener;
35   pool_get (app->listeners, app_listener);
36   clib_memset (app_listener, 0, sizeof (*app_listener));
37   app_listener->al_index = app_listener - app->listeners;
38   app_listener->app_index = app->app_index;
39   app_listener->session_index = SESSION_INVALID_INDEX;
40   app_listener->local_index = SESSION_INVALID_INDEX;
41   app_listener->ls_handle = SESSION_INVALID_HANDLE;
42   return app_listener;
43 }
44
45 app_listener_t *
46 app_listener_get (application_t * app, u32 app_listener_index)
47 {
48   return pool_elt_at_index (app->listeners, app_listener_index);
49 }
50
51 static void
52 app_listener_free (application_t * app, app_listener_t * app_listener)
53 {
54   clib_bitmap_free (app_listener->workers);
55   if (CLIB_DEBUG)
56     clib_memset (app_listener, 0xfa, sizeof (*app_listener));
57   pool_put (app->listeners, app_listener);
58 }
59
60 session_handle_t
61 app_listener_handle (app_listener_t * al)
62 {
63   return al->ls_handle;
64 }
65
66 app_listener_t *
67 app_listener_get_w_session (session_t * ls)
68 {
69   application_t *app;
70
71   app = application_get_if_valid (ls->app_index);
72   if (!app)
73     return 0;
74   return app_listener_get (app, ls->al_index);
75 }
76
77 session_handle_t
78 app_listen_session_handle (session_t * ls)
79 {
80   app_listener_t *al;
81   al = app_listener_get_w_session (ls);
82   if (!al)
83     return listen_session_get_handle (ls);
84   return al->ls_handle;
85 }
86
87 app_listener_t *
88 app_listener_get_w_handle (session_handle_t handle)
89 {
90   session_t *ls;
91   ls = session_get_from_handle_if_valid (handle);
92   if (!ls)
93     return 0;
94   return app_listener_get_w_session (ls);
95 }
96
97 app_listener_t *
98 app_listener_lookup (application_t * app, session_endpoint_cfg_t * sep_ext)
99 {
100   u32 table_index, fib_proto;
101   session_endpoint_t *sep;
102   session_handle_t handle;
103   session_t *ls;
104   void *iface_ip;
105   ip46_address_t original_ip;
106
107   sep = (session_endpoint_t *) sep_ext;
108   if (application_has_local_scope (app) && session_endpoint_is_local (sep))
109     {
110       table_index = application_local_session_table (app);
111       handle = session_lookup_endpoint_listener (table_index, sep, 1);
112       if (handle != SESSION_INVALID_HANDLE)
113         {
114           ls = listen_session_get_from_handle (handle);
115           return app_listener_get_w_session (ls);
116         }
117     }
118
119   fib_proto = session_endpoint_fib_proto (sep);
120   table_index = session_lookup_get_index_for_fib (fib_proto, sep->fib_index);
121   handle = session_lookup_endpoint_listener (table_index, sep, 1);
122   if (handle != SESSION_INVALID_HANDLE)
123     {
124       ls = listen_session_get_from_handle (handle);
125       return app_listener_get_w_session ((session_t *) ls);
126     }
127
128   /*
129    * When binds to "inaddr_any", we add zero address in the local lookup table
130    * and interface address in the global lookup table. If local scope disable,
131    * the latter is the only clue to find the listener.
132    */
133   if (!application_has_local_scope (app) &&
134       ip_is_zero (&sep_ext->ip, sep_ext->is_ip4) &&
135       sep_ext->sw_if_index != ENDPOINT_INVALID_INDEX)
136     {
137       if ((iface_ip = ip_interface_get_first_ip (sep_ext->sw_if_index,
138                                                  sep_ext->is_ip4)))
139         {
140           ip_copy (&original_ip, &sep_ext->ip, sep_ext->is_ip4);
141           ip_set (&sep_ext->ip, iface_ip, sep_ext->is_ip4);
142           handle = session_lookup_endpoint_listener (table_index, sep, 1);
143           ip_copy (&sep_ext->ip, &original_ip, sep_ext->is_ip4);
144           if (handle != SESSION_INVALID_HANDLE)
145             {
146               ls = listen_session_get_from_handle (handle);
147               return app_listener_get_w_session ((session_t *) ls);
148             }
149         }
150     }
151
152   return 0;
153 }
154
155 int
156 app_listener_alloc_and_init (application_t * app,
157                              session_endpoint_cfg_t * sep,
158                              app_listener_t ** listener)
159 {
160   app_listener_t *app_listener;
161   transport_connection_t *tc;
162   u32 al_index, table_index;
163   session_handle_t lh;
164   session_type_t st;
165   session_t *ls = 0;
166   int rv;
167
168   app_listener = app_listener_alloc (app);
169   al_index = app_listener->al_index;
170   st = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
171
172   /*
173    * Add session endpoint to local session table. Only binds to "inaddr_any"
174    * (i.e., zero address) are added to local scope table.
175    */
176   if (application_has_local_scope (app)
177       && session_endpoint_is_local ((session_endpoint_t *) sep))
178     {
179       session_type_t local_st;
180
181       local_st = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE,
182                                                  sep->is_ip4);
183       ls = listen_session_alloc (0, local_st);
184       ls->app_index = app->app_index;
185       ls->app_wrk_index = sep->app_wrk_index;
186       lh = session_handle (ls);
187
188       if ((rv = session_listen (ls, sep)))
189         {
190           ls = session_get_from_handle (lh);
191           session_free (ls);
192           return rv;
193         }
194
195       ls = session_get_from_handle (lh);
196       app_listener = app_listener_get (app, al_index);
197       app_listener->local_index = ls->session_index;
198       app_listener->ls_handle = lh;
199       ls->al_index = al_index;
200
201       table_index = application_local_session_table (app);
202       session_lookup_add_session_endpoint (table_index,
203                                            (session_endpoint_t *) sep, lh);
204     }
205
206   if (application_has_global_scope (app))
207     {
208       /*
209        * Start listening on local endpoint for requested transport and scope.
210        * Creates a stream session with state LISTENING to be used in session
211        * lookups, prior to establishing connection. Requests transport to
212        * build it's own specific listening connection.
213        */
214       ls = listen_session_alloc (0, st);
215       ls->app_index = app->app_index;
216       ls->app_wrk_index = sep->app_wrk_index;
217
218       /* Listen pool can be reallocated if the transport is
219        * recursive (tls) */
220       lh = listen_session_get_handle (ls);
221
222       if ((rv = session_listen (ls, sep)))
223         {
224           ls = listen_session_get_from_handle (lh);
225           session_free (ls);
226           return rv;
227         }
228       ls = listen_session_get_from_handle (lh);
229       app_listener = app_listener_get (app, al_index);
230       app_listener->session_index = ls->session_index;
231       app_listener->ls_handle = lh;
232       ls->al_index = al_index;
233
234       /* Add to the global lookup table after transport was initialized.
235        * Lookup table needs to be populated only now because sessions
236        * with cut-through transport are are added to app local tables that
237        * are not related to network fibs, i.e., cannot be added as
238        * connections */
239       tc = session_get_transport (ls);
240       if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
241         {
242           fib_protocol_t fib_proto;
243           fib_proto = session_endpoint_fib_proto ((session_endpoint_t *) sep);
244           /* Assume namespace vetted previously so make sure table exists */
245           table_index = session_lookup_get_or_alloc_index_for_fib (
246             fib_proto, sep->fib_index);
247           session_lookup_add_session_endpoint (table_index,
248                                                (session_endpoint_t *) sep,
249                                                lh);
250         }
251     }
252
253   if (!ls)
254     {
255       app_listener_free (app, app_listener);
256       return -1;
257     }
258
259   *listener = app_listener;
260   return 0;
261 }
262
263 void
264 app_listener_cleanup (app_listener_t * al)
265 {
266   application_t *app = application_get (al->app_index);
267   session_t *ls;
268
269   if (al->session_index != SESSION_INVALID_INDEX)
270     {
271       ls = session_get (al->session_index, 0);
272       session_stop_listen (ls);
273       listen_session_free (ls);
274     }
275   if (al->local_index != SESSION_INVALID_INDEX)
276     {
277       session_endpoint_t sep = SESSION_ENDPOINT_NULL;
278       u32 table_index;
279
280       table_index = application_local_session_table (app);
281       ls = listen_session_get (al->local_index);
282       ct_session_endpoint (ls, &sep);
283       session_lookup_del_session_endpoint (table_index, &sep);
284       session_stop_listen (ls);
285       listen_session_free (ls);
286     }
287   app_listener_free (app, al);
288 }
289
290 static app_worker_t *
291 app_listener_select_worker (application_t * app, app_listener_t * al)
292 {
293   u32 wrk_index;
294
295   app = application_get (al->app_index);
296   wrk_index = clib_bitmap_next_set (al->workers, al->accept_rotor + 1);
297   if (wrk_index == ~0)
298     wrk_index = clib_bitmap_first_set (al->workers);
299
300   ASSERT (wrk_index != ~0);
301   al->accept_rotor = wrk_index;
302   return application_get_worker (app, wrk_index);
303 }
304
305 session_t *
306 app_listener_get_session (app_listener_t * al)
307 {
308   if (al->session_index == SESSION_INVALID_INDEX)
309     return 0;
310
311   return listen_session_get (al->session_index);
312 }
313
314 session_t *
315 app_listener_get_local_session (app_listener_t * al)
316 {
317   if (al->local_index == SESSION_INVALID_INDEX)
318     return 0;
319   return listen_session_get (al->local_index);
320 }
321
322 static app_worker_map_t *
323 app_worker_map_alloc (application_t * app)
324 {
325   app_worker_map_t *map;
326   pool_get (app->worker_maps, map);
327   clib_memset (map, 0, sizeof (*map));
328   return map;
329 }
330
331 static u32
332 app_worker_map_index (application_t * app, app_worker_map_t * map)
333 {
334   return (map - app->worker_maps);
335 }
336
337 static void
338 app_worker_map_free (application_t * app, app_worker_map_t * map)
339 {
340   pool_put (app->worker_maps, map);
341 }
342
343 static app_worker_map_t *
344 app_worker_map_get (application_t * app, u32 map_index)
345 {
346   if (pool_is_free_index (app->worker_maps, map_index))
347     return 0;
348   return pool_elt_at_index (app->worker_maps, map_index);
349 }
350
351 static const u8 *
352 app_get_name (application_t * app)
353 {
354   return app->name;
355 }
356
357 u32
358 application_session_table (application_t * app, u8 fib_proto)
359 {
360   app_namespace_t *app_ns;
361   app_ns = app_namespace_get (app->ns_index);
362   if (!application_has_global_scope (app))
363     return APP_INVALID_INDEX;
364   if (fib_proto == FIB_PROTOCOL_IP4)
365     return session_lookup_get_index_for_fib (fib_proto,
366                                              app_ns->ip4_fib_index);
367   else
368     return session_lookup_get_index_for_fib (fib_proto,
369                                              app_ns->ip6_fib_index);
370 }
371
372 u32
373 application_local_session_table (application_t * app)
374 {
375   app_namespace_t *app_ns;
376   if (!application_has_local_scope (app))
377     return APP_INVALID_INDEX;
378   app_ns = app_namespace_get (app->ns_index);
379   return app_ns->local_table_index;
380 }
381
382 /**
383  * Returns app name for app-index
384  */
385 const u8 *
386 application_name_from_index (u32 app_index)
387 {
388   application_t *app = application_get (app_index);
389   if (!app)
390     return 0;
391   return app_get_name (app);
392 }
393
394 static void
395 application_api_table_add (u32 app_index, u32 api_client_index)
396 {
397   if (api_client_index != APP_INVALID_INDEX)
398     hash_set (app_main.app_by_api_client_index, api_client_index, app_index);
399 }
400
401 static void
402 application_api_table_del (u32 api_client_index)
403 {
404   hash_unset (app_main.app_by_api_client_index, api_client_index);
405 }
406
407 static void
408 application_name_table_add (application_t * app)
409 {
410   hash_set_mem (app_main.app_by_name, app->name, app->app_index);
411 }
412
413 static void
414 application_name_table_del (application_t * app)
415 {
416   hash_unset_mem (app_main.app_by_name, app->name);
417 }
418
419 application_t *
420 application_lookup (u32 api_client_index)
421 {
422   uword *p;
423   p = hash_get (app_main.app_by_api_client_index, api_client_index);
424   if (p)
425     return application_get_if_valid (p[0]);
426
427   return 0;
428 }
429
430 application_t *
431 application_lookup_name (const u8 * name)
432 {
433   uword *p;
434   p = hash_get_mem (app_main.app_by_name, name);
435   if (p)
436     return application_get (p[0]);
437
438   return 0;
439 }
440
441 void
442 appsl_pending_rx_mqs_add_tail (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
443 {
444   app_rx_mq_elt_t *head;
445
446   if (!aw->pending_rx_mqs)
447     {
448       elt->next = elt->prev = elt;
449       aw->pending_rx_mqs = elt;
450       return;
451     }
452
453   head = aw->pending_rx_mqs;
454
455   ASSERT (head != elt);
456
457   elt->prev = head->prev;
458   elt->next = head;
459
460   head->prev->next = elt;
461   head->prev = elt;
462 }
463
464 void
465 appsl_pending_rx_mqs_del (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
466 {
467   if (elt->next == elt)
468     {
469       elt->next = elt->prev = 0;
470       aw->pending_rx_mqs = 0;
471       return;
472     }
473
474   if (elt == aw->pending_rx_mqs)
475     aw->pending_rx_mqs = elt->next;
476
477   elt->next->prev = elt->prev;
478   elt->prev->next = elt->next;
479   elt->next = elt->prev = 0;
480 }
481
482 vlib_node_registration_t appsl_rx_mqs_input_node;
483
484 VLIB_NODE_FN (appsl_rx_mqs_input_node)
485 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
486 {
487   u32 thread_index = vm->thread_index, n_msgs = 0;
488   app_rx_mq_elt_t *elt, *next;
489   app_main_t *am = &app_main;
490   session_worker_t *wrk;
491   int __clib_unused rv;
492   appsl_wrk_t *aw;
493   u64 buf;
494
495   aw = &am->wrk[thread_index];
496   elt = aw->pending_rx_mqs;
497   if (!elt)
498     return 0;
499
500   wrk = session_main_get_worker (thread_index);
501
502   do
503     {
504       if (!(elt->flags & APP_RX_MQ_F_POSTPONED))
505         rv = read (svm_msg_q_get_eventfd (elt->mq), &buf, sizeof (buf));
506       n_msgs += session_wrk_handle_mq (wrk, elt->mq);
507
508       next = elt->next;
509       appsl_pending_rx_mqs_del (aw, elt);
510       if (!svm_msg_q_is_empty (elt->mq))
511         {
512           elt->flags |= APP_RX_MQ_F_POSTPONED;
513           appsl_pending_rx_mqs_add_tail (aw, elt);
514         }
515       else
516         {
517           elt->flags = 0;
518         }
519       elt = next;
520     }
521   while (aw->pending_rx_mqs && elt != aw->pending_rx_mqs);
522
523   if (aw->pending_rx_mqs)
524     vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
525
526   if (n_msgs && wrk->state == SESSION_WRK_INTERRUPT)
527     vlib_node_set_interrupt_pending (vm, session_queue_node.index);
528
529   return n_msgs;
530 }
531
532 VLIB_REGISTER_NODE (appsl_rx_mqs_input_node) = {
533   .name = "appsl-rx-mqs-input",
534   .type = VLIB_NODE_TYPE_INPUT,
535   .state = VLIB_NODE_STATE_DISABLED,
536 };
537
538 static clib_error_t *
539 app_rx_mq_fd_read_ready (clib_file_t *cf)
540 {
541   app_rx_mq_handle_t *handle = (app_rx_mq_handle_t *) &cf->private_data;
542   vlib_main_t *vm = vlib_get_main ();
543   app_main_t *am = &app_main;
544   app_rx_mq_elt_t *mqe;
545   application_t *app;
546   appsl_wrk_t *aw;
547
548   ASSERT (vlib_get_thread_index () == handle->thread_index);
549   app = application_get_if_valid (handle->app_index);
550   if (!app)
551     return 0;
552
553   mqe = &app->rx_mqs[handle->thread_index];
554   if ((mqe->flags & APP_RX_MQ_F_PENDING) || svm_msg_q_is_empty (mqe->mq))
555     return 0;
556
557   aw = &am->wrk[handle->thread_index];
558   appsl_pending_rx_mqs_add_tail (aw, mqe);
559   mqe->flags |= APP_RX_MQ_F_PENDING;
560
561   vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
562
563   return 0;
564 }
565
566 static clib_error_t *
567 app_rx_mq_fd_write_ready (clib_file_t *cf)
568 {
569   clib_warning ("should not be called");
570   return 0;
571 }
572
573 static void
574 app_rx_mqs_epoll_add (application_t *app, app_rx_mq_elt_t *mqe)
575 {
576   clib_file_t template = { 0 };
577   app_rx_mq_handle_t handle;
578   u32 thread_index;
579   int fd;
580
581   thread_index = mqe - app->rx_mqs;
582   fd = svm_msg_q_get_eventfd (mqe->mq);
583
584   handle.app_index = app->app_index;
585   handle.thread_index = thread_index;
586
587   template.read_function = app_rx_mq_fd_read_ready;
588   template.write_function = app_rx_mq_fd_write_ready;
589   template.file_descriptor = fd;
590   template.private_data = handle.as_u64;
591   template.polling_thread_index = thread_index;
592   template.description =
593     format (0, "app-%u-rx-mq-%u", app->app_index, thread_index);
594   mqe->file_index = clib_file_add (&file_main, &template);
595 }
596
597 static void
598 app_rx_mqs_epoll_del (application_t *app, app_rx_mq_elt_t *mqe)
599 {
600   u32 thread_index = mqe - app->rx_mqs;
601   app_main_t *am = &app_main;
602   appsl_wrk_t *aw;
603
604   aw = &am->wrk[thread_index];
605
606   session_wrk_handle_mq (session_main_get_worker (thread_index), mqe->mq);
607
608   if (mqe->flags & APP_RX_MQ_F_PENDING)
609     appsl_pending_rx_mqs_del (aw, mqe);
610
611   clib_file_del_by_index (&file_main, mqe->file_index);
612 }
613
614 svm_msg_q_t *
615 application_rx_mq_get (application_t *app, u32 mq_index)
616 {
617   if (!app->rx_mqs)
618     return 0;
619
620   return app->rx_mqs[mq_index].mq;
621 }
622
623 static int
624 app_rx_mqs_alloc (application_t *app)
625 {
626   u32 evt_q_length, evt_size = sizeof (session_event_t);
627   fifo_segment_t *eqs = &app->rx_mqs_segment;
628   u32 n_mqs = vlib_num_workers () + 1;
629   segment_manager_props_t *props;
630   int i;
631
632   props = application_segment_manager_properties (app);
633   evt_q_length = clib_max (props->evt_q_size, 128);
634
635   svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
636   svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
637     { evt_q_length, evt_size, 0 }, { evt_q_length >> 1, 256, 0 }
638   };
639   cfg->consumer_pid = 0;
640   cfg->n_rings = 2;
641   cfg->q_nitems = evt_q_length;
642   cfg->ring_cfgs = rc;
643
644   eqs->ssvm.ssvm_size = svm_msg_q_size_to_alloc (cfg) * n_mqs + (1 << 20);
645   eqs->ssvm.name = format (0, "%s-rx-mqs-seg%c", app->name, 0);
646
647   if (ssvm_server_init (&eqs->ssvm, SSVM_SEGMENT_MEMFD))
648     {
649       clib_warning ("failed to initialize queue segment");
650       return SESSION_E_SEG_CREATE;
651     }
652
653   fifo_segment_init (eqs);
654
655   /* Fifo segment filled only with mqs */
656   eqs->h->n_mqs = n_mqs;
657   vec_validate (app->rx_mqs, n_mqs - 1);
658
659   for (i = 0; i < n_mqs; i++)
660     {
661       app->rx_mqs[i].mq = fifo_segment_msg_q_alloc (eqs, i, cfg);
662       if (svm_msg_q_alloc_eventfd (app->rx_mqs[i].mq))
663         {
664           clib_warning ("eventfd returned");
665           fifo_segment_cleanup (eqs);
666           ssvm_delete (&eqs->ssvm);
667           return SESSION_E_EVENTFD_ALLOC;
668         }
669       app_rx_mqs_epoll_add (app, &app->rx_mqs[i]);
670       app->rx_mqs[i].app_index = app->app_index;
671     }
672
673   return 0;
674 }
675
676 u8
677 application_use_private_rx_mqs (void)
678 {
679   return session_main.use_private_rx_mqs;
680 }
681
682 fifo_segment_t *
683 application_get_rx_mqs_segment (application_t *app)
684 {
685   if (application_use_private_rx_mqs ())
686     return &app->rx_mqs_segment;
687   return session_main_get_evt_q_segment ();
688 }
689
690 void
691 application_enable_rx_mqs_nodes (u8 is_en)
692 {
693   u8 state = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
694
695   foreach_vlib_main ()
696     vlib_node_set_state (this_vlib_main, appsl_rx_mqs_input_node.index, state);
697 }
698
699 static application_t *
700 application_alloc (void)
701 {
702   application_t *app;
703   pool_get (app_main.app_pool, app);
704   clib_memset (app, 0, sizeof (*app));
705   app->app_index = app - app_main.app_pool;
706   return app;
707 }
708
709 application_t *
710 application_get (u32 app_index)
711 {
712   if (app_index == APP_INVALID_INDEX)
713     return 0;
714   return pool_elt_at_index (app_main.app_pool, app_index);
715 }
716
717 application_t *
718 application_get_if_valid (u32 app_index)
719 {
720   if (pool_is_free_index (app_main.app_pool, app_index))
721     return 0;
722
723   return pool_elt_at_index (app_main.app_pool, app_index);
724 }
725
726 static void
727 application_verify_cb_fns (session_cb_vft_t * cb_fns)
728 {
729   if (cb_fns->session_accept_callback == 0)
730     clib_warning ("No accept callback function provided");
731   if (cb_fns->session_connected_callback == 0)
732     clib_warning ("No session connected callback function provided");
733   if (cb_fns->session_disconnect_callback == 0)
734     clib_warning ("No session disconnect callback function provided");
735   if (cb_fns->session_reset_callback == 0)
736     clib_warning ("No session reset callback function provided");
737 }
738
739 /**
740  * Check app config for given segment type
741  *
742  * Returns 1 on success and 0 otherwise
743  */
744 static u8
745 application_verify_cfg (ssvm_segment_type_t st)
746 {
747   u8 is_valid;
748   if (st == SSVM_SEGMENT_MEMFD)
749     {
750       is_valid = (session_main_get_evt_q_segment () != 0);
751       if (!is_valid)
752         clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
753       return is_valid;
754     }
755   else if (st == SSVM_SEGMENT_SHM)
756     {
757       is_valid = (session_main_get_evt_q_segment () == 0);
758       if (!is_valid)
759         clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
760       return is_valid;
761     }
762   else
763     return 1;
764 }
765
766 static int
767 application_alloc_and_init (app_init_args_t * a)
768 {
769   ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
770   segment_manager_props_t *props;
771   application_t *app;
772   u64 *opts;
773
774   app = application_alloc ();
775   opts = a->options;
776   /*
777    * Make sure we support the requested configuration
778    */
779   if ((opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN) &&
780       !(opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_MEMFD_FOR_BUILTIN))
781     seg_type = SSVM_SEGMENT_PRIVATE;
782
783   if ((opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD) &&
784       seg_type != SSVM_SEGMENT_MEMFD)
785     {
786       clib_warning ("mq eventfds can only be used if socket transport is "
787                     "used for binary api");
788       return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
789     }
790
791   if (!application_verify_cfg (seg_type))
792     return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
793
794   if (opts[APP_OPTIONS_PREALLOC_FIFO_PAIRS] &&
795       opts[APP_OPTIONS_PREALLOC_FIFO_HDRS])
796     return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
797
798   /* Check that the obvious things are properly set up */
799   application_verify_cb_fns (a->session_cb_vft);
800
801   app->flags = opts[APP_OPTIONS_FLAGS];
802   app->cb_fns = *a->session_cb_vft;
803   app->ns_index = opts[APP_OPTIONS_NAMESPACE];
804   app->proxied_transports = opts[APP_OPTIONS_PROXY_TRANSPORT];
805   app->name = vec_dup (a->name);
806
807   /* If no scope enabled, default to global */
808   if (!application_has_global_scope (app)
809       && !application_has_local_scope (app))
810     app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
811
812   props = application_segment_manager_properties (app);
813   segment_manager_props_init (props);
814   props->segment_size = opts[APP_OPTIONS_SEGMENT_SIZE];
815   props->prealloc_fifos = opts[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
816   props->prealloc_fifo_hdrs = opts[APP_OPTIONS_PREALLOC_FIFO_HDRS];
817   if (opts[APP_OPTIONS_ADD_SEGMENT_SIZE])
818     {
819       props->add_segment_size = opts[APP_OPTIONS_ADD_SEGMENT_SIZE];
820       props->add_segment = 1;
821     }
822   if (opts[APP_OPTIONS_RX_FIFO_SIZE])
823     props->rx_fifo_size = opts[APP_OPTIONS_RX_FIFO_SIZE];
824   if (opts[APP_OPTIONS_TX_FIFO_SIZE])
825     props->tx_fifo_size = opts[APP_OPTIONS_TX_FIFO_SIZE];
826   if (opts[APP_OPTIONS_EVT_QUEUE_SIZE])
827     props->evt_q_size = opts[APP_OPTIONS_EVT_QUEUE_SIZE];
828   if (opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
829     props->use_mq_eventfd = 1;
830   if (opts[APP_OPTIONS_TLS_ENGINE])
831     app->tls_engine = opts[APP_OPTIONS_TLS_ENGINE];
832   if (opts[APP_OPTIONS_MAX_FIFO_SIZE])
833     props->max_fifo_size = opts[APP_OPTIONS_MAX_FIFO_SIZE];
834   if (opts[APP_OPTIONS_HIGH_WATERMARK])
835     props->high_watermark = opts[APP_OPTIONS_HIGH_WATERMARK];
836   if (opts[APP_OPTIONS_LOW_WATERMARK])
837     props->low_watermark = opts[APP_OPTIONS_LOW_WATERMARK];
838   if (opts[APP_OPTIONS_PCT_FIRST_ALLOC])
839     props->pct_first_alloc = opts[APP_OPTIONS_PCT_FIRST_ALLOC];
840   props->segment_type = seg_type;
841
842   /* Add app to lookup by api_client_index table */
843   if (!application_is_builtin (app))
844     application_api_table_add (app->app_index, a->api_client_index);
845   else
846     application_name_table_add (app);
847
848   a->app_index = app->app_index;
849
850   APP_DBG ("New app name: %v api index: %u index %u", app->name,
851            a->api_client_index, app->app_index);
852
853   return 0;
854 }
855
856 static void
857 application_free (application_t * app)
858 {
859   app_worker_map_t *wrk_map;
860   app_worker_t *app_wrk;
861
862   /*
863    * The app event queue allocated in first segment is cleared with
864    * the segment manager. No need to explicitly free it.
865    */
866   APP_DBG ("Delete app name %v index: %d", app->name, app->app_index);
867
868   if (application_is_proxy (app))
869     application_remove_proxy (app);
870
871   /*
872    * Free workers
873    */
874
875   /* *INDENT-OFF* */
876   pool_flush (wrk_map, app->worker_maps, ({
877     app_wrk = app_worker_get (wrk_map->wrk_index);
878     app_worker_free (app_wrk);
879   }));
880   /* *INDENT-ON* */
881   pool_free (app->worker_maps);
882
883   /*
884    * Free rx mqs if allocated
885    */
886   if (app->rx_mqs)
887     {
888       int i;
889       for (i = 0; i < vec_len (app->rx_mqs); i++)
890         app_rx_mqs_epoll_del (app, &app->rx_mqs[i]);
891
892       fifo_segment_cleanup (&app->rx_mqs_segment);
893       ssvm_delete (&app->rx_mqs_segment.ssvm);
894       vec_free (app->rx_mqs);
895     }
896
897   /*
898    * Cleanup remaining state
899    */
900   if (application_is_builtin (app))
901     application_name_table_del (app);
902   vec_free (app->name);
903   pool_put (app_main.app_pool, app);
904 }
905
906 static void
907 application_detach_process (application_t * app, u32 api_client_index)
908 {
909   vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
910   app_worker_map_t *wrk_map;
911   u32 *wrks = 0, *wrk_index;
912   app_worker_t *app_wrk;
913
914   if (api_client_index == ~0)
915     {
916       application_free (app);
917       return;
918     }
919
920   APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
921            app->app_index, api_client_index);
922
923   /* *INDENT-OFF* */
924   pool_foreach (wrk_map, app->worker_maps)  {
925     app_wrk = app_worker_get (wrk_map->wrk_index);
926     if (app_wrk->api_client_index == api_client_index)
927       vec_add1 (wrks, app_wrk->wrk_index);
928   }
929   /* *INDENT-ON* */
930
931   if (!vec_len (wrks))
932     {
933       clib_warning ("no workers for app %u api_index %u", app->app_index,
934                     api_client_index);
935       return;
936     }
937
938   args->app_index = app->app_index;
939   args->api_client_index = api_client_index;
940   vec_foreach (wrk_index, wrks)
941   {
942     app_wrk = app_worker_get (wrk_index[0]);
943     args->wrk_map_index = app_wrk->wrk_map_index;
944     args->is_add = 0;
945     vnet_app_worker_add_del (args);
946   }
947   vec_free (wrks);
948 }
949
950 app_worker_t *
951 application_get_worker (application_t * app, u32 wrk_map_index)
952 {
953   app_worker_map_t *map;
954   map = app_worker_map_get (app, wrk_map_index);
955   if (!map)
956     return 0;
957   return app_worker_get (map->wrk_index);
958 }
959
960 app_worker_t *
961 application_get_default_worker (application_t * app)
962 {
963   return application_get_worker (app, 0);
964 }
965
966 u32
967 application_n_workers (application_t * app)
968 {
969   return pool_elts (app->worker_maps);
970 }
971
972 app_worker_t *
973 application_listener_select_worker (session_t * ls)
974 {
975   application_t *app;
976   app_listener_t *al;
977
978   app = application_get (ls->app_index);
979   al = app_listener_get (app, ls->al_index);
980   return app_listener_select_worker (app, al);
981 }
982
983 int
984 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
985 {
986   app_worker_map_t *wrk_map;
987   app_worker_t *app_wrk;
988   segment_manager_t *sm;
989   int rv;
990
991   app_wrk = app_worker_alloc (app);
992   wrk_map = app_worker_map_alloc (app);
993   wrk_map->wrk_index = app_wrk->wrk_index;
994   app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
995
996   /*
997    * Setup first segment manager
998    */
999   sm = segment_manager_alloc ();
1000   sm->app_wrk_index = app_wrk->wrk_index;
1001
1002   if ((rv = segment_manager_init_first (sm)))
1003     {
1004       app_worker_free (app_wrk);
1005       return rv;
1006     }
1007   sm->first_is_protected = 1;
1008
1009   /*
1010    * Setup app worker
1011    */
1012   app_wrk->connects_seg_manager = segment_manager_index (sm);
1013   app_wrk->listeners_table = hash_create (0, sizeof (u64));
1014   app_wrk->event_queue = segment_manager_event_queue (sm);
1015   app_wrk->app_is_builtin = application_is_builtin (app);
1016
1017   *wrk = app_wrk;
1018
1019   return 0;
1020 }
1021
1022 int
1023 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
1024 {
1025   fifo_segment_t *fs;
1026   app_worker_map_t *wrk_map;
1027   app_worker_t *app_wrk;
1028   segment_manager_t *sm;
1029   application_t *app;
1030   int rv;
1031
1032   app = application_get (a->app_index);
1033   if (!app)
1034     return VNET_API_ERROR_INVALID_VALUE;
1035
1036   if (a->is_add)
1037     {
1038       if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1039         return rv;
1040
1041       /* Map worker api index to the app */
1042       app_wrk->api_client_index = a->api_client_index;
1043       application_api_table_add (app->app_index, a->api_client_index);
1044
1045       sm = segment_manager_get (app_wrk->connects_seg_manager);
1046       fs = segment_manager_get_segment_w_lock (sm, 0);
1047       a->segment = &fs->ssvm;
1048       a->segment_handle = segment_manager_segment_handle (sm, fs);
1049       segment_manager_segment_reader_unlock (sm);
1050       a->evt_q = app_wrk->event_queue;
1051       a->wrk_map_index = app_wrk->wrk_map_index;
1052     }
1053   else
1054     {
1055       wrk_map = app_worker_map_get (app, a->wrk_map_index);
1056       if (!wrk_map)
1057         return VNET_API_ERROR_INVALID_VALUE;
1058
1059       app_wrk = app_worker_get (wrk_map->wrk_index);
1060       if (!app_wrk)
1061         return VNET_API_ERROR_INVALID_VALUE;
1062
1063       application_api_table_del (app_wrk->api_client_index);
1064       if (appns_sapi_enabled ())
1065         sapi_socket_close_w_handle (app_wrk->api_client_index);
1066       app_worker_free (app_wrk);
1067       app_worker_map_free (app, wrk_map);
1068       if (application_n_workers (app) == 0)
1069         application_free (app);
1070     }
1071   return 0;
1072 }
1073
1074 static int
1075 app_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
1076 {
1077   app_namespace_t *app_ns;
1078   if (vec_len (namespace_id) == 0)
1079     {
1080       /* Use default namespace */
1081       *app_ns_index = 0;
1082       return 0;
1083     }
1084
1085   *app_ns_index = app_namespace_index_from_id (namespace_id);
1086   if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
1087     return VNET_API_ERROR_APP_INVALID_NS;
1088   app_ns = app_namespace_get (*app_ns_index);
1089   if (!app_ns)
1090     return VNET_API_ERROR_APP_INVALID_NS;
1091   if (app_ns->ns_secret != secret)
1092     return VNET_API_ERROR_APP_WRONG_NS_SECRET;
1093   return 0;
1094 }
1095
1096 static u8 *
1097 app_name_from_api_index (u32 api_client_index)
1098 {
1099   vl_api_registration_t *regp;
1100   regp = vl_api_client_index_to_registration (api_client_index);
1101   if (regp)
1102     return format (0, "%s", regp->name);
1103
1104   clib_warning ("api client index %u does not have an api registration!",
1105                 api_client_index);
1106   return format (0, "unknown");
1107 }
1108
1109 /**
1110  * Attach application to vpp
1111  *
1112  * Allocates a vpp app, i.e., a structure that keeps back pointers
1113  * to external app and a segment manager for shared memory fifo based
1114  * communication with the external app.
1115  */
1116 int
1117 vnet_application_attach (vnet_app_attach_args_t * a)
1118 {
1119   fifo_segment_t *fs;
1120   application_t *app = 0;
1121   app_worker_t *app_wrk;
1122   segment_manager_t *sm;
1123   u32 app_ns_index = 0;
1124   u8 *app_name = 0;
1125   u64 secret;
1126   int rv;
1127
1128   if (a->api_client_index != APP_INVALID_INDEX)
1129     app = application_lookup (a->api_client_index);
1130   else if (a->name)
1131     app = application_lookup_name (a->name);
1132   else
1133     return VNET_API_ERROR_INVALID_VALUE;
1134
1135   if (app)
1136     return VNET_API_ERROR_APP_ALREADY_ATTACHED;
1137
1138   /* Socket api sets the name and validates namespace prior to attach */
1139   if (!a->use_sock_api)
1140     {
1141       if (a->api_client_index != APP_INVALID_INDEX)
1142         {
1143           app_name = app_name_from_api_index (a->api_client_index);
1144           a->name = app_name;
1145         }
1146
1147       secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
1148       if ((rv = app_validate_namespace (a->namespace_id, secret,
1149                                         &app_ns_index)))
1150         return rv;
1151       a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
1152     }
1153
1154   if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
1155     return rv;
1156
1157   app = application_get (a->app_index);
1158   if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1159     return rv;
1160
1161   a->app_evt_q = app_wrk->event_queue;
1162   app_wrk->api_client_index = a->api_client_index;
1163   sm = segment_manager_get (app_wrk->connects_seg_manager);
1164   fs = segment_manager_get_segment_w_lock (sm, 0);
1165
1166   if (application_is_proxy (app))
1167     {
1168       application_setup_proxy (app);
1169       /* The segment manager pool is reallocated because a new listener
1170        * is added. Re-grab segment manager to avoid dangling reference */
1171       sm = segment_manager_get (app_wrk->connects_seg_manager);
1172     }
1173
1174   ASSERT (vec_len (fs->ssvm.name) <= 128);
1175   a->segment = &fs->ssvm;
1176   a->segment_handle = segment_manager_segment_handle (sm, fs);
1177
1178   segment_manager_segment_reader_unlock (sm);
1179
1180   if (!application_is_builtin (app) && application_use_private_rx_mqs ())
1181     rv = app_rx_mqs_alloc (app);
1182
1183   vec_free (app_name);
1184   return rv;
1185 }
1186
1187 /**
1188  * Detach application from vpp
1189  */
1190 int
1191 vnet_application_detach (vnet_app_detach_args_t * a)
1192 {
1193   application_t *app;
1194
1195   app = application_get_if_valid (a->app_index);
1196   if (!app)
1197     {
1198       clib_warning ("app not attached");
1199       return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1200     }
1201
1202   app_interface_check_thread_and_barrier (vnet_application_detach, a);
1203   application_detach_process (app, a->api_client_index);
1204   return 0;
1205 }
1206
1207
1208 static u8
1209 session_endpoint_in_ns (session_endpoint_t * sep)
1210 {
1211   u8 is_lep = session_endpoint_is_local (sep);
1212   if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
1213       && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
1214     {
1215       clib_warning ("sw_if_index %u not configured with ip %U",
1216                     sep->sw_if_index, format_ip46_address, &sep->ip,
1217                     sep->is_ip4);
1218       return 0;
1219     }
1220   return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
1221 }
1222
1223 static void
1224 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
1225                                  application_t * app, u8 is_connect)
1226 {
1227   app_namespace_t *app_ns;
1228   u32 ns_index, fib_index;
1229
1230   ns_index = app->ns_index;
1231
1232   /* App is a transport proto, so fetch the calling app's ns */
1233   if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
1234     ns_index = sep->ns_index;
1235
1236   app_ns = app_namespace_get (ns_index);
1237   if (!app_ns)
1238     return;
1239
1240   /* Ask transport and network to bind to/connect using local interface
1241    * that "supports" app's namespace. This will fix our local connection
1242    * endpoint.
1243    */
1244
1245   /* If in default namespace and user requested a fib index use it */
1246   if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
1247     fib_index = sep->fib_index;
1248   else
1249     fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
1250   sep->peer.fib_index = fib_index;
1251   sep->fib_index = fib_index;
1252
1253   if (!is_connect)
1254     {
1255       sep->sw_if_index = app_ns->sw_if_index;
1256     }
1257   else
1258     {
1259       if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
1260           && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
1261           && sep->peer.sw_if_index != app_ns->sw_if_index)
1262         clib_warning ("Local sw_if_index different from app ns sw_if_index");
1263
1264       sep->peer.sw_if_index = app_ns->sw_if_index;
1265     }
1266 }
1267
1268 int
1269 vnet_listen (vnet_listen_args_t * a)
1270 {
1271   app_listener_t *app_listener;
1272   app_worker_t *app_wrk;
1273   application_t *app;
1274   int rv;
1275
1276   ASSERT (vlib_thread_is_main_w_barrier ());
1277
1278   app = application_get_if_valid (a->app_index);
1279   if (!app)
1280     return SESSION_E_NOAPP;
1281
1282   app_wrk = application_get_worker (app, a->wrk_map_index);
1283   if (!app_wrk)
1284     return SESSION_E_INVALID_APPWRK;
1285
1286   a->sep_ext.app_wrk_index = app_wrk->wrk_index;
1287
1288   session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
1289   if (!session_endpoint_in_ns (&a->sep))
1290     return SESSION_E_INVALID_NS;
1291
1292   /*
1293    * Check if we already have an app listener
1294    */
1295   app_listener = app_listener_lookup (app, &a->sep_ext);
1296   if (app_listener)
1297     {
1298       if (app_listener->app_index != app->app_index)
1299         return SESSION_E_ALREADY_LISTENING;
1300       if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1301         return rv;
1302       a->handle = app_listener_handle (app_listener);
1303       return 0;
1304     }
1305
1306   /*
1307    * Create new app listener
1308    */
1309   if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
1310     return rv;
1311
1312   if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1313     {
1314       app_listener_cleanup (app_listener);
1315       return rv;
1316     }
1317
1318   a->handle = app_listener_handle (app_listener);
1319   return 0;
1320 }
1321
1322 int
1323 vnet_connect (vnet_connect_args_t * a)
1324 {
1325   app_worker_t *client_wrk;
1326   application_t *client;
1327
1328   ASSERT (vlib_thread_is_main_w_barrier ());
1329
1330   if (session_endpoint_is_zero (&a->sep))
1331     return SESSION_E_INVALID_RMT_IP;
1332
1333   client = application_get (a->app_index);
1334   session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1335   client_wrk = application_get_worker (client, a->wrk_map_index);
1336
1337   a->sep_ext.opaque = a->api_context;
1338
1339   /*
1340    * First check the local scope for locally attached destinations.
1341    * If we have local scope, we pass *all* connects through it since we may
1342    * have special policy rules even for non-local destinations, think proxy.
1343    */
1344   if (application_has_local_scope (client))
1345     {
1346       int rv;
1347
1348       a->sep_ext.original_tp = a->sep_ext.transport_proto;
1349       a->sep_ext.transport_proto = TRANSPORT_PROTO_NONE;
1350       rv = app_worker_connect_session (client_wrk, &a->sep_ext, &a->sh);
1351       a->sep_ext.transport_proto = a->sep_ext.original_tp;
1352       if (!rv || rv != SESSION_E_LOCAL_CONNECT)
1353         return rv;
1354     }
1355   /*
1356    * Not connecting to a local server, propagate to transport
1357    */
1358   return app_worker_connect_session (client_wrk, &a->sep_ext, &a->sh);
1359 }
1360
1361 int
1362 vnet_unlisten (vnet_unlisten_args_t * a)
1363 {
1364   app_worker_t *app_wrk;
1365   app_listener_t *al;
1366   application_t *app;
1367
1368   ASSERT (vlib_thread_is_main_w_barrier ());
1369
1370   if (!(app = application_get_if_valid (a->app_index)))
1371     return SESSION_E_NOAPP;
1372
1373   if (!(al = app_listener_get_w_handle (a->handle)))
1374     return SESSION_E_NOLISTEN;
1375
1376   if (al->app_index != app->app_index)
1377     {
1378       clib_warning ("app doesn't own handle %llu!", a->handle);
1379       return SESSION_E_OWNER;
1380     }
1381
1382   app_wrk = application_get_worker (app, a->wrk_map_index);
1383   if (!app_wrk)
1384     {
1385       clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1386       return SESSION_E_INVALID_APPWRK;
1387     }
1388
1389   return app_worker_stop_listen (app_wrk, al);
1390 }
1391
1392 int
1393 vnet_shutdown_session (vnet_shutdown_args_t *a)
1394 {
1395   app_worker_t *app_wrk;
1396   session_t *s;
1397
1398   s = session_get_from_handle_if_valid (a->handle);
1399   if (!s)
1400     return SESSION_E_NOSESSION;
1401
1402   app_wrk = app_worker_get (s->app_wrk_index);
1403   if (app_wrk->app_index != a->app_index)
1404     return SESSION_E_OWNER;
1405
1406   /* We're peeking into another's thread pool. Make sure */
1407   ASSERT (s->session_index == session_index_from_handle (a->handle));
1408
1409   session_half_close (s);
1410   return 0;
1411 }
1412
1413 int
1414 vnet_disconnect_session (vnet_disconnect_args_t * a)
1415 {
1416   app_worker_t *app_wrk;
1417   session_t *s;
1418
1419   s = session_get_from_handle_if_valid (a->handle);
1420   if (!s)
1421     return SESSION_E_NOSESSION;
1422
1423   app_wrk = app_worker_get (s->app_wrk_index);
1424   if (app_wrk->app_index != a->app_index)
1425     return SESSION_E_OWNER;
1426
1427   /* We're peeking into another's thread pool. Make sure */
1428   ASSERT (s->session_index == session_index_from_handle (a->handle));
1429
1430   session_close (s);
1431   return 0;
1432 }
1433
1434 int
1435 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1436 {
1437   app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1438   app_listener_t *app_listener;
1439   application_t *app;
1440   int rv;
1441
1442   if (!old_wrk)
1443     return SESSION_E_INVALID_APPWRK;
1444
1445   hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1446   if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1447       && s->rx_fifo)
1448     segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1449
1450   app = application_get (old_wrk->app_index);
1451   if (!app)
1452     return SESSION_E_NOAPP;
1453
1454   app_listener = app_listener_get (app, s->al_index);
1455
1456   /* Only remove from lb for now */
1457   app_listener->workers = clib_bitmap_set (app_listener->workers,
1458                                            old_wrk->wrk_map_index, 0);
1459
1460   if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1461     return rv;
1462
1463   s->app_wrk_index = app_wrk->wrk_index;
1464
1465   return 0;
1466 }
1467
1468 int
1469 application_is_proxy (application_t * app)
1470 {
1471   return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1472 }
1473
1474 int
1475 application_is_builtin (application_t * app)
1476 {
1477   return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1478 }
1479
1480 int
1481 application_is_builtin_proxy (application_t * app)
1482 {
1483   return (application_is_proxy (app) && application_is_builtin (app));
1484 }
1485
1486 u8
1487 application_has_local_scope (application_t * app)
1488 {
1489   return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1490 }
1491
1492 u8
1493 application_has_global_scope (application_t * app)
1494 {
1495   return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1496 }
1497
1498 static clib_error_t *
1499 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1500                                         u8 transport_proto, u8 is_start)
1501 {
1502   app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1503   u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1504   session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1505   transport_connection_t *tc;
1506   app_worker_t *app_wrk;
1507   app_listener_t *al;
1508   session_t *s;
1509   u32 flags;
1510
1511   /* TODO decide if we want proxy to be enabled for all workers */
1512   app_wrk = application_get_default_worker (app);
1513   if (is_start)
1514     {
1515       s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1516       if (!s)
1517         {
1518           sep.is_ip4 = is_ip4;
1519           sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1520           sep.sw_if_index = app_ns->sw_if_index;
1521           sep.transport_proto = transport_proto;
1522           sep.app_wrk_index = app_wrk->wrk_index;       /* only default */
1523
1524           /* force global scope listener */
1525           flags = app->flags;
1526           app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1527           app_listener_alloc_and_init (app, &sep, &al);
1528           app->flags = flags;
1529
1530           app_worker_start_listen (app_wrk, al);
1531           s = listen_session_get (al->session_index);
1532           s->flags |= SESSION_F_PROXY;
1533         }
1534     }
1535   else
1536     {
1537       s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1538       ASSERT (s);
1539     }
1540
1541   tc = listen_session_get_transport (s);
1542
1543   if (!ip_is_zero (&tc->lcl_ip, 1))
1544     {
1545       u32 sti;
1546       sep.is_ip4 = is_ip4;
1547       sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1548       sep.transport_proto = transport_proto;
1549       sep.port = 0;
1550       sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1551       if (is_start)
1552         session_lookup_add_session_endpoint (sti,
1553                                              (session_endpoint_t *) & sep,
1554                                              s->session_index);
1555       else
1556         session_lookup_del_session_endpoint (sti,
1557                                              (session_endpoint_t *) & sep);
1558     }
1559
1560   return 0;
1561 }
1562
1563 static void
1564 application_start_stop_proxy_local_scope (application_t * app,
1565                                           u8 transport_proto, u8 is_start)
1566 {
1567   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1568   app_namespace_t *app_ns;
1569   app_ns = app_namespace_get (app->ns_index);
1570   sep.is_ip4 = 1;
1571   sep.transport_proto = transport_proto;
1572   sep.port = 0;
1573
1574   if (is_start)
1575     {
1576       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1577                                            app->app_index);
1578       sep.is_ip4 = 0;
1579       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1580                                            app->app_index);
1581     }
1582   else
1583     {
1584       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1585       sep.is_ip4 = 0;
1586       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1587     }
1588 }
1589
1590 void
1591 application_start_stop_proxy (application_t * app,
1592                               transport_proto_t transport_proto, u8 is_start)
1593 {
1594   if (application_has_local_scope (app))
1595     application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1596
1597   if (application_has_global_scope (app))
1598     {
1599       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1600                                               transport_proto, is_start);
1601       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1602                                               transport_proto, is_start);
1603     }
1604 }
1605
1606 void
1607 application_setup_proxy (application_t * app)
1608 {
1609   u16 transports = app->proxied_transports;
1610   transport_proto_t tp;
1611
1612   ASSERT (application_is_proxy (app));
1613
1614   /* *INDENT-OFF* */
1615   transport_proto_foreach (tp, ({
1616     if (transports & (1 << tp))
1617       application_start_stop_proxy (app, tp, 1);
1618   }));
1619   /* *INDENT-ON* */
1620 }
1621
1622 void
1623 application_remove_proxy (application_t * app)
1624 {
1625   u16 transports = app->proxied_transports;
1626   transport_proto_t tp;
1627
1628   ASSERT (application_is_proxy (app));
1629
1630   /* *INDENT-OFF* */
1631   transport_proto_foreach (tp, ({
1632     if (transports & (1 << tp))
1633       application_start_stop_proxy (app, tp, 0);
1634   }));
1635   /* *INDENT-ON* */
1636 }
1637
1638 segment_manager_props_t *
1639 application_segment_manager_properties (application_t * app)
1640 {
1641   return &app->sm_properties;
1642 }
1643
1644 segment_manager_props_t *
1645 application_get_segment_manager_properties (u32 app_index)
1646 {
1647   application_t *app = application_get (app_index);
1648   return &app->sm_properties;
1649 }
1650
1651 static void
1652 application_format_listeners (application_t * app, int verbose)
1653 {
1654   vlib_main_t *vm = vlib_get_main ();
1655   app_worker_map_t *wrk_map;
1656   app_worker_t *app_wrk;
1657   u32 sm_index;
1658   u64 handle;
1659
1660   if (!app)
1661     {
1662       vlib_cli_output (vm, "%U", format_app_worker_listener, 0 /* header */ ,
1663                        0, 0, verbose);
1664       return;
1665     }
1666
1667   /* *INDENT-OFF* */
1668   pool_foreach (wrk_map, app->worker_maps)  {
1669     app_wrk = app_worker_get (wrk_map->wrk_index);
1670     if (hash_elts (app_wrk->listeners_table) == 0)
1671       continue;
1672     hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1673       vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1674                        handle, sm_index, verbose);
1675     }));
1676   }
1677   /* *INDENT-ON* */
1678 }
1679
1680 static void
1681 application_format_connects (application_t * app, int verbose)
1682 {
1683   app_worker_map_t *wrk_map;
1684   app_worker_t *app_wrk;
1685
1686   if (!app)
1687     {
1688       app_worker_format_connects (0, verbose);
1689       return;
1690     }
1691
1692   /* *INDENT-OFF* */
1693   pool_foreach (wrk_map, app->worker_maps)  {
1694     app_wrk = app_worker_get (wrk_map->wrk_index);
1695     app_worker_format_connects (app_wrk, verbose);
1696   }
1697   /* *INDENT-ON* */
1698 }
1699
1700 u8 *
1701 format_cert_key_pair (u8 * s, va_list * args)
1702 {
1703   app_cert_key_pair_t *ckpair = va_arg (*args, app_cert_key_pair_t *);
1704   int key_len = 0, cert_len = 0;
1705   cert_len = vec_len (ckpair->cert);
1706   key_len = vec_len (ckpair->key);
1707   if (ckpair->cert_key_index == 0)
1708     s = format (s, "DEFAULT (cert:%d, key:%d)", cert_len, key_len);
1709   else
1710     s = format (s, "%d (cert:%d, key:%d)", ckpair->cert_key_index,
1711                 cert_len, key_len);
1712   return s;
1713 }
1714
1715 u8 *
1716 format_crypto_engine (u8 * s, va_list * args)
1717 {
1718   u32 engine = va_arg (*args, u32);
1719   switch (engine)
1720     {
1721     case CRYPTO_ENGINE_NONE:
1722       return format (s, "none");
1723     case CRYPTO_ENGINE_MBEDTLS:
1724       return format (s, "mbedtls");
1725     case CRYPTO_ENGINE_OPENSSL:
1726       return format (s, "openssl");
1727     case CRYPTO_ENGINE_PICOTLS:
1728       return format (s, "picotls");
1729     case CRYPTO_ENGINE_VPP:
1730       return format (s, "vpp");
1731     default:
1732       return format (s, "unknown engine");
1733     }
1734   return s;
1735 }
1736
1737 uword
1738 unformat_crypto_engine (unformat_input_t * input, va_list * args)
1739 {
1740   u8 *a = va_arg (*args, u8 *);
1741   if (unformat (input, "mbedtls"))
1742     *a = CRYPTO_ENGINE_MBEDTLS;
1743   else if (unformat (input, "openssl"))
1744     *a = CRYPTO_ENGINE_OPENSSL;
1745   else if (unformat (input, "picotls"))
1746     *a = CRYPTO_ENGINE_PICOTLS;
1747   else if (unformat (input, "vpp"))
1748     *a = CRYPTO_ENGINE_VPP;
1749   else
1750     return 0;
1751   return 1;
1752 }
1753
1754 u8 *
1755 format_crypto_context (u8 * s, va_list * args)
1756 {
1757   crypto_context_t *crctx = va_arg (*args, crypto_context_t *);
1758   s = format (s, "[0x%x][sub%d,ckpair%x]", crctx->ctx_index,
1759               crctx->n_subscribers, crctx->ckpair_index);
1760   s = format (s, "[%U]", format_crypto_engine, crctx->crypto_engine);
1761   return s;
1762 }
1763
1764 u8 *
1765 format_application (u8 * s, va_list * args)
1766 {
1767   application_t *app = va_arg (*args, application_t *);
1768   CLIB_UNUSED (int verbose) = va_arg (*args, int);
1769   segment_manager_props_t *props;
1770   const u8 *app_ns_name, *app_name;
1771   app_worker_map_t *wrk_map;
1772   app_worker_t *app_wrk;
1773
1774   if (app == 0)
1775     {
1776       if (!verbose)
1777         s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1778       return s;
1779     }
1780
1781   app_name = app_get_name (app);
1782   app_ns_name = app_namespace_id_from_index (app->ns_index);
1783   props = application_segment_manager_properties (app);
1784   if (!verbose)
1785     {
1786       s = format (s, "%-10u%-20v%-40v", app->app_index, app_name,
1787                   app_ns_name);
1788       return s;
1789     }
1790
1791   s = format (s, "app-name %v app-index %u ns-index %u seg-size %U\n",
1792               app_name, app->app_index, app->ns_index,
1793               format_memory_size, props->add_segment_size);
1794   s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1795               format_memory_size, props->rx_fifo_size,
1796               format_memory_size, props->tx_fifo_size);
1797
1798   /* *INDENT-OFF* */
1799   pool_foreach (wrk_map, app->worker_maps)  {
1800       app_wrk = app_worker_get (wrk_map->wrk_index);
1801       s = format (s, "%U", format_app_worker, app_wrk);
1802   }
1803   /* *INDENT-ON* */
1804
1805   return s;
1806 }
1807
1808 void
1809 application_format_all_listeners (vlib_main_t * vm, int verbose)
1810 {
1811   application_t *app;
1812
1813   if (!pool_elts (app_main.app_pool))
1814     {
1815       vlib_cli_output (vm, "No active server bindings");
1816       return;
1817     }
1818
1819   application_format_listeners (0, verbose);
1820
1821   /* *INDENT-OFF* */
1822   pool_foreach (app, app_main.app_pool)  {
1823     application_format_listeners (app, verbose);
1824   }
1825   /* *INDENT-ON* */
1826 }
1827
1828 void
1829 application_format_all_clients (vlib_main_t * vm, int verbose)
1830 {
1831   application_t *app;
1832
1833   if (!pool_elts (app_main.app_pool))
1834     {
1835       vlib_cli_output (vm, "No active apps");
1836       return;
1837     }
1838
1839   application_format_connects (0, verbose);
1840
1841   /* *INDENT-OFF* */
1842   pool_foreach (app, app_main.app_pool)  {
1843     application_format_connects (app, verbose);
1844   }
1845   /* *INDENT-ON* */
1846 }
1847
1848 static clib_error_t *
1849 show_certificate_command_fn (vlib_main_t * vm, unformat_input_t * input,
1850                              vlib_cli_command_t * cmd)
1851 {
1852   app_cert_key_pair_t *ckpair;
1853   session_cli_return_if_not_enabled ();
1854
1855   /* *INDENT-OFF* */
1856   pool_foreach (ckpair, app_main.cert_key_pair_store)  {
1857     vlib_cli_output (vm, "%U", format_cert_key_pair, ckpair);
1858   }
1859   /* *INDENT-ON* */
1860   return 0;
1861 }
1862
1863 static inline void
1864 appliction_format_app_mq (vlib_main_t * vm, application_t * app)
1865 {
1866   app_worker_map_t *map;
1867   app_worker_t *wrk;
1868   int i;
1869
1870   /* *INDENT-OFF* */
1871   pool_foreach (map, app->worker_maps)  {
1872     wrk = app_worker_get (map->wrk_index);
1873     vlib_cli_output (vm, "[A%d][%d]%U", app->app_index,
1874                      map->wrk_index, format_svm_msg_q,
1875                      wrk->event_queue);
1876   }
1877   /* *INDENT-ON* */
1878
1879   for (i = 0; i < vec_len (app->rx_mqs); i++)
1880     vlib_cli_output (vm, "[A%d][R%d]%U", app->app_index, i, format_svm_msg_q,
1881                      app->rx_mqs[i].mq);
1882 }
1883
1884 static clib_error_t *
1885 appliction_format_all_app_mq (vlib_main_t * vm)
1886 {
1887   application_t *app;
1888   int i, n_threads;
1889
1890   n_threads = vlib_get_n_threads ();
1891
1892   for (i = 0; i < n_threads; i++)
1893     {
1894       vlib_cli_output (vm, "[Ctrl%d]%U", i, format_svm_msg_q,
1895                        session_main_get_vpp_event_queue (i));
1896     }
1897
1898   /* *INDENT-OFF* */
1899   pool_foreach (app, app_main.app_pool)  {
1900       appliction_format_app_mq (vm, app);
1901   }
1902   /* *INDENT-ON* */
1903   return 0;
1904 }
1905
1906 static clib_error_t *
1907 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1908                      vlib_cli_command_t * cmd)
1909 {
1910   int do_server = 0, do_client = 0, do_mq = 0;
1911   application_t *app;
1912   u32 app_index = ~0;
1913   int verbose = 0;
1914
1915   session_cli_return_if_not_enabled ();
1916
1917   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1918     {
1919       if (unformat (input, "server"))
1920         do_server = 1;
1921       else if (unformat (input, "client"))
1922         do_client = 1;
1923       else if (unformat (input, "mq"))
1924         do_mq = 1;
1925       else if (unformat (input, "%u", &app_index))
1926         ;
1927       else if (unformat (input, "verbose"))
1928         verbose = 1;
1929       else
1930         return clib_error_return (0, "unknown input `%U'",
1931                                   format_unformat_error, input);
1932     }
1933
1934   if (do_mq && app_index != ~0)
1935     {
1936       app = application_get_if_valid (app_index);
1937       if (!app)
1938         return clib_error_return (0, "No app with index %u", app_index);
1939
1940       appliction_format_app_mq (vm, app);
1941       return 0;
1942     }
1943
1944   if (do_mq)
1945     {
1946       appliction_format_all_app_mq (vm);
1947       return 0;
1948     }
1949
1950   if (do_server)
1951     {
1952       application_format_all_listeners (vm, verbose);
1953       return 0;
1954     }
1955
1956   if (do_client)
1957     {
1958       application_format_all_clients (vm, verbose);
1959       return 0;
1960     }
1961
1962   if (app_index != ~0)
1963     {
1964       app = application_get_if_valid (app_index);
1965       if (!app)
1966         return clib_error_return (0, "No app with index %u", app_index);
1967
1968       vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
1969       return 0;
1970     }
1971
1972   /* Print app related info */
1973   if (!do_server && !do_client)
1974     {
1975       vlib_cli_output (vm, "%U", format_application, 0, 0);
1976       /* *INDENT-OFF* */
1977       pool_foreach (app, app_main.app_pool)  {
1978         vlib_cli_output (vm, "%U", format_application, app, 0);
1979       }
1980       /* *INDENT-ON* */
1981     }
1982
1983   return 0;
1984 }
1985
1986 /* Certificate store */
1987
1988 static app_cert_key_pair_t *
1989 app_cert_key_pair_alloc ()
1990 {
1991   app_cert_key_pair_t *ckpair;
1992   pool_get (app_main.cert_key_pair_store, ckpair);
1993   clib_memset (ckpair, 0, sizeof (*ckpair));
1994   ckpair->cert_key_index = ckpair - app_main.cert_key_pair_store;
1995   return ckpair;
1996 }
1997
1998 app_cert_key_pair_t *
1999 app_cert_key_pair_get_if_valid (u32 index)
2000 {
2001   if (pool_is_free_index (app_main.cert_key_pair_store, index))
2002     return 0;
2003   return app_cert_key_pair_get (index);
2004 }
2005
2006 app_cert_key_pair_t *
2007 app_cert_key_pair_get (u32 index)
2008 {
2009   return pool_elt_at_index (app_main.cert_key_pair_store, index);
2010 }
2011
2012 app_cert_key_pair_t *
2013 app_cert_key_pair_get_default ()
2014 {
2015   /* To maintain legacy bapi */
2016   return app_cert_key_pair_get (0);
2017 }
2018
2019 int
2020 vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a)
2021 {
2022   app_cert_key_pair_t *ckpair = app_cert_key_pair_alloc ();
2023   vec_validate (ckpair->cert, a->cert_len - 1);
2024   clib_memcpy_fast (ckpair->cert, a->cert, a->cert_len);
2025   vec_validate (ckpair->key, a->key_len - 1);
2026   clib_memcpy_fast (ckpair->key, a->key, a->key_len);
2027   a->index = ckpair->cert_key_index;
2028   return 0;
2029 }
2030
2031 int
2032 vnet_app_add_cert_key_interest (u32 index, u32 app_index)
2033 {
2034   app_cert_key_pair_t *ckpair;
2035   if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
2036     return -1;
2037   if (vec_search (ckpair->app_interests, app_index) != ~0)
2038     vec_add1 (ckpair->app_interests, app_index);
2039   return 0;
2040 }
2041
2042 int
2043 vnet_app_del_cert_key_pair (u32 index)
2044 {
2045   app_cert_key_pair_t *ckpair;
2046   application_t *app;
2047   u32 *app_index;
2048
2049   if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
2050     return (VNET_API_ERROR_INVALID_VALUE);
2051
2052   vec_foreach (app_index, ckpair->app_interests)
2053   {
2054     if ((app = application_get_if_valid (*app_index))
2055         && app->cb_fns.app_cert_key_pair_delete_callback)
2056       app->cb_fns.app_cert_key_pair_delete_callback (ckpair);
2057   }
2058
2059   vec_free (ckpair->cert);
2060   vec_free (ckpair->key);
2061   pool_put (app_main.cert_key_pair_store, ckpair);
2062   return 0;
2063 }
2064
2065 clib_error_t *
2066 application_init (vlib_main_t * vm)
2067 {
2068   app_main_t *am = &app_main;
2069   u32 n_workers;
2070
2071   n_workers = vlib_num_workers ();
2072
2073   /* Index 0 was originally used by legacy apis, maintain as invalid */
2074   (void) app_cert_key_pair_alloc ();
2075   am->last_crypto_engine = CRYPTO_ENGINE_LAST;
2076   am->app_by_name = hash_create_vec (0, sizeof (u8), sizeof (uword));
2077
2078   vec_validate (am->wrk, n_workers);
2079
2080   return 0;
2081 }
2082
2083 /* *INDENT-OFF* */
2084 VLIB_INIT_FUNCTION (application_init);
2085
2086 VLIB_CLI_COMMAND (show_app_command, static) =
2087 {
2088   .path = "show app",
2089   .short_help = "show app [app_id] [server|client] [mq] [verbose]",
2090   .function = show_app_command_fn,
2091 };
2092
2093 VLIB_CLI_COMMAND (show_certificate_command, static) =
2094 {
2095   .path = "show app certificate",
2096   .short_help = "list app certs and keys present in store",
2097   .function = show_certificate_command_fn,
2098 };
2099 /* *INDENT-ON* */
2100
2101 crypto_engine_type_t
2102 app_crypto_engine_type_add (void)
2103 {
2104   return (++app_main.last_crypto_engine);
2105 }
2106
2107 u8
2108 app_crypto_engine_n_types (void)
2109 {
2110   return (app_main.last_crypto_engine + 1);
2111 }
2112
2113 /*
2114  * fd.io coding-style-patch-verification: ON
2115  *
2116  * Local Variables:
2117  * eval: (c-set-style "gnu")
2118  * End:
2119  */