8abec7797ecb6635818aee1e5be05c1d3d098841
[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           table_index = session_lookup_get_index_for_fib (fib_proto,
245                                                           sep->fib_index);
246           ASSERT (table_index != SESSION_TABLE_INVALID_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 *options;
773
774   app = application_alloc ();
775   options = a->options;
776   /*
777    * Make sure we support the requested configuration
778    */
779   if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN)
780     seg_type = SSVM_SEGMENT_PRIVATE;
781
782   if ((options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
783       && seg_type != SSVM_SEGMENT_MEMFD)
784     {
785       clib_warning ("mq eventfds can only be used if socket transport is "
786                     "used for binary api");
787       return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
788     }
789
790   if (!application_verify_cfg (seg_type))
791     return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
792
793   if (options[APP_OPTIONS_PREALLOC_FIFO_PAIRS]
794       && options[APP_OPTIONS_PREALLOC_FIFO_HDRS])
795     return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
796
797   /* Check that the obvious things are properly set up */
798   application_verify_cb_fns (a->session_cb_vft);
799
800   app->flags = options[APP_OPTIONS_FLAGS];
801   app->cb_fns = *a->session_cb_vft;
802   app->ns_index = options[APP_OPTIONS_NAMESPACE];
803   app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
804   app->name = vec_dup (a->name);
805
806   /* If no scope enabled, default to global */
807   if (!application_has_global_scope (app)
808       && !application_has_local_scope (app))
809     app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
810
811   props = application_segment_manager_properties (app);
812   segment_manager_props_init (props);
813   props->segment_size = options[APP_OPTIONS_SEGMENT_SIZE];
814   props->prealloc_fifos = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
815   props->prealloc_fifo_hdrs = options[APP_OPTIONS_PREALLOC_FIFO_HDRS];
816   if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
817     {
818       props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
819       props->add_segment = 1;
820     }
821   if (options[APP_OPTIONS_RX_FIFO_SIZE])
822     props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
823   if (options[APP_OPTIONS_TX_FIFO_SIZE])
824     props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
825   if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
826     props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
827   if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
828     props->use_mq_eventfd = 1;
829   if (options[APP_OPTIONS_TLS_ENGINE])
830     app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
831   if (options[APP_OPTIONS_MAX_FIFO_SIZE])
832     props->max_fifo_size = options[APP_OPTIONS_MAX_FIFO_SIZE];
833   if (options[APP_OPTIONS_HIGH_WATERMARK])
834     props->high_watermark = options[APP_OPTIONS_HIGH_WATERMARK];
835   if (options[APP_OPTIONS_LOW_WATERMARK])
836     props->low_watermark = options[APP_OPTIONS_LOW_WATERMARK];
837   if (options[APP_OPTIONS_PCT_FIRST_ALLOC])
838     props->pct_first_alloc = options[APP_OPTIONS_PCT_FIRST_ALLOC];
839   props->segment_type = seg_type;
840
841   /* Add app to lookup by api_client_index table */
842   if (!application_is_builtin (app))
843     application_api_table_add (app->app_index, a->api_client_index);
844   else
845     application_name_table_add (app);
846
847   a->app_index = app->app_index;
848
849   APP_DBG ("New app name: %v api index: %u index %u", app->name,
850            a->api_client_index, app->app_index);
851
852   return 0;
853 }
854
855 static void
856 application_free (application_t * app)
857 {
858   app_worker_map_t *wrk_map;
859   app_worker_t *app_wrk;
860
861   /*
862    * The app event queue allocated in first segment is cleared with
863    * the segment manager. No need to explicitly free it.
864    */
865   APP_DBG ("Delete app name %v index: %d", app->name, app->app_index);
866
867   if (application_is_proxy (app))
868     application_remove_proxy (app);
869
870   /*
871    * Free workers
872    */
873
874   /* *INDENT-OFF* */
875   pool_flush (wrk_map, app->worker_maps, ({
876     app_wrk = app_worker_get (wrk_map->wrk_index);
877     app_worker_free (app_wrk);
878   }));
879   /* *INDENT-ON* */
880   pool_free (app->worker_maps);
881
882   /*
883    * Free rx mqs if allocated
884    */
885   if (app->rx_mqs)
886     {
887       int i;
888       for (i = 0; i < vec_len (app->rx_mqs); i++)
889         app_rx_mqs_epoll_del (app, &app->rx_mqs[i]);
890
891       fifo_segment_cleanup (&app->rx_mqs_segment);
892       ssvm_delete (&app->rx_mqs_segment.ssvm);
893       vec_free (app->rx_mqs);
894     }
895
896   /*
897    * Cleanup remaining state
898    */
899   if (application_is_builtin (app))
900     application_name_table_del (app);
901   vec_free (app->name);
902   pool_put (app_main.app_pool, app);
903 }
904
905 static void
906 application_detach_process (application_t * app, u32 api_client_index)
907 {
908   vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
909   app_worker_map_t *wrk_map;
910   u32 *wrks = 0, *wrk_index;
911   app_worker_t *app_wrk;
912
913   if (api_client_index == ~0)
914     {
915       application_free (app);
916       return;
917     }
918
919   APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
920            app->app_index, api_client_index);
921
922   /* *INDENT-OFF* */
923   pool_foreach (wrk_map, app->worker_maps)  {
924     app_wrk = app_worker_get (wrk_map->wrk_index);
925     if (app_wrk->api_client_index == api_client_index)
926       vec_add1 (wrks, app_wrk->wrk_index);
927   }
928   /* *INDENT-ON* */
929
930   if (!vec_len (wrks))
931     {
932       clib_warning ("no workers for app %u api_index %u", app->app_index,
933                     api_client_index);
934       return;
935     }
936
937   args->app_index = app->app_index;
938   args->api_client_index = api_client_index;
939   vec_foreach (wrk_index, wrks)
940   {
941     app_wrk = app_worker_get (wrk_index[0]);
942     args->wrk_map_index = app_wrk->wrk_map_index;
943     args->is_add = 0;
944     vnet_app_worker_add_del (args);
945   }
946   vec_free (wrks);
947 }
948
949 app_worker_t *
950 application_get_worker (application_t * app, u32 wrk_map_index)
951 {
952   app_worker_map_t *map;
953   map = app_worker_map_get (app, wrk_map_index);
954   if (!map)
955     return 0;
956   return app_worker_get (map->wrk_index);
957 }
958
959 app_worker_t *
960 application_get_default_worker (application_t * app)
961 {
962   return application_get_worker (app, 0);
963 }
964
965 u32
966 application_n_workers (application_t * app)
967 {
968   return pool_elts (app->worker_maps);
969 }
970
971 app_worker_t *
972 application_listener_select_worker (session_t * ls)
973 {
974   application_t *app;
975   app_listener_t *al;
976
977   app = application_get (ls->app_index);
978   al = app_listener_get (app, ls->al_index);
979   return app_listener_select_worker (app, al);
980 }
981
982 int
983 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
984 {
985   app_worker_map_t *wrk_map;
986   app_worker_t *app_wrk;
987   segment_manager_t *sm;
988   int rv;
989
990   app_wrk = app_worker_alloc (app);
991   wrk_map = app_worker_map_alloc (app);
992   wrk_map->wrk_index = app_wrk->wrk_index;
993   app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
994
995   /*
996    * Setup first segment manager
997    */
998   sm = segment_manager_alloc ();
999   sm->app_wrk_index = app_wrk->wrk_index;
1000
1001   if ((rv = segment_manager_init_first (sm)))
1002     {
1003       app_worker_free (app_wrk);
1004       return rv;
1005     }
1006   sm->first_is_protected = 1;
1007
1008   /*
1009    * Setup app worker
1010    */
1011   app_wrk->connects_seg_manager = segment_manager_index (sm);
1012   app_wrk->listeners_table = hash_create (0, sizeof (u64));
1013   app_wrk->event_queue = segment_manager_event_queue (sm);
1014   app_wrk->app_is_builtin = application_is_builtin (app);
1015
1016   *wrk = app_wrk;
1017
1018   return 0;
1019 }
1020
1021 int
1022 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
1023 {
1024   fifo_segment_t *fs;
1025   app_worker_map_t *wrk_map;
1026   app_worker_t *app_wrk;
1027   segment_manager_t *sm;
1028   application_t *app;
1029   int rv;
1030
1031   app = application_get (a->app_index);
1032   if (!app)
1033     return VNET_API_ERROR_INVALID_VALUE;
1034
1035   if (a->is_add)
1036     {
1037       if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1038         return rv;
1039
1040       /* Map worker api index to the app */
1041       app_wrk->api_client_index = a->api_client_index;
1042       application_api_table_add (app->app_index, a->api_client_index);
1043
1044       sm = segment_manager_get (app_wrk->connects_seg_manager);
1045       fs = segment_manager_get_segment_w_lock (sm, 0);
1046       a->segment = &fs->ssvm;
1047       a->segment_handle = segment_manager_segment_handle (sm, fs);
1048       segment_manager_segment_reader_unlock (sm);
1049       a->evt_q = app_wrk->event_queue;
1050       a->wrk_map_index = app_wrk->wrk_map_index;
1051     }
1052   else
1053     {
1054       wrk_map = app_worker_map_get (app, a->wrk_map_index);
1055       if (!wrk_map)
1056         return VNET_API_ERROR_INVALID_VALUE;
1057
1058       app_wrk = app_worker_get (wrk_map->wrk_index);
1059       if (!app_wrk)
1060         return VNET_API_ERROR_INVALID_VALUE;
1061
1062       application_api_table_del (app_wrk->api_client_index);
1063       app_worker_free (app_wrk);
1064       app_worker_map_free (app, wrk_map);
1065       if (application_n_workers (app) == 0)
1066         application_free (app);
1067     }
1068   return 0;
1069 }
1070
1071 static int
1072 app_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
1073 {
1074   app_namespace_t *app_ns;
1075   if (vec_len (namespace_id) == 0)
1076     {
1077       /* Use default namespace */
1078       *app_ns_index = 0;
1079       return 0;
1080     }
1081
1082   *app_ns_index = app_namespace_index_from_id (namespace_id);
1083   if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
1084     return VNET_API_ERROR_APP_INVALID_NS;
1085   app_ns = app_namespace_get (*app_ns_index);
1086   if (!app_ns)
1087     return VNET_API_ERROR_APP_INVALID_NS;
1088   if (app_ns->ns_secret != secret)
1089     return VNET_API_ERROR_APP_WRONG_NS_SECRET;
1090   return 0;
1091 }
1092
1093 static u8 *
1094 app_name_from_api_index (u32 api_client_index)
1095 {
1096   vl_api_registration_t *regp;
1097   regp = vl_api_client_index_to_registration (api_client_index);
1098   if (regp)
1099     return format (0, "%s", regp->name);
1100
1101   clib_warning ("api client index %u does not have an api registration!",
1102                 api_client_index);
1103   return format (0, "unknown");
1104 }
1105
1106 /**
1107  * Attach application to vpp
1108  *
1109  * Allocates a vpp app, i.e., a structure that keeps back pointers
1110  * to external app and a segment manager for shared memory fifo based
1111  * communication with the external app.
1112  */
1113 int
1114 vnet_application_attach (vnet_app_attach_args_t * a)
1115 {
1116   fifo_segment_t *fs;
1117   application_t *app = 0;
1118   app_worker_t *app_wrk;
1119   segment_manager_t *sm;
1120   u32 app_ns_index = 0;
1121   u8 *app_name = 0;
1122   u64 secret;
1123   int rv;
1124
1125   if (a->api_client_index != APP_INVALID_INDEX)
1126     app = application_lookup (a->api_client_index);
1127   else if (a->name)
1128     app = application_lookup_name (a->name);
1129   else
1130     return VNET_API_ERROR_INVALID_VALUE;
1131
1132   if (app)
1133     return VNET_API_ERROR_APP_ALREADY_ATTACHED;
1134
1135   /* Socket api sets the name and validates namespace prior to attach */
1136   if (!a->use_sock_api)
1137     {
1138       if (a->api_client_index != APP_INVALID_INDEX)
1139         {
1140           app_name = app_name_from_api_index (a->api_client_index);
1141           a->name = app_name;
1142         }
1143
1144       secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
1145       if ((rv = app_validate_namespace (a->namespace_id, secret,
1146                                         &app_ns_index)))
1147         return rv;
1148       a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
1149     }
1150
1151   if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
1152     return rv;
1153
1154   app = application_get (a->app_index);
1155   if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1156     return rv;
1157
1158   a->app_evt_q = app_wrk->event_queue;
1159   app_wrk->api_client_index = a->api_client_index;
1160   sm = segment_manager_get (app_wrk->connects_seg_manager);
1161   fs = segment_manager_get_segment_w_lock (sm, 0);
1162
1163   if (application_is_proxy (app))
1164     {
1165       application_setup_proxy (app);
1166       /* The segment manager pool is reallocated because a new listener
1167        * is added. Re-grab segment manager to avoid dangling reference */
1168       sm = segment_manager_get (app_wrk->connects_seg_manager);
1169     }
1170
1171   ASSERT (vec_len (fs->ssvm.name) <= 128);
1172   a->segment = &fs->ssvm;
1173   a->segment_handle = segment_manager_segment_handle (sm, fs);
1174
1175   segment_manager_segment_reader_unlock (sm);
1176
1177   if (!application_is_builtin (app) && application_use_private_rx_mqs ())
1178     rv = app_rx_mqs_alloc (app);
1179
1180   vec_free (app_name);
1181   return rv;
1182 }
1183
1184 /**
1185  * Detach application from vpp
1186  */
1187 int
1188 vnet_application_detach (vnet_app_detach_args_t * a)
1189 {
1190   application_t *app;
1191
1192   app = application_get_if_valid (a->app_index);
1193   if (!app)
1194     {
1195       clib_warning ("app not attached");
1196       return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1197     }
1198
1199   app_interface_check_thread_and_barrier (vnet_application_detach, a);
1200   application_detach_process (app, a->api_client_index);
1201   return 0;
1202 }
1203
1204
1205 static u8
1206 session_endpoint_in_ns (session_endpoint_t * sep)
1207 {
1208   u8 is_lep = session_endpoint_is_local (sep);
1209   if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
1210       && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
1211     {
1212       clib_warning ("sw_if_index %u not configured with ip %U",
1213                     sep->sw_if_index, format_ip46_address, &sep->ip,
1214                     sep->is_ip4);
1215       return 0;
1216     }
1217   return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
1218 }
1219
1220 static void
1221 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
1222                                  application_t * app, u8 is_connect)
1223 {
1224   app_namespace_t *app_ns;
1225   u32 ns_index, fib_index;
1226
1227   ns_index = app->ns_index;
1228
1229   /* App is a transport proto, so fetch the calling app's ns */
1230   if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
1231     ns_index = sep->ns_index;
1232
1233   app_ns = app_namespace_get (ns_index);
1234   if (!app_ns)
1235     return;
1236
1237   /* Ask transport and network to bind to/connect using local interface
1238    * that "supports" app's namespace. This will fix our local connection
1239    * endpoint.
1240    */
1241
1242   /* If in default namespace and user requested a fib index use it */
1243   if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
1244     fib_index = sep->fib_index;
1245   else
1246     fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
1247   sep->peer.fib_index = fib_index;
1248   sep->fib_index = fib_index;
1249
1250   if (!is_connect)
1251     {
1252       sep->sw_if_index = app_ns->sw_if_index;
1253     }
1254   else
1255     {
1256       if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
1257           && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
1258           && sep->peer.sw_if_index != app_ns->sw_if_index)
1259         clib_warning ("Local sw_if_index different from app ns sw_if_index");
1260
1261       sep->peer.sw_if_index = app_ns->sw_if_index;
1262     }
1263 }
1264
1265 int
1266 vnet_listen (vnet_listen_args_t * a)
1267 {
1268   app_listener_t *app_listener;
1269   app_worker_t *app_wrk;
1270   application_t *app;
1271   int rv;
1272
1273   ASSERT (vlib_thread_is_main_w_barrier ());
1274
1275   app = application_get_if_valid (a->app_index);
1276   if (!app)
1277     return SESSION_E_NOAPP;
1278
1279   app_wrk = application_get_worker (app, a->wrk_map_index);
1280   if (!app_wrk)
1281     return SESSION_E_INVALID_APPWRK;
1282
1283   a->sep_ext.app_wrk_index = app_wrk->wrk_index;
1284
1285   session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
1286   if (!session_endpoint_in_ns (&a->sep))
1287     return SESSION_E_INVALID_NS;
1288
1289   /*
1290    * Check if we already have an app listener
1291    */
1292   app_listener = app_listener_lookup (app, &a->sep_ext);
1293   if (app_listener)
1294     {
1295       if (app_listener->app_index != app->app_index)
1296         return SESSION_E_ALREADY_LISTENING;
1297       if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1298         return rv;
1299       a->handle = app_listener_handle (app_listener);
1300       return 0;
1301     }
1302
1303   /*
1304    * Create new app listener
1305    */
1306   if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
1307     return rv;
1308
1309   if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1310     {
1311       app_listener_cleanup (app_listener);
1312       return rv;
1313     }
1314
1315   a->handle = app_listener_handle (app_listener);
1316   return 0;
1317 }
1318
1319 int
1320 vnet_connect (vnet_connect_args_t * a)
1321 {
1322   app_worker_t *client_wrk;
1323   application_t *client;
1324
1325   ASSERT (vlib_thread_is_main_w_barrier ());
1326
1327   if (session_endpoint_is_zero (&a->sep))
1328     return SESSION_E_INVALID_RMT_IP;
1329
1330   client = application_get (a->app_index);
1331   session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1332   client_wrk = application_get_worker (client, a->wrk_map_index);
1333
1334   /*
1335    * First check the local scope for locally attached destinations.
1336    * If we have local scope, we pass *all* connects through it since we may
1337    * have special policy rules even for non-local destinations, think proxy.
1338    */
1339   if (application_has_local_scope (client))
1340     {
1341       int rv;
1342
1343       a->sep_ext.original_tp = a->sep_ext.transport_proto;
1344       a->sep_ext.transport_proto = TRANSPORT_PROTO_NONE;
1345       rv = app_worker_connect_session (client_wrk, &a->sep, a->api_context);
1346       if (rv <= 0)
1347         return rv;
1348       a->sep_ext.transport_proto = a->sep_ext.original_tp;
1349     }
1350   /*
1351    * Not connecting to a local server, propagate to transport
1352    */
1353   return app_worker_connect_session (client_wrk, &a->sep, a->api_context);
1354 }
1355
1356 int
1357 vnet_unlisten (vnet_unlisten_args_t * a)
1358 {
1359   app_worker_t *app_wrk;
1360   app_listener_t *al;
1361   application_t *app;
1362
1363   ASSERT (vlib_thread_is_main_w_barrier ());
1364
1365   if (!(app = application_get_if_valid (a->app_index)))
1366     return SESSION_E_NOAPP;
1367
1368   if (!(al = app_listener_get_w_handle (a->handle)))
1369     return SESSION_E_NOLISTEN;
1370
1371   if (al->app_index != app->app_index)
1372     {
1373       clib_warning ("app doesn't own handle %llu!", a->handle);
1374       return SESSION_E_OWNER;
1375     }
1376
1377   app_wrk = application_get_worker (app, a->wrk_map_index);
1378   if (!app_wrk)
1379     {
1380       clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1381       return SESSION_E_INVALID_APPWRK;
1382     }
1383
1384   return app_worker_stop_listen (app_wrk, al);
1385 }
1386
1387 int
1388 vnet_disconnect_session (vnet_disconnect_args_t * a)
1389 {
1390   app_worker_t *app_wrk;
1391   session_t *s;
1392
1393   s = session_get_from_handle_if_valid (a->handle);
1394   if (!s)
1395     return SESSION_E_NOSESSION;
1396
1397   app_wrk = app_worker_get (s->app_wrk_index);
1398   if (app_wrk->app_index != a->app_index)
1399     return SESSION_E_OWNER;
1400
1401   /* We're peeking into another's thread pool. Make sure */
1402   ASSERT (s->session_index == session_index_from_handle (a->handle));
1403
1404   session_close (s);
1405   return 0;
1406 }
1407
1408 int
1409 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1410 {
1411   app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1412   app_listener_t *app_listener;
1413   application_t *app;
1414   int rv;
1415
1416   if (!old_wrk)
1417     return SESSION_E_INVALID_APPWRK;
1418
1419   hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1420   if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1421       && s->rx_fifo)
1422     segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1423
1424   app = application_get (old_wrk->app_index);
1425   if (!app)
1426     return SESSION_E_NOAPP;
1427
1428   app_listener = app_listener_get (app, s->al_index);
1429
1430   /* Only remove from lb for now */
1431   app_listener->workers = clib_bitmap_set (app_listener->workers,
1432                                            old_wrk->wrk_map_index, 0);
1433
1434   if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1435     return rv;
1436
1437   s->app_wrk_index = app_wrk->wrk_index;
1438
1439   return 0;
1440 }
1441
1442 int
1443 application_is_proxy (application_t * app)
1444 {
1445   return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1446 }
1447
1448 int
1449 application_is_builtin (application_t * app)
1450 {
1451   return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1452 }
1453
1454 int
1455 application_is_builtin_proxy (application_t * app)
1456 {
1457   return (application_is_proxy (app) && application_is_builtin (app));
1458 }
1459
1460 u8
1461 application_has_local_scope (application_t * app)
1462 {
1463   return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1464 }
1465
1466 u8
1467 application_has_global_scope (application_t * app)
1468 {
1469   return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1470 }
1471
1472 static clib_error_t *
1473 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1474                                         u8 transport_proto, u8 is_start)
1475 {
1476   app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1477   u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1478   session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1479   transport_connection_t *tc;
1480   app_worker_t *app_wrk;
1481   app_listener_t *al;
1482   session_t *s;
1483   u32 flags;
1484
1485   /* TODO decide if we want proxy to be enabled for all workers */
1486   app_wrk = application_get_default_worker (app);
1487   if (is_start)
1488     {
1489       s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1490       if (!s)
1491         {
1492           sep.is_ip4 = is_ip4;
1493           sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1494           sep.sw_if_index = app_ns->sw_if_index;
1495           sep.transport_proto = transport_proto;
1496           sep.app_wrk_index = app_wrk->wrk_index;       /* only default */
1497
1498           /* force global scope listener */
1499           flags = app->flags;
1500           app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1501           app_listener_alloc_and_init (app, &sep, &al);
1502           app->flags = flags;
1503
1504           app_worker_start_listen (app_wrk, al);
1505           s = listen_session_get (al->session_index);
1506           s->flags |= SESSION_F_PROXY;
1507         }
1508     }
1509   else
1510     {
1511       s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1512       ASSERT (s);
1513     }
1514
1515   tc = listen_session_get_transport (s);
1516
1517   if (!ip_is_zero (&tc->lcl_ip, 1))
1518     {
1519       u32 sti;
1520       sep.is_ip4 = is_ip4;
1521       sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1522       sep.transport_proto = transport_proto;
1523       sep.port = 0;
1524       sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1525       if (is_start)
1526         session_lookup_add_session_endpoint (sti,
1527                                              (session_endpoint_t *) & sep,
1528                                              s->session_index);
1529       else
1530         session_lookup_del_session_endpoint (sti,
1531                                              (session_endpoint_t *) & sep);
1532     }
1533
1534   return 0;
1535 }
1536
1537 static void
1538 application_start_stop_proxy_local_scope (application_t * app,
1539                                           u8 transport_proto, u8 is_start)
1540 {
1541   session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1542   app_namespace_t *app_ns;
1543   app_ns = app_namespace_get (app->ns_index);
1544   sep.is_ip4 = 1;
1545   sep.transport_proto = transport_proto;
1546   sep.port = 0;
1547
1548   if (is_start)
1549     {
1550       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1551                                            app->app_index);
1552       sep.is_ip4 = 0;
1553       session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1554                                            app->app_index);
1555     }
1556   else
1557     {
1558       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1559       sep.is_ip4 = 0;
1560       session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1561     }
1562 }
1563
1564 void
1565 application_start_stop_proxy (application_t * app,
1566                               transport_proto_t transport_proto, u8 is_start)
1567 {
1568   if (application_has_local_scope (app))
1569     application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1570
1571   if (application_has_global_scope (app))
1572     {
1573       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1574                                               transport_proto, is_start);
1575       application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1576                                               transport_proto, is_start);
1577     }
1578 }
1579
1580 void
1581 application_setup_proxy (application_t * app)
1582 {
1583   u16 transports = app->proxied_transports;
1584   transport_proto_t tp;
1585
1586   ASSERT (application_is_proxy (app));
1587
1588   /* *INDENT-OFF* */
1589   transport_proto_foreach (tp, ({
1590     if (transports & (1 << tp))
1591       application_start_stop_proxy (app, tp, 1);
1592   }));
1593   /* *INDENT-ON* */
1594 }
1595
1596 void
1597 application_remove_proxy (application_t * app)
1598 {
1599   u16 transports = app->proxied_transports;
1600   transport_proto_t tp;
1601
1602   ASSERT (application_is_proxy (app));
1603
1604   /* *INDENT-OFF* */
1605   transport_proto_foreach (tp, ({
1606     if (transports & (1 << tp))
1607       application_start_stop_proxy (app, tp, 0);
1608   }));
1609   /* *INDENT-ON* */
1610 }
1611
1612 segment_manager_props_t *
1613 application_segment_manager_properties (application_t * app)
1614 {
1615   return &app->sm_properties;
1616 }
1617
1618 segment_manager_props_t *
1619 application_get_segment_manager_properties (u32 app_index)
1620 {
1621   application_t *app = application_get (app_index);
1622   return &app->sm_properties;
1623 }
1624
1625 static void
1626 application_format_listeners (application_t * app, int verbose)
1627 {
1628   vlib_main_t *vm = vlib_get_main ();
1629   app_worker_map_t *wrk_map;
1630   app_worker_t *app_wrk;
1631   u32 sm_index;
1632   u64 handle;
1633
1634   if (!app)
1635     {
1636       vlib_cli_output (vm, "%U", format_app_worker_listener, 0 /* header */ ,
1637                        0, 0, verbose);
1638       return;
1639     }
1640
1641   /* *INDENT-OFF* */
1642   pool_foreach (wrk_map, app->worker_maps)  {
1643     app_wrk = app_worker_get (wrk_map->wrk_index);
1644     if (hash_elts (app_wrk->listeners_table) == 0)
1645       continue;
1646     hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1647       vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1648                        handle, sm_index, verbose);
1649     }));
1650   }
1651   /* *INDENT-ON* */
1652 }
1653
1654 static void
1655 application_format_connects (application_t * app, int verbose)
1656 {
1657   app_worker_map_t *wrk_map;
1658   app_worker_t *app_wrk;
1659
1660   if (!app)
1661     {
1662       app_worker_format_connects (0, verbose);
1663       return;
1664     }
1665
1666   /* *INDENT-OFF* */
1667   pool_foreach (wrk_map, app->worker_maps)  {
1668     app_wrk = app_worker_get (wrk_map->wrk_index);
1669     app_worker_format_connects (app_wrk, verbose);
1670   }
1671   /* *INDENT-ON* */
1672 }
1673
1674 u8 *
1675 format_cert_key_pair (u8 * s, va_list * args)
1676 {
1677   app_cert_key_pair_t *ckpair = va_arg (*args, app_cert_key_pair_t *);
1678   int key_len = 0, cert_len = 0;
1679   cert_len = vec_len (ckpair->cert);
1680   key_len = vec_len (ckpair->key);
1681   if (ckpair->cert_key_index == 0)
1682     s = format (s, "DEFAULT (cert:%d, key:%d)", cert_len, key_len);
1683   else
1684     s = format (s, "%d (cert:%d, key:%d)", ckpair->cert_key_index,
1685                 cert_len, key_len);
1686   return s;
1687 }
1688
1689 u8 *
1690 format_crypto_engine (u8 * s, va_list * args)
1691 {
1692   u32 engine = va_arg (*args, u32);
1693   switch (engine)
1694     {
1695     case CRYPTO_ENGINE_NONE:
1696       return format (s, "none");
1697     case CRYPTO_ENGINE_MBEDTLS:
1698       return format (s, "mbedtls");
1699     case CRYPTO_ENGINE_OPENSSL:
1700       return format (s, "openssl");
1701     case CRYPTO_ENGINE_PICOTLS:
1702       return format (s, "picotls");
1703     case CRYPTO_ENGINE_VPP:
1704       return format (s, "vpp");
1705     default:
1706       return format (s, "unknown engine");
1707     }
1708   return s;
1709 }
1710
1711 uword
1712 unformat_crypto_engine (unformat_input_t * input, va_list * args)
1713 {
1714   u8 *a = va_arg (*args, u8 *);
1715   if (unformat (input, "mbedtls"))
1716     *a = CRYPTO_ENGINE_MBEDTLS;
1717   else if (unformat (input, "openssl"))
1718     *a = CRYPTO_ENGINE_OPENSSL;
1719   else if (unformat (input, "picotls"))
1720     *a = CRYPTO_ENGINE_PICOTLS;
1721   else if (unformat (input, "vpp"))
1722     *a = CRYPTO_ENGINE_VPP;
1723   else
1724     return 0;
1725   return 1;
1726 }
1727
1728 u8 *
1729 format_crypto_context (u8 * s, va_list * args)
1730 {
1731   crypto_context_t *crctx = va_arg (*args, crypto_context_t *);
1732   s = format (s, "[0x%x][sub%d,ckpair%x]", crctx->ctx_index,
1733               crctx->n_subscribers, crctx->ckpair_index);
1734   s = format (s, "[%U]", format_crypto_engine, crctx->crypto_engine);
1735   return s;
1736 }
1737
1738 u8 *
1739 format_application (u8 * s, va_list * args)
1740 {
1741   application_t *app = va_arg (*args, application_t *);
1742   CLIB_UNUSED (int verbose) = va_arg (*args, int);
1743   segment_manager_props_t *props;
1744   const u8 *app_ns_name, *app_name;
1745   app_worker_map_t *wrk_map;
1746   app_worker_t *app_wrk;
1747
1748   if (app == 0)
1749     {
1750       if (!verbose)
1751         s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1752       return s;
1753     }
1754
1755   app_name = app_get_name (app);
1756   app_ns_name = app_namespace_id_from_index (app->ns_index);
1757   props = application_segment_manager_properties (app);
1758   if (!verbose)
1759     {
1760       s = format (s, "%-10u%-20v%-40v", app->app_index, app_name,
1761                   app_ns_name);
1762       return s;
1763     }
1764
1765   s = format (s, "app-name %v app-index %u ns-index %u seg-size %U\n",
1766               app_name, app->app_index, app->ns_index,
1767               format_memory_size, props->add_segment_size);
1768   s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1769               format_memory_size, props->rx_fifo_size,
1770               format_memory_size, props->tx_fifo_size);
1771
1772   /* *INDENT-OFF* */
1773   pool_foreach (wrk_map, app->worker_maps)  {
1774       app_wrk = app_worker_get (wrk_map->wrk_index);
1775       s = format (s, "%U", format_app_worker, app_wrk);
1776   }
1777   /* *INDENT-ON* */
1778
1779   return s;
1780 }
1781
1782 void
1783 application_format_all_listeners (vlib_main_t * vm, int verbose)
1784 {
1785   application_t *app;
1786
1787   if (!pool_elts (app_main.app_pool))
1788     {
1789       vlib_cli_output (vm, "No active server bindings");
1790       return;
1791     }
1792
1793   application_format_listeners (0, verbose);
1794
1795   /* *INDENT-OFF* */
1796   pool_foreach (app, app_main.app_pool)  {
1797     application_format_listeners (app, verbose);
1798   }
1799   /* *INDENT-ON* */
1800 }
1801
1802 void
1803 application_format_all_clients (vlib_main_t * vm, int verbose)
1804 {
1805   application_t *app;
1806
1807   if (!pool_elts (app_main.app_pool))
1808     {
1809       vlib_cli_output (vm, "No active apps");
1810       return;
1811     }
1812
1813   application_format_connects (0, verbose);
1814
1815   /* *INDENT-OFF* */
1816   pool_foreach (app, app_main.app_pool)  {
1817     application_format_connects (app, verbose);
1818   }
1819   /* *INDENT-ON* */
1820 }
1821
1822 static clib_error_t *
1823 show_certificate_command_fn (vlib_main_t * vm, unformat_input_t * input,
1824                              vlib_cli_command_t * cmd)
1825 {
1826   app_cert_key_pair_t *ckpair;
1827   session_cli_return_if_not_enabled ();
1828
1829   /* *INDENT-OFF* */
1830   pool_foreach (ckpair, app_main.cert_key_pair_store)  {
1831     vlib_cli_output (vm, "%U", format_cert_key_pair, ckpair);
1832   }
1833   /* *INDENT-ON* */
1834   return 0;
1835 }
1836
1837 static inline void
1838 appliction_format_app_mq (vlib_main_t * vm, application_t * app)
1839 {
1840   app_worker_map_t *map;
1841   app_worker_t *wrk;
1842   int i;
1843
1844   /* *INDENT-OFF* */
1845   pool_foreach (map, app->worker_maps)  {
1846     wrk = app_worker_get (map->wrk_index);
1847     vlib_cli_output (vm, "[A%d][%d]%U", app->app_index,
1848                      map->wrk_index, format_svm_msg_q,
1849                      wrk->event_queue);
1850   }
1851   /* *INDENT-ON* */
1852
1853   for (i = 0; i < vec_len (app->rx_mqs); i++)
1854     vlib_cli_output (vm, "[A%d][R%d]%U", app->app_index, i, format_svm_msg_q,
1855                      app->rx_mqs[i].mq);
1856 }
1857
1858 static clib_error_t *
1859 appliction_format_all_app_mq (vlib_main_t * vm)
1860 {
1861   application_t *app;
1862   int i, n_threads;
1863
1864   n_threads = vlib_get_n_threads ();
1865
1866   for (i = 0; i < n_threads; i++)
1867     {
1868       vlib_cli_output (vm, "[Ctrl%d]%U", i, format_svm_msg_q,
1869                        session_main_get_vpp_event_queue (i));
1870     }
1871
1872   /* *INDENT-OFF* */
1873   pool_foreach (app, app_main.app_pool)  {
1874       appliction_format_app_mq (vm, app);
1875   }
1876   /* *INDENT-ON* */
1877   return 0;
1878 }
1879
1880 static clib_error_t *
1881 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1882                      vlib_cli_command_t * cmd)
1883 {
1884   int do_server = 0, do_client = 0, do_mq = 0;
1885   application_t *app;
1886   u32 app_index = ~0;
1887   int verbose = 0;
1888
1889   session_cli_return_if_not_enabled ();
1890
1891   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1892     {
1893       if (unformat (input, "server"))
1894         do_server = 1;
1895       else if (unformat (input, "client"))
1896         do_client = 1;
1897       else if (unformat (input, "mq"))
1898         do_mq = 1;
1899       else if (unformat (input, "%u", &app_index))
1900         ;
1901       else if (unformat (input, "verbose"))
1902         verbose = 1;
1903       else
1904         return clib_error_return (0, "unknown input `%U'",
1905                                   format_unformat_error, input);
1906     }
1907
1908   if (do_mq && app_index != ~0)
1909     {
1910       app = application_get_if_valid (app_index);
1911       if (!app)
1912         return clib_error_return (0, "No app with index %u", app_index);
1913
1914       appliction_format_app_mq (vm, app);
1915       return 0;
1916     }
1917
1918   if (do_mq)
1919     {
1920       appliction_format_all_app_mq (vm);
1921       return 0;
1922     }
1923
1924   if (do_server)
1925     {
1926       application_format_all_listeners (vm, verbose);
1927       return 0;
1928     }
1929
1930   if (do_client)
1931     {
1932       application_format_all_clients (vm, verbose);
1933       return 0;
1934     }
1935
1936   if (app_index != ~0)
1937     {
1938       app = application_get_if_valid (app_index);
1939       if (!app)
1940         return clib_error_return (0, "No app with index %u", app_index);
1941
1942       vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
1943       return 0;
1944     }
1945
1946   /* Print app related info */
1947   if (!do_server && !do_client)
1948     {
1949       vlib_cli_output (vm, "%U", format_application, 0, 0);
1950       /* *INDENT-OFF* */
1951       pool_foreach (app, app_main.app_pool)  {
1952         vlib_cli_output (vm, "%U", format_application, app, 0);
1953       }
1954       /* *INDENT-ON* */
1955     }
1956
1957   return 0;
1958 }
1959
1960 /* Certificate store */
1961
1962 static app_cert_key_pair_t *
1963 app_cert_key_pair_alloc ()
1964 {
1965   app_cert_key_pair_t *ckpair;
1966   pool_get (app_main.cert_key_pair_store, ckpair);
1967   clib_memset (ckpair, 0, sizeof (*ckpair));
1968   ckpair->cert_key_index = ckpair - app_main.cert_key_pair_store;
1969   return ckpair;
1970 }
1971
1972 app_cert_key_pair_t *
1973 app_cert_key_pair_get_if_valid (u32 index)
1974 {
1975   if (pool_is_free_index (app_main.cert_key_pair_store, index))
1976     return 0;
1977   return app_cert_key_pair_get (index);
1978 }
1979
1980 app_cert_key_pair_t *
1981 app_cert_key_pair_get (u32 index)
1982 {
1983   return pool_elt_at_index (app_main.cert_key_pair_store, index);
1984 }
1985
1986 app_cert_key_pair_t *
1987 app_cert_key_pair_get_default ()
1988 {
1989   /* To maintain legacy bapi */
1990   return app_cert_key_pair_get (0);
1991 }
1992
1993 int
1994 vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a)
1995 {
1996   app_cert_key_pair_t *ckpair = app_cert_key_pair_alloc ();
1997   vec_validate (ckpair->cert, a->cert_len - 1);
1998   clib_memcpy_fast (ckpair->cert, a->cert, a->cert_len);
1999   vec_validate (ckpair->key, a->key_len - 1);
2000   clib_memcpy_fast (ckpair->key, a->key, a->key_len);
2001   a->index = ckpair->cert_key_index;
2002   return 0;
2003 }
2004
2005 int
2006 vnet_app_add_cert_key_interest (u32 index, u32 app_index)
2007 {
2008   app_cert_key_pair_t *ckpair;
2009   if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
2010     return -1;
2011   if (vec_search (ckpair->app_interests, app_index) != ~0)
2012     vec_add1 (ckpair->app_interests, app_index);
2013   return 0;
2014 }
2015
2016 int
2017 vnet_app_del_cert_key_pair (u32 index)
2018 {
2019   app_cert_key_pair_t *ckpair;
2020   application_t *app;
2021   u32 *app_index;
2022
2023   if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
2024     return (VNET_API_ERROR_INVALID_VALUE);
2025
2026   vec_foreach (app_index, ckpair->app_interests)
2027   {
2028     if ((app = application_get_if_valid (*app_index))
2029         && app->cb_fns.app_cert_key_pair_delete_callback)
2030       app->cb_fns.app_cert_key_pair_delete_callback (ckpair);
2031   }
2032
2033   vec_free (ckpair->cert);
2034   vec_free (ckpair->key);
2035   pool_put (app_main.cert_key_pair_store, ckpair);
2036   return 0;
2037 }
2038
2039 clib_error_t *
2040 application_init (vlib_main_t * vm)
2041 {
2042   app_main_t *am = &app_main;
2043   u32 n_workers;
2044
2045   n_workers = vlib_num_workers ();
2046
2047   /* Index 0 was originally used by legacy apis, maintain as invalid */
2048   (void) app_cert_key_pair_alloc ();
2049   am->last_crypto_engine = CRYPTO_ENGINE_LAST;
2050   am->app_by_name = hash_create_vec (0, sizeof (u8), sizeof (uword));
2051
2052   vec_validate (am->wrk, n_workers);
2053
2054   return 0;
2055 }
2056
2057 /* *INDENT-OFF* */
2058 VLIB_INIT_FUNCTION (application_init);
2059
2060 VLIB_CLI_COMMAND (show_app_command, static) =
2061 {
2062   .path = "show app",
2063   .short_help = "show app [app_id] [server|client] [mq] [verbose]",
2064   .function = show_app_command_fn,
2065 };
2066
2067 VLIB_CLI_COMMAND (show_certificate_command, static) =
2068 {
2069   .path = "show app certificate",
2070   .short_help = "list app certs and keys present in store",
2071   .function = show_certificate_command_fn,
2072 };
2073 /* *INDENT-ON* */
2074
2075 crypto_engine_type_t
2076 app_crypto_engine_type_add (void)
2077 {
2078   return (++app_main.last_crypto_engine);
2079 }
2080
2081 u8
2082 app_crypto_engine_n_types (void)
2083 {
2084   return (app_main.last_crypto_engine + 1);
2085 }
2086
2087 /*
2088  * fd.io coding-style-patch-verification: ON
2089  *
2090  * Local Variables:
2091  * eval: (c-set-style "gnu")
2092  * End:
2093  */