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 ip46_address_t original_ip;
107 sep = (session_endpoint_t *) sep_ext;
108 if (application_has_local_scope (app) && session_endpoint_is_local (sep))
110 table_index = application_local_session_table (app);
111 handle = session_lookup_endpoint_listener (table_index, sep, 1);
112 if (handle != SESSION_INVALID_HANDLE)
114 ls = listen_session_get_from_handle (handle);
115 return app_listener_get_w_session (ls);
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)
124 ls = listen_session_get_from_handle (handle);
125 return app_listener_get_w_session ((session_t *) ls);
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.
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)
137 if ((iface_ip = ip_interface_get_first_ip (sep_ext->sw_if_index,
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)
146 ls = listen_session_get_from_handle (handle);
147 return app_listener_get_w_session ((session_t *) ls);
156 app_listener_alloc_and_init (application_t * app,
157 session_endpoint_cfg_t * sep,
158 app_listener_t ** listener)
160 app_listener_t *app_listener;
161 transport_connection_t *tc;
162 u32 al_index, table_index;
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);
173 * Add session endpoint to local session table. Only binds to "inaddr_any"
174 * (i.e., zero address) are added to local scope table.
176 if (application_has_local_scope (app)
177 && session_endpoint_is_local ((session_endpoint_t *) sep))
179 session_type_t local_st;
181 local_st = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE,
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);
188 if ((rv = session_listen (ls, sep)))
190 ls = session_get_from_handle (lh);
192 app_listener_free (app, app_listener);
196 ls = session_get_from_handle (lh);
197 app_listener = app_listener_get (app, al_index);
198 app_listener->local_index = ls->session_index;
199 app_listener->ls_handle = lh;
200 ls->al_index = al_index;
202 table_index = application_local_session_table (app);
203 session_lookup_add_session_endpoint (table_index,
204 (session_endpoint_t *) sep, lh);
207 if (application_has_global_scope (app))
210 * Start listening on local endpoint for requested transport and scope.
211 * Creates a stream session with state LISTENING to be used in session
212 * lookups, prior to establishing connection. Requests transport to
213 * build it's own specific listening connection.
215 ls = listen_session_alloc (0, st);
216 ls->app_index = app->app_index;
217 ls->app_wrk_index = sep->app_wrk_index;
219 /* Listen pool can be reallocated if the transport is
221 lh = listen_session_get_handle (ls);
223 if ((rv = session_listen (ls, sep)))
225 ls = listen_session_get_from_handle (lh);
227 app_listener_free (app, app_listener);
230 ls = listen_session_get_from_handle (lh);
231 app_listener = app_listener_get (app, al_index);
232 app_listener->session_index = ls->session_index;
233 app_listener->ls_handle = lh;
234 ls->al_index = al_index;
236 /* Add to the global lookup table after transport was initialized.
237 * Lookup table needs to be populated only now because sessions
238 * with cut-through transport are are added to app local tables that
239 * are not related to network fibs, i.e., cannot be added as
241 tc = session_get_transport (ls);
242 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
244 fib_protocol_t fib_proto;
245 fib_proto = session_endpoint_fib_proto ((session_endpoint_t *) sep);
246 /* Assume namespace vetted previously so make sure table exists */
247 table_index = session_lookup_get_or_alloc_index_for_fib (
248 fib_proto, sep->fib_index);
249 session_lookup_add_session_endpoint (table_index,
250 (session_endpoint_t *) sep,
257 app_listener_free (app, app_listener);
261 *listener = app_listener;
266 app_listener_cleanup (app_listener_t * al)
268 application_t *app = application_get (al->app_index);
271 if (al->session_index != SESSION_INVALID_INDEX)
273 ls = session_get (al->session_index, 0);
274 session_stop_listen (ls);
275 listen_session_free (ls);
277 if (al->local_index != SESSION_INVALID_INDEX)
279 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
282 table_index = application_local_session_table (app);
283 ls = listen_session_get (al->local_index);
284 ct_session_endpoint (ls, &sep);
285 session_lookup_del_session_endpoint (table_index, &sep);
286 session_stop_listen (ls);
287 listen_session_free (ls);
289 app_listener_free (app, al);
292 static app_worker_t *
293 app_listener_select_worker (application_t * app, app_listener_t * al)
297 app = application_get (al->app_index);
298 wrk_index = clib_bitmap_next_set (al->workers, al->accept_rotor + 1);
300 wrk_index = clib_bitmap_first_set (al->workers);
302 ASSERT (wrk_index != ~0);
303 al->accept_rotor = wrk_index;
304 return application_get_worker (app, wrk_index);
308 app_listener_get_session (app_listener_t * al)
310 if (al->session_index == SESSION_INVALID_INDEX)
313 return listen_session_get (al->session_index);
317 app_listener_get_local_session (app_listener_t * al)
319 if (al->local_index == SESSION_INVALID_INDEX)
321 return listen_session_get (al->local_index);
324 static app_worker_map_t *
325 app_worker_map_alloc (application_t * app)
327 app_worker_map_t *map;
328 pool_get (app->worker_maps, map);
329 clib_memset (map, 0, sizeof (*map));
334 app_worker_map_index (application_t * app, app_worker_map_t * map)
336 return (map - app->worker_maps);
340 app_worker_map_free (application_t * app, app_worker_map_t * map)
342 pool_put (app->worker_maps, map);
345 static app_worker_map_t *
346 app_worker_map_get (application_t * app, u32 map_index)
348 if (pool_is_free_index (app->worker_maps, map_index))
350 return pool_elt_at_index (app->worker_maps, map_index);
354 app_get_name (application_t * app)
360 application_session_table (application_t * app, u8 fib_proto)
362 app_namespace_t *app_ns;
363 app_ns = app_namespace_get (app->ns_index);
364 if (!application_has_global_scope (app))
365 return APP_INVALID_INDEX;
366 if (fib_proto == FIB_PROTOCOL_IP4)
367 return session_lookup_get_index_for_fib (fib_proto,
368 app_ns->ip4_fib_index);
370 return session_lookup_get_index_for_fib (fib_proto,
371 app_ns->ip6_fib_index);
375 application_local_session_table (application_t * app)
377 app_namespace_t *app_ns;
378 if (!application_has_local_scope (app))
379 return APP_INVALID_INDEX;
380 app_ns = app_namespace_get (app->ns_index);
381 return app_ns->local_table_index;
385 * Returns app name for app-index
388 application_name_from_index (u32 app_index)
390 application_t *app = application_get (app_index);
393 return app_get_name (app);
397 application_api_table_add (u32 app_index, u32 api_client_index)
399 if (api_client_index != APP_INVALID_INDEX)
400 hash_set (app_main.app_by_api_client_index, api_client_index, app_index);
404 application_api_table_del (u32 api_client_index)
406 hash_unset (app_main.app_by_api_client_index, api_client_index);
410 application_name_table_add (application_t * app)
412 hash_set_mem (app_main.app_by_name, app->name, app->app_index);
416 application_name_table_del (application_t * app)
418 hash_unset_mem (app_main.app_by_name, app->name);
422 application_lookup (u32 api_client_index)
425 p = hash_get (app_main.app_by_api_client_index, api_client_index);
427 return application_get_if_valid (p[0]);
433 application_lookup_name (const u8 * name)
436 p = hash_get_mem (app_main.app_by_name, name);
438 return application_get (p[0]);
444 appsl_pending_rx_mqs_add_tail (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
446 app_rx_mq_elt_t *head;
448 if (!aw->pending_rx_mqs)
450 elt->next = elt->prev = elt;
451 aw->pending_rx_mqs = elt;
455 head = aw->pending_rx_mqs;
457 ASSERT (head != elt);
459 elt->prev = head->prev;
462 head->prev->next = elt;
467 appsl_pending_rx_mqs_del (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
469 if (elt->next == elt)
471 elt->next = elt->prev = 0;
472 aw->pending_rx_mqs = 0;
476 if (elt == aw->pending_rx_mqs)
477 aw->pending_rx_mqs = elt->next;
479 elt->next->prev = elt->prev;
480 elt->prev->next = elt->next;
481 elt->next = elt->prev = 0;
484 vlib_node_registration_t appsl_rx_mqs_input_node;
486 VLIB_NODE_FN (appsl_rx_mqs_input_node)
487 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
489 u32 thread_index = vm->thread_index, n_msgs = 0;
490 app_rx_mq_elt_t *elt, *next;
491 app_main_t *am = &app_main;
492 session_worker_t *wrk;
493 int __clib_unused rv;
497 aw = &am->wrk[thread_index];
498 elt = aw->pending_rx_mqs;
502 wrk = session_main_get_worker (thread_index);
506 if (!(elt->flags & APP_RX_MQ_F_POSTPONED))
507 rv = read (svm_msg_q_get_eventfd (elt->mq), &buf, sizeof (buf));
508 n_msgs += session_wrk_handle_mq (wrk, elt->mq);
511 appsl_pending_rx_mqs_del (aw, elt);
512 if (!svm_msg_q_is_empty (elt->mq))
514 elt->flags |= APP_RX_MQ_F_POSTPONED;
515 appsl_pending_rx_mqs_add_tail (aw, elt);
523 while (aw->pending_rx_mqs && elt != aw->pending_rx_mqs);
525 if (aw->pending_rx_mqs)
526 vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
528 if (n_msgs && wrk->state == SESSION_WRK_INTERRUPT)
529 vlib_node_set_interrupt_pending (vm, session_queue_node.index);
534 VLIB_REGISTER_NODE (appsl_rx_mqs_input_node) = {
535 .name = "appsl-rx-mqs-input",
536 .type = VLIB_NODE_TYPE_INPUT,
537 .state = VLIB_NODE_STATE_DISABLED,
540 static clib_error_t *
541 app_rx_mq_fd_read_ready (clib_file_t *cf)
543 app_rx_mq_handle_t *handle = (app_rx_mq_handle_t *) &cf->private_data;
544 vlib_main_t *vm = vlib_get_main ();
545 app_main_t *am = &app_main;
546 app_rx_mq_elt_t *mqe;
550 ASSERT (vlib_get_thread_index () == handle->thread_index);
551 app = application_get_if_valid (handle->app_index);
555 mqe = &app->rx_mqs[handle->thread_index];
556 if ((mqe->flags & APP_RX_MQ_F_PENDING) || svm_msg_q_is_empty (mqe->mq))
559 aw = &am->wrk[handle->thread_index];
560 appsl_pending_rx_mqs_add_tail (aw, mqe);
561 mqe->flags |= APP_RX_MQ_F_PENDING;
563 vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
568 static clib_error_t *
569 app_rx_mq_fd_write_ready (clib_file_t *cf)
571 clib_warning ("should not be called");
576 app_rx_mqs_epoll_add (application_t *app, app_rx_mq_elt_t *mqe)
578 clib_file_t template = { 0 };
579 app_rx_mq_handle_t handle;
583 thread_index = mqe - app->rx_mqs;
584 fd = svm_msg_q_get_eventfd (mqe->mq);
586 handle.app_index = app->app_index;
587 handle.thread_index = thread_index;
589 template.read_function = app_rx_mq_fd_read_ready;
590 template.write_function = app_rx_mq_fd_write_ready;
591 template.file_descriptor = fd;
592 template.private_data = handle.as_u64;
593 template.polling_thread_index = thread_index;
594 template.description =
595 format (0, "app-%u-rx-mq-%u", app->app_index, thread_index);
596 mqe->file_index = clib_file_add (&file_main, &template);
600 app_rx_mqs_epoll_del (application_t *app, app_rx_mq_elt_t *mqe)
602 u32 thread_index = mqe - app->rx_mqs;
603 app_main_t *am = &app_main;
606 aw = &am->wrk[thread_index];
608 session_wrk_handle_mq (session_main_get_worker (thread_index), mqe->mq);
610 if (mqe->flags & APP_RX_MQ_F_PENDING)
611 appsl_pending_rx_mqs_del (aw, mqe);
613 clib_file_del_by_index (&file_main, mqe->file_index);
617 application_rx_mq_get (application_t *app, u32 mq_index)
622 return app->rx_mqs[mq_index].mq;
626 app_rx_mqs_alloc (application_t *app)
628 u32 evt_q_length, evt_size = sizeof (session_event_t);
629 fifo_segment_t *eqs = &app->rx_mqs_segment;
630 u32 n_mqs = vlib_num_workers () + 1;
631 segment_manager_props_t *props;
634 props = application_segment_manager_properties (app);
635 evt_q_length = clib_max (props->evt_q_size, 128);
637 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
638 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
639 { evt_q_length, evt_size, 0 }, { evt_q_length >> 1, 256, 0 }
641 cfg->consumer_pid = 0;
643 cfg->q_nitems = evt_q_length;
646 eqs->ssvm.ssvm_size = svm_msg_q_size_to_alloc (cfg) * n_mqs + (1 << 20);
647 eqs->ssvm.name = format (0, "%v-rx-mqs-seg%c", app->name, 0);
649 if (ssvm_server_init (&eqs->ssvm, SSVM_SEGMENT_MEMFD))
651 clib_warning ("failed to initialize queue segment");
652 return SESSION_E_SEG_CREATE;
655 fifo_segment_init (eqs);
657 /* Fifo segment filled only with mqs */
658 eqs->h->n_mqs = n_mqs;
659 vec_validate (app->rx_mqs, n_mqs - 1);
661 for (i = 0; i < n_mqs; i++)
663 app->rx_mqs[i].mq = fifo_segment_msg_q_alloc (eqs, i, cfg);
664 if (svm_msg_q_alloc_eventfd (app->rx_mqs[i].mq))
666 clib_warning ("eventfd returned");
667 fifo_segment_cleanup (eqs);
668 ssvm_delete (&eqs->ssvm);
669 return SESSION_E_EVENTFD_ALLOC;
671 app_rx_mqs_epoll_add (app, &app->rx_mqs[i]);
672 app->rx_mqs[i].app_index = app->app_index;
679 application_use_private_rx_mqs (void)
681 return session_main.use_private_rx_mqs;
685 application_get_rx_mqs_segment (application_t *app)
687 if (application_use_private_rx_mqs ())
688 return &app->rx_mqs_segment;
689 return session_main_get_wrk_mqs_segment ();
693 application_enable_rx_mqs_nodes (u8 is_en)
695 u8 state = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
698 vlib_node_set_state (this_vlib_main, appsl_rx_mqs_input_node.index, state);
701 static application_t *
702 application_alloc (void)
705 pool_get (app_main.app_pool, app);
706 clib_memset (app, 0, sizeof (*app));
707 app->app_index = app - app_main.app_pool;
712 application_get (u32 app_index)
714 if (app_index == APP_INVALID_INDEX)
716 return pool_elt_at_index (app_main.app_pool, app_index);
720 application_get_if_valid (u32 app_index)
722 if (pool_is_free_index (app_main.app_pool, app_index))
725 return pool_elt_at_index (app_main.app_pool, app_index);
729 application_verify_cb_fns (session_cb_vft_t * cb_fns)
731 if (cb_fns->session_accept_callback == 0)
732 clib_warning ("No accept callback function provided");
733 if (cb_fns->session_connected_callback == 0)
734 clib_warning ("No session connected callback function provided");
735 if (cb_fns->session_disconnect_callback == 0)
736 clib_warning ("No session disconnect callback function provided");
737 if (cb_fns->session_reset_callback == 0)
738 clib_warning ("No session reset callback function provided");
742 * Check app config for given segment type
744 * Returns 1 on success and 0 otherwise
747 application_verify_cfg (ssvm_segment_type_t st)
750 if (st == SSVM_SEGMENT_MEMFD)
752 is_valid = (session_main_get_wrk_mqs_segment () != 0);
754 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
757 else if (st == SSVM_SEGMENT_SHM)
759 is_valid = (session_main_get_wrk_mqs_segment () == 0);
761 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
769 application_alloc_and_init (app_init_args_t * a)
771 ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
772 segment_manager_props_t *props;
776 app = application_alloc ();
779 * Make sure we support the requested configuration
781 if ((opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN) &&
782 !(opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_MEMFD_FOR_BUILTIN))
783 seg_type = SSVM_SEGMENT_PRIVATE;
785 if ((opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD) &&
786 seg_type != SSVM_SEGMENT_MEMFD)
788 clib_warning ("mq eventfds can only be used if socket transport is "
789 "used for binary api");
790 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
793 if (!application_verify_cfg (seg_type))
794 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
796 if (opts[APP_OPTIONS_PREALLOC_FIFO_PAIRS] &&
797 opts[APP_OPTIONS_PREALLOC_FIFO_HDRS])
798 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
800 /* Check that the obvious things are properly set up */
801 application_verify_cb_fns (a->session_cb_vft);
803 app->flags = opts[APP_OPTIONS_FLAGS];
804 app->cb_fns = *a->session_cb_vft;
805 app->ns_index = opts[APP_OPTIONS_NAMESPACE];
806 app->proxied_transports = opts[APP_OPTIONS_PROXY_TRANSPORT];
807 app->name = vec_dup (a->name);
809 /* If no scope enabled, default to global */
810 if (!application_has_global_scope (app)
811 && !application_has_local_scope (app))
812 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
814 props = application_segment_manager_properties (app);
815 segment_manager_props_init (props);
816 props->segment_size = opts[APP_OPTIONS_SEGMENT_SIZE];
817 props->prealloc_fifos = opts[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
818 props->prealloc_fifo_hdrs = opts[APP_OPTIONS_PREALLOC_FIFO_HDRS];
819 if (opts[APP_OPTIONS_ADD_SEGMENT_SIZE])
821 props->add_segment_size = opts[APP_OPTIONS_ADD_SEGMENT_SIZE];
822 props->add_segment = 1;
824 if (opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_USE_HUGE_PAGE)
825 props->huge_page = 1;
826 if (opts[APP_OPTIONS_RX_FIFO_SIZE])
827 props->rx_fifo_size = opts[APP_OPTIONS_RX_FIFO_SIZE];
828 if (opts[APP_OPTIONS_TX_FIFO_SIZE])
829 props->tx_fifo_size = opts[APP_OPTIONS_TX_FIFO_SIZE];
830 if (opts[APP_OPTIONS_EVT_QUEUE_SIZE])
831 props->evt_q_size = opts[APP_OPTIONS_EVT_QUEUE_SIZE];
832 if (opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
833 props->use_mq_eventfd = 1;
834 if (opts[APP_OPTIONS_TLS_ENGINE])
835 app->tls_engine = opts[APP_OPTIONS_TLS_ENGINE];
836 if (opts[APP_OPTIONS_MAX_FIFO_SIZE])
837 props->max_fifo_size = opts[APP_OPTIONS_MAX_FIFO_SIZE];
838 if (opts[APP_OPTIONS_HIGH_WATERMARK])
839 props->high_watermark = opts[APP_OPTIONS_HIGH_WATERMARK];
840 if (opts[APP_OPTIONS_LOW_WATERMARK])
841 props->low_watermark = opts[APP_OPTIONS_LOW_WATERMARK];
842 if (opts[APP_OPTIONS_PCT_FIRST_ALLOC])
843 props->pct_first_alloc = opts[APP_OPTIONS_PCT_FIRST_ALLOC];
844 props->segment_type = seg_type;
846 /* Add app to lookup by api_client_index table */
847 if (!application_is_builtin (app))
848 application_api_table_add (app->app_index, a->api_client_index);
850 application_name_table_add (app);
852 a->app_index = app->app_index;
854 APP_DBG ("New app name: %v api index: %u index %u", app->name,
855 a->api_client_index, app->app_index);
861 application_free (application_t * app)
863 app_worker_map_t *wrk_map;
864 app_worker_t *app_wrk;
867 * The app event queue allocated in first segment is cleared with
868 * the segment manager. No need to explicitly free it.
870 APP_DBG ("Delete app name %v index: %d", app->name, app->app_index);
872 if (application_is_proxy (app))
873 application_remove_proxy (app);
880 pool_flush (wrk_map, app->worker_maps, ({
881 app_wrk = app_worker_get (wrk_map->wrk_index);
882 app_worker_free (app_wrk);
885 pool_free (app->worker_maps);
888 * Free rx mqs if allocated
893 for (i = 0; i < vec_len (app->rx_mqs); i++)
894 app_rx_mqs_epoll_del (app, &app->rx_mqs[i]);
896 fifo_segment_cleanup (&app->rx_mqs_segment);
897 ssvm_delete (&app->rx_mqs_segment.ssvm);
898 vec_free (app->rx_mqs);
902 * Cleanup remaining state
904 if (application_is_builtin (app))
905 application_name_table_del (app);
906 vec_free (app->name);
907 pool_put (app_main.app_pool, app);
911 application_detach_process (application_t * app, u32 api_client_index)
913 vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
914 app_worker_map_t *wrk_map;
915 u32 *wrks = 0, *wrk_index;
916 app_worker_t *app_wrk;
918 if (api_client_index == ~0)
920 application_free (app);
924 APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
925 app->app_index, api_client_index);
928 pool_foreach (wrk_map, app->worker_maps) {
929 app_wrk = app_worker_get (wrk_map->wrk_index);
930 if (app_wrk->api_client_index == api_client_index)
931 vec_add1 (wrks, app_wrk->wrk_index);
937 clib_warning ("no workers for app %u api_index %u", app->app_index,
942 args->app_index = app->app_index;
943 args->api_client_index = api_client_index;
944 vec_foreach (wrk_index, wrks)
946 app_wrk = app_worker_get (wrk_index[0]);
947 args->wrk_map_index = app_wrk->wrk_map_index;
949 vnet_app_worker_add_del (args);
955 application_namespace_cleanup (app_namespace_t *app_ns)
957 u32 *app_indices = 0, *app_index;
961 ns_index = app_namespace_index (app_ns);
962 pool_foreach (app, app_main.app_pool)
963 if (app->ns_index == ns_index)
964 vec_add1 (app_indices, app->ns_index);
966 vec_foreach (app_index, app_indices)
968 app = application_get (*app_index);
970 if (application_is_proxy (app))
971 application_remove_proxy (app);
972 app->flags &= ~APP_OPTIONS_FLAGS_IS_PROXY;
974 application_free (app);
976 vec_free (app_indices);
980 application_get_worker (application_t * app, u32 wrk_map_index)
982 app_worker_map_t *map;
983 map = app_worker_map_get (app, wrk_map_index);
986 return app_worker_get (map->wrk_index);
990 application_get_default_worker (application_t * app)
992 return application_get_worker (app, 0);
996 application_n_workers (application_t * app)
998 return pool_elts (app->worker_maps);
1002 application_listener_select_worker (session_t * ls)
1007 app = application_get (ls->app_index);
1008 al = app_listener_get (app, ls->al_index);
1009 return app_listener_select_worker (app, al);
1013 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
1015 app_worker_map_t *wrk_map;
1016 app_worker_t *app_wrk;
1017 segment_manager_t *sm;
1020 app_wrk = app_worker_alloc (app);
1021 wrk_map = app_worker_map_alloc (app);
1022 wrk_map->wrk_index = app_wrk->wrk_index;
1023 app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
1026 * Setup first segment manager
1028 sm = segment_manager_alloc ();
1029 sm->app_wrk_index = app_wrk->wrk_index;
1031 if ((rv = segment_manager_init_first (sm)))
1033 app_worker_free (app_wrk);
1036 sm->first_is_protected = 1;
1041 app_wrk->connects_seg_manager = segment_manager_index (sm);
1042 app_wrk->listeners_table = hash_create (0, sizeof (u64));
1043 app_wrk->event_queue = segment_manager_event_queue (sm);
1044 app_wrk->app_is_builtin = application_is_builtin (app);
1052 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
1055 app_worker_map_t *wrk_map;
1056 app_worker_t *app_wrk;
1057 segment_manager_t *sm;
1061 app = application_get (a->app_index);
1063 return VNET_API_ERROR_INVALID_VALUE;
1067 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1070 /* Map worker api index to the app */
1071 app_wrk->api_client_index = a->api_client_index;
1072 application_api_table_add (app->app_index, a->api_client_index);
1074 sm = segment_manager_get (app_wrk->connects_seg_manager);
1075 fs = segment_manager_get_segment_w_lock (sm, 0);
1076 a->segment = &fs->ssvm;
1077 a->segment_handle = segment_manager_segment_handle (sm, fs);
1078 segment_manager_segment_reader_unlock (sm);
1079 a->evt_q = app_wrk->event_queue;
1080 a->wrk_map_index = app_wrk->wrk_map_index;
1084 wrk_map = app_worker_map_get (app, a->wrk_map_index);
1086 return VNET_API_ERROR_INVALID_VALUE;
1088 app_wrk = app_worker_get (wrk_map->wrk_index);
1090 return VNET_API_ERROR_INVALID_VALUE;
1092 application_api_table_del (app_wrk->api_client_index);
1093 if (appns_sapi_enabled ())
1094 sapi_socket_close_w_handle (app_wrk->api_client_index);
1095 app_worker_free (app_wrk);
1096 app_worker_map_free (app, wrk_map);
1097 if (application_n_workers (app) == 0)
1098 application_free (app);
1104 app_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
1106 app_namespace_t *app_ns;
1107 if (vec_len (namespace_id) == 0)
1109 /* Use default namespace */
1114 *app_ns_index = app_namespace_index_from_id (namespace_id);
1115 if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
1116 return VNET_API_ERROR_APP_INVALID_NS;
1117 app_ns = app_namespace_get (*app_ns_index);
1119 return VNET_API_ERROR_APP_INVALID_NS;
1120 if (app_ns->ns_secret != secret)
1121 return VNET_API_ERROR_APP_WRONG_NS_SECRET;
1126 app_name_from_api_index (u32 api_client_index)
1128 vl_api_registration_t *regp;
1129 regp = vl_api_client_index_to_registration (api_client_index);
1131 return format (0, "%s", regp->name);
1133 clib_warning ("api client index %u does not have an api registration!",
1135 return format (0, "unknown");
1139 * Attach application to vpp
1141 * Allocates a vpp app, i.e., a structure that keeps back pointers
1142 * to external app and a segment manager for shared memory fifo based
1143 * communication with the external app.
1146 vnet_application_attach (vnet_app_attach_args_t * a)
1149 application_t *app = 0;
1150 app_worker_t *app_wrk;
1151 segment_manager_t *sm;
1152 u32 app_ns_index = 0;
1157 if (a->api_client_index != APP_INVALID_INDEX)
1158 app = application_lookup (a->api_client_index);
1160 app = application_lookup_name (a->name);
1162 return VNET_API_ERROR_INVALID_VALUE;
1165 return VNET_API_ERROR_APP_ALREADY_ATTACHED;
1167 /* Socket api sets the name and validates namespace prior to attach */
1168 if (!a->use_sock_api)
1170 if (a->api_client_index != APP_INVALID_INDEX)
1172 app_name = app_name_from_api_index (a->api_client_index);
1176 secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
1177 if ((rv = app_validate_namespace (a->namespace_id, secret,
1180 a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
1183 if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
1186 app = application_get (a->app_index);
1187 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1190 a->app_evt_q = app_wrk->event_queue;
1191 app_wrk->api_client_index = a->api_client_index;
1192 sm = segment_manager_get (app_wrk->connects_seg_manager);
1193 fs = segment_manager_get_segment_w_lock (sm, 0);
1195 if (application_is_proxy (app))
1197 application_setup_proxy (app);
1198 /* The segment manager pool is reallocated because a new listener
1199 * is added. Re-grab segment manager to avoid dangling reference */
1200 sm = segment_manager_get (app_wrk->connects_seg_manager);
1203 ASSERT (vec_len (fs->ssvm.name) <= 128);
1204 a->segment = &fs->ssvm;
1205 a->segment_handle = segment_manager_segment_handle (sm, fs);
1207 segment_manager_segment_reader_unlock (sm);
1209 if (!application_is_builtin (app) && application_use_private_rx_mqs ())
1210 rv = app_rx_mqs_alloc (app);
1212 vec_free (app_name);
1217 * Detach application from vpp
1220 vnet_application_detach (vnet_app_detach_args_t * a)
1224 app = application_get_if_valid (a->app_index);
1227 clib_warning ("app not attached");
1228 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1231 app_interface_check_thread_and_barrier (vnet_application_detach, a);
1232 application_detach_process (app, a->api_client_index);
1237 session_endpoint_in_ns (session_endpoint_cfg_t *sep)
1241 if (sep->flags & SESSION_ENDPT_CFG_F_PROXY_LISTEN)
1244 is_lep = session_endpoint_is_local ((session_endpoint_t *) sep);
1245 if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
1246 && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
1248 clib_warning ("sw_if_index %u not configured with ip %U",
1249 sep->sw_if_index, format_ip46_address, &sep->ip,
1254 return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
1258 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
1259 application_t * app, u8 is_connect)
1261 app_namespace_t *app_ns;
1262 u32 ns_index, fib_index;
1264 ns_index = app->ns_index;
1266 /* App is a transport proto, so fetch the calling app's ns */
1267 if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
1268 ns_index = sep->ns_index;
1270 app_ns = app_namespace_get (ns_index);
1274 /* Ask transport and network to bind to/connect using local interface
1275 * that "supports" app's namespace. This will fix our local connection
1279 /* If in default namespace and user requested a fib index use it */
1280 if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
1281 fib_index = sep->fib_index;
1283 fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
1284 sep->peer.fib_index = fib_index;
1285 sep->fib_index = fib_index;
1289 sep->sw_if_index = app_ns->sw_if_index;
1293 if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
1294 && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
1295 && sep->peer.sw_if_index != app_ns->sw_if_index)
1296 clib_warning ("Local sw_if_index different from app ns sw_if_index");
1298 sep->peer.sw_if_index = app_ns->sw_if_index;
1303 vnet_listen (vnet_listen_args_t * a)
1305 app_listener_t *app_listener;
1306 app_worker_t *app_wrk;
1310 ASSERT (vlib_thread_is_main_w_barrier ());
1312 app = application_get_if_valid (a->app_index);
1314 return SESSION_E_NOAPP;
1316 app_wrk = application_get_worker (app, a->wrk_map_index);
1318 return SESSION_E_INVALID_APPWRK;
1320 a->sep_ext.app_wrk_index = app_wrk->wrk_index;
1322 session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
1323 if (!session_endpoint_in_ns (&a->sep_ext))
1324 return SESSION_E_INVALID_NS;
1327 * Check if we already have an app listener
1329 app_listener = app_listener_lookup (app, &a->sep_ext);
1332 if (app_listener->app_index != app->app_index)
1333 return SESSION_E_ALREADY_LISTENING;
1334 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1336 a->handle = app_listener_handle (app_listener);
1341 * Create new app listener
1343 if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
1346 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1348 app_listener_cleanup (app_listener);
1352 a->handle = app_listener_handle (app_listener);
1357 vnet_connect (vnet_connect_args_t * a)
1359 app_worker_t *client_wrk;
1360 application_t *client;
1362 ASSERT (session_vlib_thread_is_cl_thread ());
1364 if (session_endpoint_is_zero (&a->sep))
1365 return SESSION_E_INVALID_RMT_IP;
1367 client = application_get (a->app_index);
1368 session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1369 client_wrk = application_get_worker (client, a->wrk_map_index);
1371 a->sep_ext.opaque = a->api_context;
1374 * First check the local scope for locally attached destinations.
1375 * If we have local scope, we pass *all* connects through it since we may
1376 * have special policy rules even for non-local destinations, think proxy.
1378 if (application_has_local_scope (client))
1382 a->sep_ext.original_tp = a->sep_ext.transport_proto;
1383 a->sep_ext.transport_proto = TRANSPORT_PROTO_NONE;
1384 rv = app_worker_connect_session (client_wrk, &a->sep_ext, &a->sh);
1385 a->sep_ext.transport_proto = a->sep_ext.original_tp;
1386 if (!rv || rv != SESSION_E_LOCAL_CONNECT)
1390 * Not connecting to a local server, propagate to transport
1392 return app_worker_connect_session (client_wrk, &a->sep_ext, &a->sh);
1396 vnet_unlisten (vnet_unlisten_args_t * a)
1398 app_worker_t *app_wrk;
1402 ASSERT (vlib_thread_is_main_w_barrier ());
1404 if (!(app = application_get_if_valid (a->app_index)))
1405 return SESSION_E_NOAPP;
1407 if (!(al = app_listener_get_w_handle (a->handle)))
1408 return SESSION_E_NOLISTEN;
1410 if (al->app_index != app->app_index)
1412 clib_warning ("app doesn't own handle %llu!", a->handle);
1413 return SESSION_E_OWNER;
1416 app_wrk = application_get_worker (app, a->wrk_map_index);
1419 clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1420 return SESSION_E_INVALID_APPWRK;
1423 return app_worker_stop_listen (app_wrk, al);
1427 vnet_shutdown_session (vnet_shutdown_args_t *a)
1429 app_worker_t *app_wrk;
1432 s = session_get_from_handle_if_valid (a->handle);
1434 return SESSION_E_NOSESSION;
1436 app_wrk = app_worker_get (s->app_wrk_index);
1437 if (app_wrk->app_index != a->app_index)
1438 return SESSION_E_OWNER;
1440 /* We're peeking into another's thread pool. Make sure */
1441 ASSERT (s->session_index == session_index_from_handle (a->handle));
1443 session_half_close (s);
1448 vnet_disconnect_session (vnet_disconnect_args_t * a)
1450 app_worker_t *app_wrk;
1453 s = session_get_from_handle_if_valid (a->handle);
1455 return SESSION_E_NOSESSION;
1457 app_wrk = app_worker_get (s->app_wrk_index);
1458 if (app_wrk->app_index != a->app_index)
1459 return SESSION_E_OWNER;
1461 /* We're peeking into another's thread pool. Make sure */
1462 ASSERT (s->session_index == session_index_from_handle (a->handle));
1469 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1471 app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1472 app_listener_t *app_listener;
1477 return SESSION_E_INVALID_APPWRK;
1479 hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1480 if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1482 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1484 app = application_get (old_wrk->app_index);
1486 return SESSION_E_NOAPP;
1488 app_listener = app_listener_get (app, s->al_index);
1490 /* Only remove from lb for now */
1491 app_listener->workers = clib_bitmap_set (app_listener->workers,
1492 old_wrk->wrk_map_index, 0);
1494 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1497 s->app_wrk_index = app_wrk->wrk_index;
1503 application_is_proxy (application_t * app)
1505 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1509 application_is_builtin (application_t * app)
1511 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1515 application_is_builtin_proxy (application_t * app)
1517 return (application_is_proxy (app) && application_is_builtin (app));
1521 application_has_local_scope (application_t * app)
1523 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1527 application_has_global_scope (application_t * app)
1529 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1533 application_original_dst_is_enabled (application_t *app)
1535 return app->flags & APP_OPTIONS_FLAGS_GET_ORIGINAL_DST;
1538 static clib_error_t *
1539 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1540 u8 transport_proto, u8 is_start)
1542 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1543 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1544 session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1545 transport_connection_t *tc;
1546 app_worker_t *app_wrk;
1551 /* TODO decide if we want proxy to be enabled for all workers */
1552 app_wrk = application_get_default_worker (app);
1555 s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1558 sep.is_ip4 = is_ip4;
1559 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1560 sep.sw_if_index = app_ns->sw_if_index;
1561 sep.transport_proto = transport_proto;
1562 sep.app_wrk_index = app_wrk->wrk_index; /* only default */
1564 /* force global scope listener */
1566 app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1567 app_listener_alloc_and_init (app, &sep, &al);
1570 app_worker_start_listen (app_wrk, al);
1571 s = listen_session_get (al->session_index);
1572 s->flags |= SESSION_F_PROXY;
1577 s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1581 tc = listen_session_get_transport (s);
1583 if (!ip_is_zero (&tc->lcl_ip, 1))
1586 sep.is_ip4 = is_ip4;
1587 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1588 sep.transport_proto = transport_proto;
1590 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1592 session_lookup_add_session_endpoint (sti,
1593 (session_endpoint_t *) & sep,
1596 session_lookup_del_session_endpoint (sti,
1597 (session_endpoint_t *) & sep);
1604 application_start_stop_proxy_local_scope (application_t * app,
1605 u8 transport_proto, u8 is_start)
1607 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1608 app_namespace_t *app_ns;
1609 app_ns = app_namespace_get (app->ns_index);
1611 sep.transport_proto = transport_proto;
1616 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1619 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1624 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1626 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1631 application_start_stop_proxy (application_t * app,
1632 transport_proto_t transport_proto, u8 is_start)
1634 if (application_has_local_scope (app))
1635 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1637 if (application_has_global_scope (app))
1639 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1640 transport_proto, is_start);
1641 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1642 transport_proto, is_start);
1647 application_setup_proxy (application_t * app)
1649 u16 transports = app->proxied_transports;
1650 transport_proto_t tp;
1652 ASSERT (application_is_proxy (app));
1654 transport_proto_foreach (tp, transports)
1655 application_start_stop_proxy (app, tp, 1);
1659 application_remove_proxy (application_t * app)
1661 u16 transports = app->proxied_transports;
1662 transport_proto_t tp;
1664 ASSERT (application_is_proxy (app));
1666 transport_proto_foreach (tp, transports)
1667 application_start_stop_proxy (app, tp, 0);
1670 segment_manager_props_t *
1671 application_segment_manager_properties (application_t * app)
1673 return &app->sm_properties;
1676 segment_manager_props_t *
1677 application_get_segment_manager_properties (u32 app_index)
1679 application_t *app = application_get (app_index);
1680 return &app->sm_properties;
1684 application_format_listeners (application_t * app, int verbose)
1686 vlib_main_t *vm = vlib_get_main ();
1687 app_worker_map_t *wrk_map;
1688 app_worker_t *app_wrk;
1694 vlib_cli_output (vm, "%U", format_app_worker_listener, NULL /* header */,
1700 pool_foreach (wrk_map, app->worker_maps) {
1701 app_wrk = app_worker_get (wrk_map->wrk_index);
1702 if (hash_elts (app_wrk->listeners_table) == 0)
1704 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1705 vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1706 handle, sm_index, verbose);
1713 application_format_connects (application_t * app, int verbose)
1715 app_worker_map_t *wrk_map;
1716 app_worker_t *app_wrk;
1720 app_worker_format_connects (0, verbose);
1725 pool_foreach (wrk_map, app->worker_maps) {
1726 app_wrk = app_worker_get (wrk_map->wrk_index);
1727 app_worker_format_connects (app_wrk, verbose);
1733 format_cert_key_pair (u8 * s, va_list * args)
1735 app_cert_key_pair_t *ckpair = va_arg (*args, app_cert_key_pair_t *);
1736 int key_len = 0, cert_len = 0;
1737 cert_len = vec_len (ckpair->cert);
1738 key_len = vec_len (ckpair->key);
1739 if (ckpair->cert_key_index == 0)
1740 s = format (s, "DEFAULT (cert:%d, key:%d)", cert_len, key_len);
1742 s = format (s, "%d (cert:%d, key:%d)", ckpair->cert_key_index,
1748 format_crypto_engine (u8 * s, va_list * args)
1750 u32 engine = va_arg (*args, u32);
1753 case CRYPTO_ENGINE_NONE:
1754 return format (s, "none");
1755 case CRYPTO_ENGINE_MBEDTLS:
1756 return format (s, "mbedtls");
1757 case CRYPTO_ENGINE_OPENSSL:
1758 return format (s, "openssl");
1759 case CRYPTO_ENGINE_PICOTLS:
1760 return format (s, "picotls");
1761 case CRYPTO_ENGINE_VPP:
1762 return format (s, "vpp");
1764 return format (s, "unknown engine");
1770 unformat_crypto_engine (unformat_input_t * input, va_list * args)
1772 u8 *a = va_arg (*args, u8 *);
1773 if (unformat (input, "mbedtls"))
1774 *a = CRYPTO_ENGINE_MBEDTLS;
1775 else if (unformat (input, "openssl"))
1776 *a = CRYPTO_ENGINE_OPENSSL;
1777 else if (unformat (input, "picotls"))
1778 *a = CRYPTO_ENGINE_PICOTLS;
1779 else if (unformat (input, "vpp"))
1780 *a = CRYPTO_ENGINE_VPP;
1787 format_crypto_context (u8 * s, va_list * args)
1789 crypto_context_t *crctx = va_arg (*args, crypto_context_t *);
1790 s = format (s, "[0x%x][sub%d,ckpair%x]", crctx->ctx_index,
1791 crctx->n_subscribers, crctx->ckpair_index);
1792 s = format (s, "[%U]", format_crypto_engine, crctx->crypto_engine);
1797 format_application (u8 * s, va_list * args)
1799 application_t *app = va_arg (*args, application_t *);
1800 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1801 segment_manager_props_t *props;
1802 const u8 *app_ns_name, *app_name;
1803 app_worker_map_t *wrk_map;
1804 app_worker_t *app_wrk;
1809 s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1813 app_name = app_get_name (app);
1814 app_ns_name = app_namespace_id_from_index (app->ns_index);
1815 props = application_segment_manager_properties (app);
1818 s = format (s, "%-10u%-20v%-40v", app->app_index, app_name,
1823 s = format (s, "app-name %v app-index %u ns-index %u seg-size %U\n",
1824 app_name, app->app_index, app->ns_index,
1825 format_memory_size, props->add_segment_size);
1826 s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1827 format_memory_size, props->rx_fifo_size,
1828 format_memory_size, props->tx_fifo_size);
1831 pool_foreach (wrk_map, app->worker_maps) {
1832 app_wrk = app_worker_get (wrk_map->wrk_index);
1833 s = format (s, "%U", format_app_worker, app_wrk);
1841 application_format_all_listeners (vlib_main_t * vm, int verbose)
1845 if (!pool_elts (app_main.app_pool))
1847 vlib_cli_output (vm, "No active server bindings");
1851 application_format_listeners (0, verbose);
1854 pool_foreach (app, app_main.app_pool) {
1855 application_format_listeners (app, verbose);
1861 application_format_all_clients (vlib_main_t * vm, int verbose)
1865 if (!pool_elts (app_main.app_pool))
1867 vlib_cli_output (vm, "No active apps");
1871 application_format_connects (0, verbose);
1874 pool_foreach (app, app_main.app_pool) {
1875 application_format_connects (app, verbose);
1880 static clib_error_t *
1881 show_certificate_command_fn (vlib_main_t * vm, unformat_input_t * input,
1882 vlib_cli_command_t * cmd)
1884 app_cert_key_pair_t *ckpair;
1885 session_cli_return_if_not_enabled ();
1888 pool_foreach (ckpair, app_main.cert_key_pair_store) {
1889 vlib_cli_output (vm, "%U", format_cert_key_pair, ckpair);
1896 appliction_format_app_mq (vlib_main_t * vm, application_t * app)
1898 app_worker_map_t *map;
1903 pool_foreach (map, app->worker_maps) {
1904 wrk = app_worker_get (map->wrk_index);
1905 vlib_cli_output (vm, "[A%d][%d]%U", app->app_index,
1906 map->wrk_index, format_svm_msg_q,
1911 for (i = 0; i < vec_len (app->rx_mqs); i++)
1912 vlib_cli_output (vm, "[A%d][R%d]%U", app->app_index, i, format_svm_msg_q,
1916 static clib_error_t *
1917 appliction_format_all_app_mq (vlib_main_t * vm)
1922 n_threads = vlib_get_n_threads ();
1924 for (i = 0; i < n_threads; i++)
1926 vlib_cli_output (vm, "[Ctrl%d]%U", i, format_svm_msg_q,
1927 session_main_get_vpp_event_queue (i));
1931 pool_foreach (app, app_main.app_pool) {
1932 appliction_format_app_mq (vm, app);
1938 static clib_error_t *
1939 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1940 vlib_cli_command_t * cmd)
1942 int do_server = 0, do_client = 0, do_mq = 0, do_transports = 0;
1948 session_cli_return_if_not_enabled ();
1950 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1952 if (unformat (input, "server"))
1954 else if (unformat (input, "client"))
1956 else if (unformat (input, "transports"))
1958 else if (unformat (input, "mq"))
1960 else if (unformat (input, "%u", &app_index))
1962 else if (unformat (input, "verbose"))
1965 return clib_error_return (0, "unknown input `%U'",
1966 format_unformat_error, input);
1969 if (do_mq && app_index != ~0)
1971 app = application_get_if_valid (app_index);
1973 return clib_error_return (0, "No app with index %u", app_index);
1975 appliction_format_app_mq (vm, app);
1981 appliction_format_all_app_mq (vm);
1987 application_format_all_listeners (vm, verbose);
1993 application_format_all_clients (vm, verbose);
1997 if (app_index != ~0)
1999 app = application_get_if_valid (app_index);
2001 return clib_error_return (0, "No app with index %u", app_index);
2003 vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
2007 /* Print app related info */
2008 if (!do_server && !do_client)
2010 vlib_cli_output (vm, "%U", format_application, 0, 0);
2011 pool_foreach (app, app_main.app_pool) {
2012 is_ta = app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
2013 if ((!do_transports && !is_ta) || (do_transports && is_ta))
2014 vlib_cli_output (vm, "%U", format_application, app, 0);
2021 /* Certificate store */
2023 static app_cert_key_pair_t *
2024 app_cert_key_pair_alloc ()
2026 app_cert_key_pair_t *ckpair;
2027 pool_get (app_main.cert_key_pair_store, ckpair);
2028 clib_memset (ckpair, 0, sizeof (*ckpair));
2029 ckpair->cert_key_index = ckpair - app_main.cert_key_pair_store;
2033 app_cert_key_pair_t *
2034 app_cert_key_pair_get_if_valid (u32 index)
2036 if (pool_is_free_index (app_main.cert_key_pair_store, index))
2038 return app_cert_key_pair_get (index);
2041 app_cert_key_pair_t *
2042 app_cert_key_pair_get (u32 index)
2044 return pool_elt_at_index (app_main.cert_key_pair_store, index);
2047 app_cert_key_pair_t *
2048 app_cert_key_pair_get_default ()
2050 /* To maintain legacy bapi */
2051 return app_cert_key_pair_get (0);
2055 vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a)
2057 app_cert_key_pair_t *ckpair = app_cert_key_pair_alloc ();
2058 vec_validate (ckpair->cert, a->cert_len - 1);
2059 clib_memcpy_fast (ckpair->cert, a->cert, a->cert_len);
2060 vec_validate (ckpair->key, a->key_len - 1);
2061 clib_memcpy_fast (ckpair->key, a->key, a->key_len);
2062 a->index = ckpair->cert_key_index;
2067 vnet_app_add_cert_key_interest (u32 index, u32 app_index)
2069 app_cert_key_pair_t *ckpair;
2070 if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
2072 if (vec_search (ckpair->app_interests, app_index) != ~0)
2073 vec_add1 (ckpair->app_interests, app_index);
2078 vnet_app_del_cert_key_pair (u32 index)
2080 app_cert_key_pair_t *ckpair;
2084 if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
2085 return (VNET_API_ERROR_INVALID_VALUE);
2087 vec_foreach (app_index, ckpair->app_interests)
2089 if ((app = application_get_if_valid (*app_index))
2090 && app->cb_fns.app_cert_key_pair_delete_callback)
2091 app->cb_fns.app_cert_key_pair_delete_callback (ckpair);
2094 vec_free (ckpair->cert);
2095 vec_free (ckpair->key);
2096 pool_put (app_main.cert_key_pair_store, ckpair);
2101 application_init (vlib_main_t * vm)
2103 app_main_t *am = &app_main;
2106 n_workers = vlib_num_workers ();
2108 /* Index 0 was originally used by legacy apis, maintain as invalid */
2109 (void) app_cert_key_pair_alloc ();
2110 am->last_crypto_engine = CRYPTO_ENGINE_LAST;
2111 am->app_by_name = hash_create_vec (0, sizeof (u8), sizeof (uword));
2113 vec_validate (am->wrk, n_workers);
2118 VLIB_INIT_FUNCTION (application_init);
2120 VLIB_CLI_COMMAND (show_app_command, static) = {
2122 .short_help = "show app [index] [server|client] [mq] [verbose] "
2124 .function = show_app_command_fn,
2127 VLIB_CLI_COMMAND (show_certificate_command, static) = {
2128 .path = "show app certificate",
2129 .short_help = "list app certs and keys present in store",
2130 .function = show_certificate_command_fn,
2133 crypto_engine_type_t
2134 app_crypto_engine_type_add (void)
2136 return (++app_main.last_crypto_engine);
2140 app_crypto_engine_n_types (void)
2142 return (app_main.last_crypto_engine + 1);
2146 * fd.io coding-style-patch-verification: ON
2149 * eval: (c-set-style "gnu")