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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
22 static app_main_t app_main;
24 #define app_interface_check_thread_and_barrier(_fn, _arg) \
25 if (PREDICT_FALSE (!vlib_thread_is_main_w_barrier ())) \
27 vlib_rpc_call_main_thread (_fn, (u8 *) _arg, sizeof(*_arg)); \
31 static app_listener_t *
32 app_listener_alloc (application_t * app)
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;
46 app_listener_get (application_t * app, u32 app_listener_index)
48 return pool_elt_at_index (app->listeners, app_listener_index);
52 app_listener_free (application_t * app, app_listener_t * app_listener)
54 clib_bitmap_free (app_listener->workers);
56 clib_memset (app_listener, 0xfa, sizeof (*app_listener));
57 pool_put (app->listeners, app_listener);
61 app_listener_handle (app_listener_t * al)
67 app_listener_get_w_session (session_t * ls)
71 app = application_get_if_valid (ls->app_index);
74 return app_listener_get (app, ls->al_index);
78 app_listen_session_handle (session_t * ls)
81 al = app_listener_get_w_session (ls);
83 return listen_session_get_handle (ls);
88 app_listener_get_w_handle (session_handle_t handle)
91 ls = session_get_from_handle_if_valid (handle);
94 return app_listener_get_w_session (ls);
98 app_listener_lookup (application_t * app, session_endpoint_cfg_t * sep_ext)
100 u32 table_index, fib_proto;
101 session_endpoint_t *sep;
102 session_handle_t handle;
105 sep = (session_endpoint_t *) sep_ext;
106 if (application_has_local_scope (app) && session_endpoint_is_local (sep))
108 table_index = application_local_session_table (app);
109 handle = session_lookup_endpoint_listener (table_index, sep, 1);
110 if (handle != SESSION_INVALID_HANDLE)
112 ls = listen_session_get_from_handle (handle);
113 return app_listener_get_w_session (ls);
117 fib_proto = session_endpoint_fib_proto (sep);
118 table_index = session_lookup_get_index_for_fib (fib_proto, sep->fib_index);
119 handle = session_lookup_endpoint_listener (table_index, sep, 1);
120 if (handle != SESSION_INVALID_HANDLE)
122 ls = listen_session_get_from_handle (handle);
123 return app_listener_get_w_session ((session_t *) ls);
130 app_listener_alloc_and_init (application_t * app,
131 session_endpoint_cfg_t * sep,
132 app_listener_t ** listener)
134 app_listener_t *app_listener;
135 transport_connection_t *tc;
136 u32 al_index, table_index;
142 app_listener = app_listener_alloc (app);
143 al_index = app_listener->al_index;
144 st = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
147 * Add session endpoint to local session table. Only binds to "inaddr_any"
148 * (i.e., zero address) are added to local scope table.
150 if (application_has_local_scope (app)
151 && session_endpoint_is_local ((session_endpoint_t *) sep))
153 session_type_t local_st;
155 local_st = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE,
157 ls = listen_session_alloc (0, local_st);
158 ls->app_index = app->app_index;
159 ls->app_wrk_index = sep->app_wrk_index;
160 lh = session_handle (ls);
162 if ((rv = session_listen (ls, sep)))
164 ls = session_get_from_handle (lh);
169 ls = session_get_from_handle (lh);
170 app_listener = app_listener_get (app, al_index);
171 app_listener->local_index = ls->session_index;
172 app_listener->ls_handle = lh;
173 ls->al_index = al_index;
175 table_index = application_local_session_table (app);
176 session_lookup_add_session_endpoint (table_index,
177 (session_endpoint_t *) sep, lh);
180 if (application_has_global_scope (app))
183 * Start listening on local endpoint for requested transport and scope.
184 * Creates a stream session with state LISTENING to be used in session
185 * lookups, prior to establishing connection. Requests transport to
186 * build it's own specific listening connection.
188 ls = listen_session_alloc (0, st);
189 ls->app_index = app->app_index;
190 ls->app_wrk_index = sep->app_wrk_index;
192 /* Listen pool can be reallocated if the transport is
194 lh = listen_session_get_handle (ls);
196 if ((rv = session_listen (ls, sep)))
198 ls = listen_session_get_from_handle (lh);
202 ls = listen_session_get_from_handle (lh);
203 app_listener = app_listener_get (app, al_index);
204 app_listener->session_index = ls->session_index;
205 app_listener->ls_handle = lh;
206 ls->al_index = al_index;
208 /* Add to the global lookup table after transport was initialized.
209 * Lookup table needs to be populated only now because sessions
210 * with cut-through transport are are added to app local tables that
211 * are not related to network fibs, i.e., cannot be added as
213 tc = session_get_transport (ls);
214 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
216 fib_protocol_t fib_proto;
217 fib_proto = session_endpoint_fib_proto ((session_endpoint_t *) sep);
218 table_index = session_lookup_get_index_for_fib (fib_proto,
220 ASSERT (table_index != SESSION_TABLE_INVALID_INDEX);
221 session_lookup_add_session_endpoint (table_index,
222 (session_endpoint_t *) sep,
229 app_listener_free (app, app_listener);
233 *listener = app_listener;
238 app_listener_cleanup (app_listener_t * al)
240 application_t *app = application_get (al->app_index);
243 if (al->session_index != SESSION_INVALID_INDEX)
245 ls = session_get (al->session_index, 0);
246 session_stop_listen (ls);
247 listen_session_free (ls);
249 if (al->local_index != SESSION_INVALID_INDEX)
251 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
254 table_index = application_local_session_table (app);
255 ls = listen_session_get (al->local_index);
256 ct_session_endpoint (ls, &sep);
257 session_lookup_del_session_endpoint (table_index, &sep);
258 session_stop_listen (ls);
259 listen_session_free (ls);
261 app_listener_free (app, al);
264 static app_worker_t *
265 app_listener_select_worker (application_t * app, app_listener_t * al)
269 app = application_get (al->app_index);
270 wrk_index = clib_bitmap_next_set (al->workers, al->accept_rotor + 1);
272 wrk_index = clib_bitmap_first_set (al->workers);
274 ASSERT (wrk_index != ~0);
275 al->accept_rotor = wrk_index;
276 return application_get_worker (app, wrk_index);
280 app_listener_get_session (app_listener_t * al)
282 if (al->session_index == SESSION_INVALID_INDEX)
285 return listen_session_get (al->session_index);
289 app_listener_get_local_session (app_listener_t * al)
291 if (al->local_index == SESSION_INVALID_INDEX)
293 return listen_session_get (al->local_index);
296 static app_worker_map_t *
297 app_worker_map_alloc (application_t * app)
299 app_worker_map_t *map;
300 pool_get (app->worker_maps, map);
301 clib_memset (map, 0, sizeof (*map));
306 app_worker_map_index (application_t * app, app_worker_map_t * map)
308 return (map - app->worker_maps);
312 app_worker_map_free (application_t * app, app_worker_map_t * map)
314 pool_put (app->worker_maps, map);
317 static app_worker_map_t *
318 app_worker_map_get (application_t * app, u32 map_index)
320 if (pool_is_free_index (app->worker_maps, map_index))
322 return pool_elt_at_index (app->worker_maps, map_index);
326 app_get_name (application_t * app)
332 application_session_table (application_t * app, u8 fib_proto)
334 app_namespace_t *app_ns;
335 app_ns = app_namespace_get (app->ns_index);
336 if (!application_has_global_scope (app))
337 return APP_INVALID_INDEX;
338 if (fib_proto == FIB_PROTOCOL_IP4)
339 return session_lookup_get_index_for_fib (fib_proto,
340 app_ns->ip4_fib_index);
342 return session_lookup_get_index_for_fib (fib_proto,
343 app_ns->ip6_fib_index);
347 application_local_session_table (application_t * app)
349 app_namespace_t *app_ns;
350 if (!application_has_local_scope (app))
351 return APP_INVALID_INDEX;
352 app_ns = app_namespace_get (app->ns_index);
353 return app_ns->local_table_index;
357 * Returns app name for app-index
360 application_name_from_index (u32 app_index)
362 application_t *app = application_get (app_index);
365 return app_get_name (app);
369 application_api_table_add (u32 app_index, u32 api_client_index)
371 if (api_client_index != APP_INVALID_INDEX)
372 hash_set (app_main.app_by_api_client_index, api_client_index, app_index);
376 application_api_table_del (u32 api_client_index)
378 hash_unset (app_main.app_by_api_client_index, api_client_index);
382 application_name_table_add (application_t * app)
384 hash_set_mem (app_main.app_by_name, app->name, app->app_index);
388 application_name_table_del (application_t * app)
390 hash_unset_mem (app_main.app_by_name, app->name);
394 application_lookup (u32 api_client_index)
397 p = hash_get (app_main.app_by_api_client_index, api_client_index);
399 return application_get_if_valid (p[0]);
405 application_lookup_name (const u8 * name)
408 p = hash_get_mem (app_main.app_by_name, name);
410 return application_get (p[0]);
416 appsl_pending_rx_mqs_add_tail (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
418 app_rx_mq_elt_t *head;
420 if (!aw->pending_rx_mqs)
422 elt->next = elt->prev = elt;
423 aw->pending_rx_mqs = elt;
427 head = aw->pending_rx_mqs;
429 ASSERT (head != elt);
431 elt->prev = head->prev;
434 head->prev->next = elt;
439 appsl_pending_rx_mqs_del (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
441 if (elt->next == elt)
443 elt->next = elt->prev = 0;
444 aw->pending_rx_mqs = 0;
448 if (elt == aw->pending_rx_mqs)
449 aw->pending_rx_mqs = elt->next;
451 elt->next->prev = elt->prev;
452 elt->prev->next = elt->next;
453 elt->next = elt->prev = 0;
456 vlib_node_registration_t appsl_rx_mqs_input_node;
458 VLIB_NODE_FN (appsl_rx_mqs_input_node)
459 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
461 u32 thread_index = vm->thread_index, n_msgs = 0;
462 app_rx_mq_elt_t *elt, *next;
463 app_main_t *am = &app_main;
464 session_worker_t *wrk;
465 int __clib_unused rv;
469 aw = &am->wrk[thread_index];
470 elt = aw->pending_rx_mqs;
474 wrk = session_main_get_worker (thread_index);
478 if (!(elt->flags & APP_RX_MQ_F_POSTPONED))
479 rv = read (svm_msg_q_get_eventfd (elt->mq), &buf, sizeof (buf));
480 n_msgs += session_wrk_handle_mq (wrk, elt->mq);
483 appsl_pending_rx_mqs_del (aw, elt);
484 if (!svm_msg_q_is_empty (elt->mq))
486 elt->flags |= APP_RX_MQ_F_POSTPONED;
487 appsl_pending_rx_mqs_add_tail (aw, elt);
495 while (aw->pending_rx_mqs && elt != aw->pending_rx_mqs);
497 if (aw->pending_rx_mqs)
498 vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
503 VLIB_REGISTER_NODE (appsl_rx_mqs_input_node) = {
504 .name = "appsl-rx-mqs-input",
505 .type = VLIB_NODE_TYPE_INPUT,
506 .state = VLIB_NODE_STATE_DISABLED,
509 static clib_error_t *
510 app_rx_mq_fd_read_ready (clib_file_t *cf)
512 app_rx_mq_handle_t *handle = (app_rx_mq_handle_t *) &cf->private_data;
513 vlib_main_t *vm = vlib_get_main ();
514 app_main_t *am = &app_main;
515 app_rx_mq_elt_t *mqe;
519 ASSERT (vlib_get_thread_index () == handle->thread_index);
520 app = application_get_if_valid (handle->app_index);
524 mqe = &app->rx_mqs[handle->thread_index];
525 if ((mqe->flags & APP_RX_MQ_F_PENDING) || svm_msg_q_is_empty (mqe->mq))
528 aw = &am->wrk[handle->thread_index];
529 appsl_pending_rx_mqs_add_tail (aw, mqe);
530 mqe->flags |= APP_RX_MQ_F_PENDING;
532 vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
537 static clib_error_t *
538 app_rx_mq_fd_write_ready (clib_file_t *cf)
540 clib_warning ("should not be called");
545 app_rx_mqs_epoll_add (application_t *app, app_rx_mq_elt_t *mqe)
547 clib_file_t template = { 0 };
548 app_rx_mq_handle_t handle;
552 thread_index = mqe - app->rx_mqs;
553 fd = svm_msg_q_get_eventfd (mqe->mq);
555 handle.app_index = app->app_index;
556 handle.thread_index = thread_index;
558 template.read_function = app_rx_mq_fd_read_ready;
559 template.write_function = app_rx_mq_fd_write_ready;
560 template.file_descriptor = fd;
561 template.private_data = handle.as_u64;
562 template.polling_thread_index = thread_index;
563 template.description =
564 format (0, "app-%u-rx-mq-%u", app->app_index, thread_index);
565 mqe->file_index = clib_file_add (&file_main, &template);
569 app_rx_mqs_epoll_del (application_t *app, app_rx_mq_elt_t *mqe)
571 u32 thread_index = mqe - app->rx_mqs;
572 app_main_t *am = &app_main;
575 aw = &am->wrk[thread_index];
577 session_wrk_handle_mq (session_main_get_worker (thread_index), mqe->mq);
579 if (mqe->flags & APP_RX_MQ_F_PENDING)
580 appsl_pending_rx_mqs_del (aw, mqe);
582 clib_file_del_by_index (&file_main, mqe->file_index);
586 application_rx_mq_get (application_t *app, u32 mq_index)
591 return app->rx_mqs[mq_index].mq;
595 app_rx_mqs_alloc (application_t *app)
597 u32 evt_q_length, evt_size = sizeof (session_event_t);
598 fifo_segment_t *eqs = &app->rx_mqs_segment;
599 u32 n_mqs = vlib_num_workers () + 1;
600 segment_manager_props_t *props;
603 props = application_segment_manager_properties (app);
604 evt_q_length = clib_max (props->evt_q_size, 128);
606 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
607 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
608 { evt_q_length, evt_size, 0 }, { evt_q_length >> 1, 256, 0 }
610 cfg->consumer_pid = 0;
612 cfg->q_nitems = evt_q_length;
615 eqs->ssvm.ssvm_size = svm_msg_q_size_to_alloc (cfg) * n_mqs + (16 << 10);
616 eqs->ssvm.name = format (0, "%s-rx-mqs-seg%c", app->name, 0);
618 if (ssvm_server_init (&eqs->ssvm, SSVM_SEGMENT_MEMFD))
620 clib_warning ("failed to initialize queue segment");
621 return SESSION_E_SEG_CREATE;
624 fifo_segment_init (eqs);
626 /* Fifo segment filled only with mqs */
627 eqs->h->n_mqs = n_mqs;
628 vec_validate (app->rx_mqs, n_mqs - 1);
630 for (i = 0; i < n_mqs; i++)
632 app->rx_mqs[i].mq = fifo_segment_msg_q_alloc (eqs, i, cfg);
633 if (svm_msg_q_alloc_eventfd (app->rx_mqs[i].mq))
635 clib_warning ("eventfd returned");
636 fifo_segment_cleanup (eqs);
637 ssvm_delete (&eqs->ssvm);
638 return SESSION_E_EVENTFD_ALLOC;
640 app_rx_mqs_epoll_add (app, &app->rx_mqs[i]);
641 app->rx_mqs[i].app_index = app->app_index;
648 application_use_private_rx_mqs (void)
650 return session_main.use_private_rx_mqs;
654 application_get_rx_mqs_segment (application_t *app)
656 if (application_use_private_rx_mqs ())
657 return &app->rx_mqs_segment;
658 return session_main_get_evt_q_segment ();
662 application_enable_rx_mqs_nodes (u8 is_en)
664 u8 state = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
667 vlib_node_set_state (this_vlib_main, appsl_rx_mqs_input_node.index, state);
670 static application_t *
671 application_alloc (void)
674 pool_get (app_main.app_pool, app);
675 clib_memset (app, 0, sizeof (*app));
676 app->app_index = app - app_main.app_pool;
681 application_get (u32 app_index)
683 if (app_index == APP_INVALID_INDEX)
685 return pool_elt_at_index (app_main.app_pool, app_index);
689 application_get_if_valid (u32 app_index)
691 if (pool_is_free_index (app_main.app_pool, app_index))
694 return pool_elt_at_index (app_main.app_pool, app_index);
698 application_verify_cb_fns (session_cb_vft_t * cb_fns)
700 if (cb_fns->session_accept_callback == 0)
701 clib_warning ("No accept callback function provided");
702 if (cb_fns->session_connected_callback == 0)
703 clib_warning ("No session connected callback function provided");
704 if (cb_fns->session_disconnect_callback == 0)
705 clib_warning ("No session disconnect callback function provided");
706 if (cb_fns->session_reset_callback == 0)
707 clib_warning ("No session reset callback function provided");
711 * Check app config for given segment type
713 * Returns 1 on success and 0 otherwise
716 application_verify_cfg (ssvm_segment_type_t st)
719 if (st == SSVM_SEGMENT_MEMFD)
721 is_valid = (session_main_get_evt_q_segment () != 0);
723 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
726 else if (st == SSVM_SEGMENT_SHM)
728 is_valid = (session_main_get_evt_q_segment () == 0);
730 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
738 application_alloc_and_init (app_init_args_t * a)
740 ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
741 segment_manager_props_t *props;
745 app = application_alloc ();
746 options = a->options;
748 * Make sure we support the requested configuration
750 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN)
751 seg_type = SSVM_SEGMENT_PRIVATE;
753 if ((options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
754 && seg_type != SSVM_SEGMENT_MEMFD)
756 clib_warning ("mq eventfds can only be used if socket transport is "
757 "used for binary api");
758 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
761 if (!application_verify_cfg (seg_type))
762 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
764 if (options[APP_OPTIONS_PREALLOC_FIFO_PAIRS]
765 && options[APP_OPTIONS_PREALLOC_FIFO_HDRS])
766 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
768 /* Check that the obvious things are properly set up */
769 application_verify_cb_fns (a->session_cb_vft);
771 app->flags = options[APP_OPTIONS_FLAGS];
772 app->cb_fns = *a->session_cb_vft;
773 app->ns_index = options[APP_OPTIONS_NAMESPACE];
774 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
775 app->name = vec_dup (a->name);
777 /* If no scope enabled, default to global */
778 if (!application_has_global_scope (app)
779 && !application_has_local_scope (app))
780 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
782 props = application_segment_manager_properties (app);
783 segment_manager_props_init (props);
784 props->segment_size = options[APP_OPTIONS_SEGMENT_SIZE];
785 props->prealloc_fifos = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
786 props->prealloc_fifo_hdrs = options[APP_OPTIONS_PREALLOC_FIFO_HDRS];
787 if (options[APP_OPTIONS_ADD_SEGMENT_SIZE])
789 props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
790 props->add_segment = 1;
792 if (options[APP_OPTIONS_RX_FIFO_SIZE])
793 props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
794 if (options[APP_OPTIONS_TX_FIFO_SIZE])
795 props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
796 if (options[APP_OPTIONS_EVT_QUEUE_SIZE])
797 props->evt_q_size = options[APP_OPTIONS_EVT_QUEUE_SIZE];
798 if (options[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
799 props->use_mq_eventfd = 1;
800 if (options[APP_OPTIONS_TLS_ENGINE])
801 app->tls_engine = options[APP_OPTIONS_TLS_ENGINE];
802 if (options[APP_OPTIONS_MAX_FIFO_SIZE])
803 props->max_fifo_size = options[APP_OPTIONS_MAX_FIFO_SIZE];
804 if (options[APP_OPTIONS_HIGH_WATERMARK])
805 props->high_watermark = options[APP_OPTIONS_HIGH_WATERMARK];
806 if (options[APP_OPTIONS_LOW_WATERMARK])
807 props->low_watermark = options[APP_OPTIONS_LOW_WATERMARK];
808 if (options[APP_OPTIONS_PCT_FIRST_ALLOC])
809 props->pct_first_alloc = options[APP_OPTIONS_PCT_FIRST_ALLOC];
810 props->segment_type = seg_type;
812 /* Add app to lookup by api_client_index table */
813 if (!application_is_builtin (app))
814 application_api_table_add (app->app_index, a->api_client_index);
816 application_name_table_add (app);
818 a->app_index = app->app_index;
820 APP_DBG ("New app name: %v api index: %u index %u", app->name,
821 a->api_client_index, app->app_index);
827 application_free (application_t * app)
829 app_worker_map_t *wrk_map;
830 app_worker_t *app_wrk;
833 * The app event queue allocated in first segment is cleared with
834 * the segment manager. No need to explicitly free it.
836 APP_DBG ("Delete app name %v index: %d", app->name, app->app_index);
838 if (application_is_proxy (app))
839 application_remove_proxy (app);
846 pool_flush (wrk_map, app->worker_maps, ({
847 app_wrk = app_worker_get (wrk_map->wrk_index);
848 app_worker_free (app_wrk);
851 pool_free (app->worker_maps);
854 * Free rx mqs if allocated
859 for (i = 0; i < vec_len (app->rx_mqs); i++)
860 app_rx_mqs_epoll_del (app, &app->rx_mqs[i]);
862 fifo_segment_cleanup (&app->rx_mqs_segment);
863 ssvm_delete (&app->rx_mqs_segment.ssvm);
864 vec_free (app->rx_mqs);
868 * Cleanup remaining state
870 if (application_is_builtin (app))
871 application_name_table_del (app);
872 vec_free (app->name);
873 pool_put (app_main.app_pool, app);
877 application_detach_process (application_t * app, u32 api_client_index)
879 vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
880 app_worker_map_t *wrk_map;
881 u32 *wrks = 0, *wrk_index;
882 app_worker_t *app_wrk;
884 if (api_client_index == ~0)
886 application_free (app);
890 APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
891 app->app_index, api_client_index);
894 pool_foreach (wrk_map, app->worker_maps) {
895 app_wrk = app_worker_get (wrk_map->wrk_index);
896 if (app_wrk->api_client_index == api_client_index)
897 vec_add1 (wrks, app_wrk->wrk_index);
903 clib_warning ("no workers for app %u api_index %u", app->app_index,
908 args->app_index = app->app_index;
909 args->api_client_index = api_client_index;
910 vec_foreach (wrk_index, wrks)
912 app_wrk = app_worker_get (wrk_index[0]);
913 args->wrk_map_index = app_wrk->wrk_map_index;
915 vnet_app_worker_add_del (args);
921 application_get_worker (application_t * app, u32 wrk_map_index)
923 app_worker_map_t *map;
924 map = app_worker_map_get (app, wrk_map_index);
927 return app_worker_get (map->wrk_index);
931 application_get_default_worker (application_t * app)
933 return application_get_worker (app, 0);
937 application_n_workers (application_t * app)
939 return pool_elts (app->worker_maps);
943 application_listener_select_worker (session_t * ls)
948 app = application_get (ls->app_index);
949 al = app_listener_get (app, ls->al_index);
950 return app_listener_select_worker (app, al);
954 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
956 app_worker_map_t *wrk_map;
957 app_worker_t *app_wrk;
958 segment_manager_t *sm;
961 app_wrk = app_worker_alloc (app);
962 wrk_map = app_worker_map_alloc (app);
963 wrk_map->wrk_index = app_wrk->wrk_index;
964 app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
967 * Setup first segment manager
969 sm = segment_manager_alloc ();
970 sm->app_wrk_index = app_wrk->wrk_index;
972 if ((rv = segment_manager_init_first (sm)))
974 app_worker_free (app_wrk);
977 sm->first_is_protected = 1;
982 app_wrk->first_segment_manager = segment_manager_index (sm);
983 app_wrk->listeners_table = hash_create (0, sizeof (u64));
984 app_wrk->event_queue = segment_manager_event_queue (sm);
985 app_wrk->app_is_builtin = application_is_builtin (app);
993 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
996 app_worker_map_t *wrk_map;
997 app_worker_t *app_wrk;
998 segment_manager_t *sm;
1002 app = application_get (a->app_index);
1004 return VNET_API_ERROR_INVALID_VALUE;
1008 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1011 /* Map worker api index to the app */
1012 app_wrk->api_client_index = a->api_client_index;
1013 application_api_table_add (app->app_index, a->api_client_index);
1015 sm = segment_manager_get (app_wrk->first_segment_manager);
1016 fs = segment_manager_get_segment_w_lock (sm, 0);
1017 a->segment = &fs->ssvm;
1018 a->segment_handle = segment_manager_segment_handle (sm, fs);
1019 segment_manager_segment_reader_unlock (sm);
1020 a->evt_q = app_wrk->event_queue;
1021 a->wrk_map_index = app_wrk->wrk_map_index;
1025 wrk_map = app_worker_map_get (app, a->wrk_map_index);
1027 return VNET_API_ERROR_INVALID_VALUE;
1029 app_wrk = app_worker_get (wrk_map->wrk_index);
1031 return VNET_API_ERROR_INVALID_VALUE;
1033 application_api_table_del (app_wrk->api_client_index);
1034 app_worker_free (app_wrk);
1035 app_worker_map_free (app, wrk_map);
1036 if (application_n_workers (app) == 0)
1037 application_free (app);
1043 app_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
1045 app_namespace_t *app_ns;
1046 if (vec_len (namespace_id) == 0)
1048 /* Use default namespace */
1053 *app_ns_index = app_namespace_index_from_id (namespace_id);
1054 if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
1055 return VNET_API_ERROR_APP_INVALID_NS;
1056 app_ns = app_namespace_get (*app_ns_index);
1058 return VNET_API_ERROR_APP_INVALID_NS;
1059 if (app_ns->ns_secret != secret)
1060 return VNET_API_ERROR_APP_WRONG_NS_SECRET;
1065 app_name_from_api_index (u32 api_client_index)
1067 vl_api_registration_t *regp;
1068 regp = vl_api_client_index_to_registration (api_client_index);
1070 return format (0, "%s", regp->name);
1072 clib_warning ("api client index %u does not have an api registration!",
1074 return format (0, "unknown");
1078 * Attach application to vpp
1080 * Allocates a vpp app, i.e., a structure that keeps back pointers
1081 * to external app and a segment manager for shared memory fifo based
1082 * communication with the external app.
1085 vnet_application_attach (vnet_app_attach_args_t * a)
1088 application_t *app = 0;
1089 app_worker_t *app_wrk;
1090 segment_manager_t *sm;
1091 u32 app_ns_index = 0;
1096 if (a->api_client_index != APP_INVALID_INDEX)
1097 app = application_lookup (a->api_client_index);
1099 app = application_lookup_name (a->name);
1101 return VNET_API_ERROR_INVALID_VALUE;
1104 return VNET_API_ERROR_APP_ALREADY_ATTACHED;
1106 /* Socket api sets the name and validates namespace prior to attach */
1107 if (!a->use_sock_api)
1109 if (a->api_client_index != APP_INVALID_INDEX)
1111 app_name = app_name_from_api_index (a->api_client_index);
1115 secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
1116 if ((rv = app_validate_namespace (a->namespace_id, secret,
1119 a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
1122 if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
1125 app = application_get (a->app_index);
1126 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1129 a->app_evt_q = app_wrk->event_queue;
1130 app_wrk->api_client_index = a->api_client_index;
1131 sm = segment_manager_get (app_wrk->first_segment_manager);
1132 fs = segment_manager_get_segment_w_lock (sm, 0);
1134 if (application_is_proxy (app))
1136 application_setup_proxy (app);
1137 /* The segment manager pool is reallocated because a new listener
1138 * is added. Re-grab segment manager to avoid dangling reference */
1139 sm = segment_manager_get (app_wrk->first_segment_manager);
1142 ASSERT (vec_len (fs->ssvm.name) <= 128);
1143 a->segment = &fs->ssvm;
1144 a->segment_handle = segment_manager_segment_handle (sm, fs);
1146 segment_manager_segment_reader_unlock (sm);
1148 if (!application_is_builtin (app) && application_use_private_rx_mqs ())
1149 rv = app_rx_mqs_alloc (app);
1151 vec_free (app_name);
1156 * Detach application from vpp
1159 vnet_application_detach (vnet_app_detach_args_t * a)
1163 app = application_get_if_valid (a->app_index);
1166 clib_warning ("app not attached");
1167 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1170 app_interface_check_thread_and_barrier (vnet_application_detach, a);
1171 application_detach_process (app, a->api_client_index);
1177 session_endpoint_in_ns (session_endpoint_t * sep)
1179 u8 is_lep = session_endpoint_is_local (sep);
1180 if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
1181 && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
1183 clib_warning ("sw_if_index %u not configured with ip %U",
1184 sep->sw_if_index, format_ip46_address, &sep->ip,
1188 return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
1192 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
1193 application_t * app, u8 is_connect)
1195 app_namespace_t *app_ns;
1196 u32 ns_index, fib_index;
1198 ns_index = app->ns_index;
1200 /* App is a transport proto, so fetch the calling app's ns */
1201 if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
1202 ns_index = sep->ns_index;
1204 app_ns = app_namespace_get (ns_index);
1208 /* Ask transport and network to bind to/connect using local interface
1209 * that "supports" app's namespace. This will fix our local connection
1213 /* If in default namespace and user requested a fib index use it */
1214 if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
1215 fib_index = sep->fib_index;
1217 fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
1218 sep->peer.fib_index = fib_index;
1219 sep->fib_index = fib_index;
1223 sep->sw_if_index = app_ns->sw_if_index;
1227 if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
1228 && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
1229 && sep->peer.sw_if_index != app_ns->sw_if_index)
1230 clib_warning ("Local sw_if_index different from app ns sw_if_index");
1232 sep->peer.sw_if_index = app_ns->sw_if_index;
1237 vnet_listen (vnet_listen_args_t * a)
1239 app_listener_t *app_listener;
1240 app_worker_t *app_wrk;
1244 ASSERT (vlib_thread_is_main_w_barrier ());
1246 app = application_get_if_valid (a->app_index);
1248 return SESSION_E_NOAPP;
1250 app_wrk = application_get_worker (app, a->wrk_map_index);
1252 return SESSION_E_INVALID_APPWRK;
1254 a->sep_ext.app_wrk_index = app_wrk->wrk_index;
1256 session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
1257 if (!session_endpoint_in_ns (&a->sep))
1258 return SESSION_E_INVALID_NS;
1261 * Check if we already have an app listener
1263 app_listener = app_listener_lookup (app, &a->sep_ext);
1266 if (app_listener->app_index != app->app_index)
1267 return SESSION_E_ALREADY_LISTENING;
1268 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1270 a->handle = app_listener_handle (app_listener);
1275 * Create new app listener
1277 if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
1280 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1282 app_listener_cleanup (app_listener);
1286 a->handle = app_listener_handle (app_listener);
1291 vnet_connect (vnet_connect_args_t * a)
1293 app_worker_t *client_wrk;
1294 application_t *client;
1296 ASSERT (vlib_thread_is_main_w_barrier ());
1298 if (session_endpoint_is_zero (&a->sep))
1299 return SESSION_E_INVALID_RMT_IP;
1301 client = application_get (a->app_index);
1302 session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1303 client_wrk = application_get_worker (client, a->wrk_map_index);
1306 * First check the local scope for locally attached destinations.
1307 * If we have local scope, we pass *all* connects through it since we may
1308 * have special policy rules even for non-local destinations, think proxy.
1310 if (application_has_local_scope (client))
1314 a->sep_ext.original_tp = a->sep_ext.transport_proto;
1315 a->sep_ext.transport_proto = TRANSPORT_PROTO_NONE;
1316 rv = app_worker_connect_session (client_wrk, &a->sep, a->api_context);
1319 a->sep_ext.transport_proto = a->sep_ext.original_tp;
1322 * Not connecting to a local server, propagate to transport
1324 return app_worker_connect_session (client_wrk, &a->sep, a->api_context);
1328 vnet_unlisten (vnet_unlisten_args_t * a)
1330 app_worker_t *app_wrk;
1334 ASSERT (vlib_thread_is_main_w_barrier ());
1336 if (!(app = application_get_if_valid (a->app_index)))
1337 return SESSION_E_NOAPP;
1339 if (!(al = app_listener_get_w_handle (a->handle)))
1340 return SESSION_E_NOLISTEN;
1342 if (al->app_index != app->app_index)
1344 clib_warning ("app doesn't own handle %llu!", a->handle);
1345 return SESSION_E_OWNER;
1348 app_wrk = application_get_worker (app, a->wrk_map_index);
1351 clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1352 return SESSION_E_INVALID_APPWRK;
1355 return app_worker_stop_listen (app_wrk, al);
1359 vnet_disconnect_session (vnet_disconnect_args_t * a)
1361 app_worker_t *app_wrk;
1364 s = session_get_from_handle_if_valid (a->handle);
1366 return SESSION_E_NOSESSION;
1368 app_wrk = app_worker_get (s->app_wrk_index);
1369 if (app_wrk->app_index != a->app_index)
1370 return SESSION_E_OWNER;
1372 /* We're peeking into another's thread pool. Make sure */
1373 ASSERT (s->session_index == session_index_from_handle (a->handle));
1380 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1382 app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1383 app_listener_t *app_listener;
1388 return SESSION_E_INVALID_APPWRK;
1390 hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1391 if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1393 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1395 app = application_get (old_wrk->app_index);
1397 return SESSION_E_NOAPP;
1399 app_listener = app_listener_get (app, s->al_index);
1401 /* Only remove from lb for now */
1402 app_listener->workers = clib_bitmap_set (app_listener->workers,
1403 old_wrk->wrk_map_index, 0);
1405 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1408 s->app_wrk_index = app_wrk->wrk_index;
1414 application_is_proxy (application_t * app)
1416 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1420 application_is_builtin (application_t * app)
1422 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1426 application_is_builtin_proxy (application_t * app)
1428 return (application_is_proxy (app) && application_is_builtin (app));
1432 application_has_local_scope (application_t * app)
1434 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1438 application_has_global_scope (application_t * app)
1440 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1443 static clib_error_t *
1444 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1445 u8 transport_proto, u8 is_start)
1447 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1448 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1449 session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1450 transport_connection_t *tc;
1451 app_worker_t *app_wrk;
1456 /* TODO decide if we want proxy to be enabled for all workers */
1457 app_wrk = application_get_default_worker (app);
1460 s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1463 sep.is_ip4 = is_ip4;
1464 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1465 sep.sw_if_index = app_ns->sw_if_index;
1466 sep.transport_proto = transport_proto;
1467 sep.app_wrk_index = app_wrk->wrk_index; /* only default */
1469 /* force global scope listener */
1471 app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1472 app_listener_alloc_and_init (app, &sep, &al);
1475 app_worker_start_listen (app_wrk, al);
1476 s = listen_session_get (al->session_index);
1477 s->flags |= SESSION_F_PROXY;
1482 s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1486 tc = listen_session_get_transport (s);
1488 if (!ip_is_zero (&tc->lcl_ip, 1))
1491 sep.is_ip4 = is_ip4;
1492 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1493 sep.transport_proto = transport_proto;
1495 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1497 session_lookup_add_session_endpoint (sti,
1498 (session_endpoint_t *) & sep,
1501 session_lookup_del_session_endpoint (sti,
1502 (session_endpoint_t *) & sep);
1509 application_start_stop_proxy_local_scope (application_t * app,
1510 u8 transport_proto, u8 is_start)
1512 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1513 app_namespace_t *app_ns;
1514 app_ns = app_namespace_get (app->ns_index);
1516 sep.transport_proto = transport_proto;
1521 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1524 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1529 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1531 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1536 application_start_stop_proxy (application_t * app,
1537 transport_proto_t transport_proto, u8 is_start)
1539 if (application_has_local_scope (app))
1540 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1542 if (application_has_global_scope (app))
1544 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1545 transport_proto, is_start);
1546 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1547 transport_proto, is_start);
1552 application_setup_proxy (application_t * app)
1554 u16 transports = app->proxied_transports;
1555 transport_proto_t tp;
1557 ASSERT (application_is_proxy (app));
1560 transport_proto_foreach (tp, ({
1561 if (transports & (1 << tp))
1562 application_start_stop_proxy (app, tp, 1);
1568 application_remove_proxy (application_t * app)
1570 u16 transports = app->proxied_transports;
1571 transport_proto_t tp;
1573 ASSERT (application_is_proxy (app));
1576 transport_proto_foreach (tp, ({
1577 if (transports & (1 << tp))
1578 application_start_stop_proxy (app, tp, 0);
1583 segment_manager_props_t *
1584 application_segment_manager_properties (application_t * app)
1586 return &app->sm_properties;
1589 segment_manager_props_t *
1590 application_get_segment_manager_properties (u32 app_index)
1592 application_t *app = application_get (app_index);
1593 return &app->sm_properties;
1597 application_format_listeners (application_t * app, int verbose)
1599 vlib_main_t *vm = vlib_get_main ();
1600 app_worker_map_t *wrk_map;
1601 app_worker_t *app_wrk;
1607 vlib_cli_output (vm, "%U", format_app_worker_listener, 0 /* header */ ,
1613 pool_foreach (wrk_map, app->worker_maps) {
1614 app_wrk = app_worker_get (wrk_map->wrk_index);
1615 if (hash_elts (app_wrk->listeners_table) == 0)
1617 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1618 vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1619 handle, sm_index, verbose);
1626 application_format_connects (application_t * app, int verbose)
1628 app_worker_map_t *wrk_map;
1629 app_worker_t *app_wrk;
1633 app_worker_format_connects (0, verbose);
1638 pool_foreach (wrk_map, app->worker_maps) {
1639 app_wrk = app_worker_get (wrk_map->wrk_index);
1640 app_worker_format_connects (app_wrk, verbose);
1646 format_cert_key_pair (u8 * s, va_list * args)
1648 app_cert_key_pair_t *ckpair = va_arg (*args, app_cert_key_pair_t *);
1649 int key_len = 0, cert_len = 0;
1650 cert_len = vec_len (ckpair->cert);
1651 key_len = vec_len (ckpair->key);
1652 if (ckpair->cert_key_index == 0)
1653 s = format (s, "DEFAULT (cert:%d, key:%d)", cert_len, key_len);
1655 s = format (s, "%d (cert:%d, key:%d)", ckpair->cert_key_index,
1661 format_crypto_engine (u8 * s, va_list * args)
1663 u32 engine = va_arg (*args, u32);
1666 case CRYPTO_ENGINE_NONE:
1667 return format (s, "none");
1668 case CRYPTO_ENGINE_MBEDTLS:
1669 return format (s, "mbedtls");
1670 case CRYPTO_ENGINE_OPENSSL:
1671 return format (s, "openssl");
1672 case CRYPTO_ENGINE_PICOTLS:
1673 return format (s, "picotls");
1674 case CRYPTO_ENGINE_VPP:
1675 return format (s, "vpp");
1677 return format (s, "unknown engine");
1683 unformat_crypto_engine (unformat_input_t * input, va_list * args)
1685 u8 *a = va_arg (*args, u8 *);
1686 if (unformat (input, "mbedtls"))
1687 *a = CRYPTO_ENGINE_MBEDTLS;
1688 else if (unformat (input, "openssl"))
1689 *a = CRYPTO_ENGINE_OPENSSL;
1690 else if (unformat (input, "picotls"))
1691 *a = CRYPTO_ENGINE_PICOTLS;
1692 else if (unformat (input, "vpp"))
1693 *a = CRYPTO_ENGINE_VPP;
1700 format_crypto_context (u8 * s, va_list * args)
1702 crypto_context_t *crctx = va_arg (*args, crypto_context_t *);
1703 s = format (s, "[0x%x][sub%d,ckpair%x]", crctx->ctx_index,
1704 crctx->n_subscribers, crctx->ckpair_index);
1705 s = format (s, "[%U]", format_crypto_engine, crctx->crypto_engine);
1710 format_application (u8 * s, va_list * args)
1712 application_t *app = va_arg (*args, application_t *);
1713 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1714 segment_manager_props_t *props;
1715 const u8 *app_ns_name, *app_name;
1716 app_worker_map_t *wrk_map;
1717 app_worker_t *app_wrk;
1722 s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1726 app_name = app_get_name (app);
1727 app_ns_name = app_namespace_id_from_index (app->ns_index);
1728 props = application_segment_manager_properties (app);
1731 s = format (s, "%-10u%-20v%-40v", app->app_index, app_name,
1736 s = format (s, "app-name %v app-index %u ns-index %u seg-size %U\n",
1737 app_name, app->app_index, app->ns_index,
1738 format_memory_size, props->add_segment_size);
1739 s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1740 format_memory_size, props->rx_fifo_size,
1741 format_memory_size, props->tx_fifo_size);
1744 pool_foreach (wrk_map, app->worker_maps) {
1745 app_wrk = app_worker_get (wrk_map->wrk_index);
1746 s = format (s, "%U", format_app_worker, app_wrk);
1754 application_format_all_listeners (vlib_main_t * vm, int verbose)
1758 if (!pool_elts (app_main.app_pool))
1760 vlib_cli_output (vm, "No active server bindings");
1764 application_format_listeners (0, verbose);
1767 pool_foreach (app, app_main.app_pool) {
1768 application_format_listeners (app, verbose);
1774 application_format_all_clients (vlib_main_t * vm, int verbose)
1778 if (!pool_elts (app_main.app_pool))
1780 vlib_cli_output (vm, "No active apps");
1784 application_format_connects (0, verbose);
1787 pool_foreach (app, app_main.app_pool) {
1788 application_format_connects (app, verbose);
1793 static clib_error_t *
1794 show_certificate_command_fn (vlib_main_t * vm, unformat_input_t * input,
1795 vlib_cli_command_t * cmd)
1797 app_cert_key_pair_t *ckpair;
1798 session_cli_return_if_not_enabled ();
1801 pool_foreach (ckpair, app_main.cert_key_pair_store) {
1802 vlib_cli_output (vm, "%U", format_cert_key_pair, ckpair);
1809 appliction_format_app_mq (vlib_main_t * vm, application_t * app)
1811 app_worker_map_t *map;
1816 pool_foreach (map, app->worker_maps) {
1817 wrk = app_worker_get (map->wrk_index);
1818 vlib_cli_output (vm, "[A%d][%d]%U", app->app_index,
1819 map->wrk_index, format_svm_msg_q,
1824 for (i = 0; i < vec_len (app->rx_mqs); i++)
1825 vlib_cli_output (vm, "[A%d][R%d]%U", app->app_index, i, format_svm_msg_q,
1829 static clib_error_t *
1830 appliction_format_all_app_mq (vlib_main_t * vm)
1835 n_threads = vlib_get_n_threads ();
1837 for (i = 0; i < n_threads; i++)
1839 vlib_cli_output (vm, "[Ctrl%d]%U", i, format_svm_msg_q,
1840 session_main_get_vpp_event_queue (i));
1844 pool_foreach (app, app_main.app_pool) {
1845 appliction_format_app_mq (vm, app);
1851 static clib_error_t *
1852 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1853 vlib_cli_command_t * cmd)
1855 int do_server = 0, do_client = 0, do_mq = 0;
1860 session_cli_return_if_not_enabled ();
1862 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1864 if (unformat (input, "server"))
1866 else if (unformat (input, "client"))
1868 else if (unformat (input, "mq"))
1870 else if (unformat (input, "%u", &app_index))
1872 else if (unformat (input, "verbose"))
1875 return clib_error_return (0, "unknown input `%U'",
1876 format_unformat_error, input);
1879 if (do_mq && app_index != ~0)
1881 app = application_get_if_valid (app_index);
1883 return clib_error_return (0, "No app with index %u", app_index);
1885 appliction_format_app_mq (vm, app);
1891 appliction_format_all_app_mq (vm);
1897 application_format_all_listeners (vm, verbose);
1903 application_format_all_clients (vm, verbose);
1907 if (app_index != ~0)
1909 app = application_get_if_valid (app_index);
1911 return clib_error_return (0, "No app with index %u", app_index);
1913 vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
1917 /* Print app related info */
1918 if (!do_server && !do_client)
1920 vlib_cli_output (vm, "%U", format_application, 0, 0);
1922 pool_foreach (app, app_main.app_pool) {
1923 vlib_cli_output (vm, "%U", format_application, app, 0);
1931 /* Certificate store */
1933 static app_cert_key_pair_t *
1934 app_cert_key_pair_alloc ()
1936 app_cert_key_pair_t *ckpair;
1937 pool_get (app_main.cert_key_pair_store, ckpair);
1938 clib_memset (ckpair, 0, sizeof (*ckpair));
1939 ckpair->cert_key_index = ckpair - app_main.cert_key_pair_store;
1943 app_cert_key_pair_t *
1944 app_cert_key_pair_get_if_valid (u32 index)
1946 if (pool_is_free_index (app_main.cert_key_pair_store, index))
1948 return app_cert_key_pair_get (index);
1951 app_cert_key_pair_t *
1952 app_cert_key_pair_get (u32 index)
1954 return pool_elt_at_index (app_main.cert_key_pair_store, index);
1957 app_cert_key_pair_t *
1958 app_cert_key_pair_get_default ()
1960 /* To maintain legacy bapi */
1961 return app_cert_key_pair_get (0);
1965 vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a)
1967 app_cert_key_pair_t *ckpair = app_cert_key_pair_alloc ();
1968 vec_validate (ckpair->cert, a->cert_len - 1);
1969 clib_memcpy_fast (ckpair->cert, a->cert, a->cert_len);
1970 vec_validate (ckpair->key, a->key_len - 1);
1971 clib_memcpy_fast (ckpair->key, a->key, a->key_len);
1972 a->index = ckpair->cert_key_index;
1977 vnet_app_add_cert_key_interest (u32 index, u32 app_index)
1979 app_cert_key_pair_t *ckpair;
1980 if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
1982 if (vec_search (ckpair->app_interests, app_index) != ~0)
1983 vec_add1 (ckpair->app_interests, app_index);
1988 vnet_app_del_cert_key_pair (u32 index)
1990 app_cert_key_pair_t *ckpair;
1994 if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
1995 return (VNET_API_ERROR_INVALID_VALUE);
1997 vec_foreach (app_index, ckpair->app_interests)
1999 if ((app = application_get_if_valid (*app_index))
2000 && app->cb_fns.app_cert_key_pair_delete_callback)
2001 app->cb_fns.app_cert_key_pair_delete_callback (ckpair);
2004 vec_free (ckpair->cert);
2005 vec_free (ckpair->key);
2006 pool_put (app_main.cert_key_pair_store, ckpair);
2011 application_init (vlib_main_t * vm)
2013 app_main_t *am = &app_main;
2016 n_workers = vlib_num_workers ();
2018 /* Index 0 was originally used by legacy apis, maintain as invalid */
2019 (void) app_cert_key_pair_alloc ();
2020 am->last_crypto_engine = CRYPTO_ENGINE_LAST;
2021 am->app_by_name = hash_create_vec (0, sizeof (u8), sizeof (uword));
2023 vec_validate (am->wrk, n_workers);
2029 VLIB_INIT_FUNCTION (application_init);
2031 VLIB_CLI_COMMAND (show_app_command, static) =
2034 .short_help = "show app [app_id] [server|client] [mq] [verbose]",
2035 .function = show_app_command_fn,
2038 VLIB_CLI_COMMAND (show_certificate_command, static) =
2040 .path = "show app certificate",
2041 .short_help = "list app certs and keys present in store",
2042 .function = show_certificate_command_fn,
2046 crypto_engine_type_t
2047 app_crypto_engine_type_add (void)
2049 return (++app_main.last_crypto_engine);
2053 app_crypto_engine_n_types (void)
2055 return (app_main.last_crypto_engine + 1);
2059 * fd.io coding-style-patch-verification: ON
2062 * eval: (c-set-style "gnu")