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);
195 ls = session_get_from_handle (lh);
196 app_listener = app_listener_get (app, al_index);
197 app_listener->local_index = ls->session_index;
198 app_listener->ls_handle = lh;
199 ls->al_index = al_index;
201 table_index = application_local_session_table (app);
202 session_lookup_add_session_endpoint (table_index,
203 (session_endpoint_t *) sep, lh);
206 if (application_has_global_scope (app))
209 * Start listening on local endpoint for requested transport and scope.
210 * Creates a stream session with state LISTENING to be used in session
211 * lookups, prior to establishing connection. Requests transport to
212 * build it's own specific listening connection.
214 ls = listen_session_alloc (0, st);
215 ls->app_index = app->app_index;
216 ls->app_wrk_index = sep->app_wrk_index;
218 /* Listen pool can be reallocated if the transport is
220 lh = listen_session_get_handle (ls);
222 if ((rv = session_listen (ls, sep)))
224 ls = listen_session_get_from_handle (lh);
228 ls = listen_session_get_from_handle (lh);
229 app_listener = app_listener_get (app, al_index);
230 app_listener->session_index = ls->session_index;
231 app_listener->ls_handle = lh;
232 ls->al_index = al_index;
234 /* Add to the global lookup table after transport was initialized.
235 * Lookup table needs to be populated only now because sessions
236 * with cut-through transport are are added to app local tables that
237 * are not related to network fibs, i.e., cannot be added as
239 tc = session_get_transport (ls);
240 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
242 fib_protocol_t fib_proto;
243 fib_proto = session_endpoint_fib_proto ((session_endpoint_t *) sep);
244 /* Assume namespace vetted previously so make sure table exists */
245 table_index = session_lookup_get_or_alloc_index_for_fib (
246 fib_proto, sep->fib_index);
247 session_lookup_add_session_endpoint (table_index,
248 (session_endpoint_t *) sep,
255 app_listener_free (app, app_listener);
259 *listener = app_listener;
264 app_listener_cleanup (app_listener_t * al)
266 application_t *app = application_get (al->app_index);
269 if (al->session_index != SESSION_INVALID_INDEX)
271 ls = session_get (al->session_index, 0);
272 session_stop_listen (ls);
273 listen_session_free (ls);
275 if (al->local_index != SESSION_INVALID_INDEX)
277 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
280 table_index = application_local_session_table (app);
281 ls = listen_session_get (al->local_index);
282 ct_session_endpoint (ls, &sep);
283 session_lookup_del_session_endpoint (table_index, &sep);
284 session_stop_listen (ls);
285 listen_session_free (ls);
287 app_listener_free (app, al);
290 static app_worker_t *
291 app_listener_select_worker (application_t * app, app_listener_t * al)
295 app = application_get (al->app_index);
296 wrk_index = clib_bitmap_next_set (al->workers, al->accept_rotor + 1);
298 wrk_index = clib_bitmap_first_set (al->workers);
300 ASSERT (wrk_index != ~0);
301 al->accept_rotor = wrk_index;
302 return application_get_worker (app, wrk_index);
306 app_listener_get_session (app_listener_t * al)
308 if (al->session_index == SESSION_INVALID_INDEX)
311 return listen_session_get (al->session_index);
315 app_listener_get_local_session (app_listener_t * al)
317 if (al->local_index == SESSION_INVALID_INDEX)
319 return listen_session_get (al->local_index);
322 static app_worker_map_t *
323 app_worker_map_alloc (application_t * app)
325 app_worker_map_t *map;
326 pool_get (app->worker_maps, map);
327 clib_memset (map, 0, sizeof (*map));
332 app_worker_map_index (application_t * app, app_worker_map_t * map)
334 return (map - app->worker_maps);
338 app_worker_map_free (application_t * app, app_worker_map_t * map)
340 pool_put (app->worker_maps, map);
343 static app_worker_map_t *
344 app_worker_map_get (application_t * app, u32 map_index)
346 if (pool_is_free_index (app->worker_maps, map_index))
348 return pool_elt_at_index (app->worker_maps, map_index);
352 app_get_name (application_t * app)
358 application_session_table (application_t * app, u8 fib_proto)
360 app_namespace_t *app_ns;
361 app_ns = app_namespace_get (app->ns_index);
362 if (!application_has_global_scope (app))
363 return APP_INVALID_INDEX;
364 if (fib_proto == FIB_PROTOCOL_IP4)
365 return session_lookup_get_index_for_fib (fib_proto,
366 app_ns->ip4_fib_index);
368 return session_lookup_get_index_for_fib (fib_proto,
369 app_ns->ip6_fib_index);
373 application_local_session_table (application_t * app)
375 app_namespace_t *app_ns;
376 if (!application_has_local_scope (app))
377 return APP_INVALID_INDEX;
378 app_ns = app_namespace_get (app->ns_index);
379 return app_ns->local_table_index;
383 * Returns app name for app-index
386 application_name_from_index (u32 app_index)
388 application_t *app = application_get (app_index);
391 return app_get_name (app);
395 application_api_table_add (u32 app_index, u32 api_client_index)
397 if (api_client_index != APP_INVALID_INDEX)
398 hash_set (app_main.app_by_api_client_index, api_client_index, app_index);
402 application_api_table_del (u32 api_client_index)
404 hash_unset (app_main.app_by_api_client_index, api_client_index);
408 application_name_table_add (application_t * app)
410 hash_set_mem (app_main.app_by_name, app->name, app->app_index);
414 application_name_table_del (application_t * app)
416 hash_unset_mem (app_main.app_by_name, app->name);
420 application_lookup (u32 api_client_index)
423 p = hash_get (app_main.app_by_api_client_index, api_client_index);
425 return application_get_if_valid (p[0]);
431 application_lookup_name (const u8 * name)
434 p = hash_get_mem (app_main.app_by_name, name);
436 return application_get (p[0]);
442 appsl_pending_rx_mqs_add_tail (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
444 app_rx_mq_elt_t *head;
446 if (!aw->pending_rx_mqs)
448 elt->next = elt->prev = elt;
449 aw->pending_rx_mqs = elt;
453 head = aw->pending_rx_mqs;
455 ASSERT (head != elt);
457 elt->prev = head->prev;
460 head->prev->next = elt;
465 appsl_pending_rx_mqs_del (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
467 if (elt->next == elt)
469 elt->next = elt->prev = 0;
470 aw->pending_rx_mqs = 0;
474 if (elt == aw->pending_rx_mqs)
475 aw->pending_rx_mqs = elt->next;
477 elt->next->prev = elt->prev;
478 elt->prev->next = elt->next;
479 elt->next = elt->prev = 0;
482 vlib_node_registration_t appsl_rx_mqs_input_node;
484 VLIB_NODE_FN (appsl_rx_mqs_input_node)
485 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
487 u32 thread_index = vm->thread_index, n_msgs = 0;
488 app_rx_mq_elt_t *elt, *next;
489 app_main_t *am = &app_main;
490 session_worker_t *wrk;
491 int __clib_unused rv;
495 aw = &am->wrk[thread_index];
496 elt = aw->pending_rx_mqs;
500 wrk = session_main_get_worker (thread_index);
504 if (!(elt->flags & APP_RX_MQ_F_POSTPONED))
505 rv = read (svm_msg_q_get_eventfd (elt->mq), &buf, sizeof (buf));
506 n_msgs += session_wrk_handle_mq (wrk, elt->mq);
509 appsl_pending_rx_mqs_del (aw, elt);
510 if (!svm_msg_q_is_empty (elt->mq))
512 elt->flags |= APP_RX_MQ_F_POSTPONED;
513 appsl_pending_rx_mqs_add_tail (aw, elt);
521 while (aw->pending_rx_mqs && elt != aw->pending_rx_mqs);
523 if (aw->pending_rx_mqs)
524 vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
526 if (n_msgs && wrk->state == SESSION_WRK_INTERRUPT)
527 vlib_node_set_interrupt_pending (vm, session_queue_node.index);
532 VLIB_REGISTER_NODE (appsl_rx_mqs_input_node) = {
533 .name = "appsl-rx-mqs-input",
534 .type = VLIB_NODE_TYPE_INPUT,
535 .state = VLIB_NODE_STATE_DISABLED,
538 static clib_error_t *
539 app_rx_mq_fd_read_ready (clib_file_t *cf)
541 app_rx_mq_handle_t *handle = (app_rx_mq_handle_t *) &cf->private_data;
542 vlib_main_t *vm = vlib_get_main ();
543 app_main_t *am = &app_main;
544 app_rx_mq_elt_t *mqe;
548 ASSERT (vlib_get_thread_index () == handle->thread_index);
549 app = application_get_if_valid (handle->app_index);
553 mqe = &app->rx_mqs[handle->thread_index];
554 if ((mqe->flags & APP_RX_MQ_F_PENDING) || svm_msg_q_is_empty (mqe->mq))
557 aw = &am->wrk[handle->thread_index];
558 appsl_pending_rx_mqs_add_tail (aw, mqe);
559 mqe->flags |= APP_RX_MQ_F_PENDING;
561 vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
566 static clib_error_t *
567 app_rx_mq_fd_write_ready (clib_file_t *cf)
569 clib_warning ("should not be called");
574 app_rx_mqs_epoll_add (application_t *app, app_rx_mq_elt_t *mqe)
576 clib_file_t template = { 0 };
577 app_rx_mq_handle_t handle;
581 thread_index = mqe - app->rx_mqs;
582 fd = svm_msg_q_get_eventfd (mqe->mq);
584 handle.app_index = app->app_index;
585 handle.thread_index = thread_index;
587 template.read_function = app_rx_mq_fd_read_ready;
588 template.write_function = app_rx_mq_fd_write_ready;
589 template.file_descriptor = fd;
590 template.private_data = handle.as_u64;
591 template.polling_thread_index = thread_index;
592 template.description =
593 format (0, "app-%u-rx-mq-%u", app->app_index, thread_index);
594 mqe->file_index = clib_file_add (&file_main, &template);
598 app_rx_mqs_epoll_del (application_t *app, app_rx_mq_elt_t *mqe)
600 u32 thread_index = mqe - app->rx_mqs;
601 app_main_t *am = &app_main;
604 aw = &am->wrk[thread_index];
606 session_wrk_handle_mq (session_main_get_worker (thread_index), mqe->mq);
608 if (mqe->flags & APP_RX_MQ_F_PENDING)
609 appsl_pending_rx_mqs_del (aw, mqe);
611 clib_file_del_by_index (&file_main, mqe->file_index);
615 application_rx_mq_get (application_t *app, u32 mq_index)
620 return app->rx_mqs[mq_index].mq;
624 app_rx_mqs_alloc (application_t *app)
626 u32 evt_q_length, evt_size = sizeof (session_event_t);
627 fifo_segment_t *eqs = &app->rx_mqs_segment;
628 u32 n_mqs = vlib_num_workers () + 1;
629 segment_manager_props_t *props;
632 props = application_segment_manager_properties (app);
633 evt_q_length = clib_max (props->evt_q_size, 128);
635 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
636 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
637 { evt_q_length, evt_size, 0 }, { evt_q_length >> 1, 256, 0 }
639 cfg->consumer_pid = 0;
641 cfg->q_nitems = evt_q_length;
644 eqs->ssvm.ssvm_size = svm_msg_q_size_to_alloc (cfg) * n_mqs + (1 << 20);
645 eqs->ssvm.name = format (0, "%v-rx-mqs-seg%c", app->name, 0);
647 if (ssvm_server_init (&eqs->ssvm, SSVM_SEGMENT_MEMFD))
649 clib_warning ("failed to initialize queue segment");
650 return SESSION_E_SEG_CREATE;
653 fifo_segment_init (eqs);
655 /* Fifo segment filled only with mqs */
656 eqs->h->n_mqs = n_mqs;
657 vec_validate (app->rx_mqs, n_mqs - 1);
659 for (i = 0; i < n_mqs; i++)
661 app->rx_mqs[i].mq = fifo_segment_msg_q_alloc (eqs, i, cfg);
662 if (svm_msg_q_alloc_eventfd (app->rx_mqs[i].mq))
664 clib_warning ("eventfd returned");
665 fifo_segment_cleanup (eqs);
666 ssvm_delete (&eqs->ssvm);
667 return SESSION_E_EVENTFD_ALLOC;
669 app_rx_mqs_epoll_add (app, &app->rx_mqs[i]);
670 app->rx_mqs[i].app_index = app->app_index;
677 application_use_private_rx_mqs (void)
679 return session_main.use_private_rx_mqs;
683 application_get_rx_mqs_segment (application_t *app)
685 if (application_use_private_rx_mqs ())
686 return &app->rx_mqs_segment;
687 return session_main_get_wrk_mqs_segment ();
691 application_enable_rx_mqs_nodes (u8 is_en)
693 u8 state = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
696 vlib_node_set_state (this_vlib_main, appsl_rx_mqs_input_node.index, state);
699 static application_t *
700 application_alloc (void)
703 pool_get (app_main.app_pool, app);
704 clib_memset (app, 0, sizeof (*app));
705 app->app_index = app - app_main.app_pool;
710 application_get (u32 app_index)
712 if (app_index == APP_INVALID_INDEX)
714 return pool_elt_at_index (app_main.app_pool, app_index);
718 application_get_if_valid (u32 app_index)
720 if (pool_is_free_index (app_main.app_pool, app_index))
723 return pool_elt_at_index (app_main.app_pool, app_index);
727 application_verify_cb_fns (session_cb_vft_t * cb_fns)
729 if (cb_fns->session_accept_callback == 0)
730 clib_warning ("No accept callback function provided");
731 if (cb_fns->session_connected_callback == 0)
732 clib_warning ("No session connected callback function provided");
733 if (cb_fns->session_disconnect_callback == 0)
734 clib_warning ("No session disconnect callback function provided");
735 if (cb_fns->session_reset_callback == 0)
736 clib_warning ("No session reset callback function provided");
740 * Check app config for given segment type
742 * Returns 1 on success and 0 otherwise
745 application_verify_cfg (ssvm_segment_type_t st)
748 if (st == SSVM_SEGMENT_MEMFD)
750 is_valid = (session_main_get_wrk_mqs_segment () != 0);
752 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
755 else if (st == SSVM_SEGMENT_SHM)
757 is_valid = (session_main_get_wrk_mqs_segment () == 0);
759 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
767 application_alloc_and_init (app_init_args_t * a)
769 ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
770 segment_manager_props_t *props;
774 app = application_alloc ();
777 * Make sure we support the requested configuration
779 if ((opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN) &&
780 !(opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_MEMFD_FOR_BUILTIN))
781 seg_type = SSVM_SEGMENT_PRIVATE;
783 if ((opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD) &&
784 seg_type != SSVM_SEGMENT_MEMFD)
786 clib_warning ("mq eventfds can only be used if socket transport is "
787 "used for binary api");
788 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
791 if (!application_verify_cfg (seg_type))
792 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
794 if (opts[APP_OPTIONS_PREALLOC_FIFO_PAIRS] &&
795 opts[APP_OPTIONS_PREALLOC_FIFO_HDRS])
796 return VNET_API_ERROR_APP_UNSUPPORTED_CFG;
798 /* Check that the obvious things are properly set up */
799 application_verify_cb_fns (a->session_cb_vft);
801 app->flags = opts[APP_OPTIONS_FLAGS];
802 app->cb_fns = *a->session_cb_vft;
803 app->ns_index = opts[APP_OPTIONS_NAMESPACE];
804 app->proxied_transports = opts[APP_OPTIONS_PROXY_TRANSPORT];
805 app->name = vec_dup (a->name);
807 /* If no scope enabled, default to global */
808 if (!application_has_global_scope (app)
809 && !application_has_local_scope (app))
810 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
812 props = application_segment_manager_properties (app);
813 segment_manager_props_init (props);
814 props->segment_size = opts[APP_OPTIONS_SEGMENT_SIZE];
815 props->prealloc_fifos = opts[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
816 props->prealloc_fifo_hdrs = opts[APP_OPTIONS_PREALLOC_FIFO_HDRS];
817 if (opts[APP_OPTIONS_ADD_SEGMENT_SIZE])
819 props->add_segment_size = opts[APP_OPTIONS_ADD_SEGMENT_SIZE];
820 props->add_segment = 1;
822 if (opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_USE_HUGE_PAGE)
823 props->huge_page = 1;
824 if (opts[APP_OPTIONS_RX_FIFO_SIZE])
825 props->rx_fifo_size = opts[APP_OPTIONS_RX_FIFO_SIZE];
826 if (opts[APP_OPTIONS_TX_FIFO_SIZE])
827 props->tx_fifo_size = opts[APP_OPTIONS_TX_FIFO_SIZE];
828 if (opts[APP_OPTIONS_EVT_QUEUE_SIZE])
829 props->evt_q_size = opts[APP_OPTIONS_EVT_QUEUE_SIZE];
830 if (opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
831 props->use_mq_eventfd = 1;
832 if (opts[APP_OPTIONS_TLS_ENGINE])
833 app->tls_engine = opts[APP_OPTIONS_TLS_ENGINE];
834 if (opts[APP_OPTIONS_MAX_FIFO_SIZE])
835 props->max_fifo_size = opts[APP_OPTIONS_MAX_FIFO_SIZE];
836 if (opts[APP_OPTIONS_HIGH_WATERMARK])
837 props->high_watermark = opts[APP_OPTIONS_HIGH_WATERMARK];
838 if (opts[APP_OPTIONS_LOW_WATERMARK])
839 props->low_watermark = opts[APP_OPTIONS_LOW_WATERMARK];
840 if (opts[APP_OPTIONS_PCT_FIRST_ALLOC])
841 props->pct_first_alloc = opts[APP_OPTIONS_PCT_FIRST_ALLOC];
842 props->segment_type = seg_type;
844 /* Add app to lookup by api_client_index table */
845 if (!application_is_builtin (app))
846 application_api_table_add (app->app_index, a->api_client_index);
848 application_name_table_add (app);
850 a->app_index = app->app_index;
852 APP_DBG ("New app name: %v api index: %u index %u", app->name,
853 a->api_client_index, app->app_index);
859 application_free (application_t * app)
861 app_worker_map_t *wrk_map;
862 app_worker_t *app_wrk;
865 * The app event queue allocated in first segment is cleared with
866 * the segment manager. No need to explicitly free it.
868 APP_DBG ("Delete app name %v index: %d", app->name, app->app_index);
870 if (application_is_proxy (app))
871 application_remove_proxy (app);
878 pool_flush (wrk_map, app->worker_maps, ({
879 app_wrk = app_worker_get (wrk_map->wrk_index);
880 app_worker_free (app_wrk);
883 pool_free (app->worker_maps);
886 * Free rx mqs if allocated
891 for (i = 0; i < vec_len (app->rx_mqs); i++)
892 app_rx_mqs_epoll_del (app, &app->rx_mqs[i]);
894 fifo_segment_cleanup (&app->rx_mqs_segment);
895 ssvm_delete (&app->rx_mqs_segment.ssvm);
896 vec_free (app->rx_mqs);
900 * Cleanup remaining state
902 if (application_is_builtin (app))
903 application_name_table_del (app);
904 vec_free (app->name);
905 pool_put (app_main.app_pool, app);
909 application_detach_process (application_t * app, u32 api_client_index)
911 vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
912 app_worker_map_t *wrk_map;
913 u32 *wrks = 0, *wrk_index;
914 app_worker_t *app_wrk;
916 if (api_client_index == ~0)
918 application_free (app);
922 APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
923 app->app_index, api_client_index);
926 pool_foreach (wrk_map, app->worker_maps) {
927 app_wrk = app_worker_get (wrk_map->wrk_index);
928 if (app_wrk->api_client_index == api_client_index)
929 vec_add1 (wrks, app_wrk->wrk_index);
935 clib_warning ("no workers for app %u api_index %u", app->app_index,
940 args->app_index = app->app_index;
941 args->api_client_index = api_client_index;
942 vec_foreach (wrk_index, wrks)
944 app_wrk = app_worker_get (wrk_index[0]);
945 args->wrk_map_index = app_wrk->wrk_map_index;
947 vnet_app_worker_add_del (args);
953 application_namespace_cleanup (app_namespace_t *app_ns)
955 u32 *app_indices = 0, *app_index;
959 ns_index = app_namespace_index (app_ns);
960 pool_foreach (app, app_main.app_pool)
961 if (app->ns_index == ns_index)
962 vec_add1 (app_indices, app->ns_index);
964 vec_foreach (app_index, app_indices)
966 app = application_get (*app_index);
968 if (application_is_proxy (app))
969 application_remove_proxy (app);
970 app->flags &= ~APP_OPTIONS_FLAGS_IS_PROXY;
972 application_free (app);
974 vec_free (app_indices);
978 application_get_worker (application_t * app, u32 wrk_map_index)
980 app_worker_map_t *map;
981 map = app_worker_map_get (app, wrk_map_index);
984 return app_worker_get (map->wrk_index);
988 application_get_default_worker (application_t * app)
990 return application_get_worker (app, 0);
994 application_n_workers (application_t * app)
996 return pool_elts (app->worker_maps);
1000 application_listener_select_worker (session_t * ls)
1005 app = application_get (ls->app_index);
1006 al = app_listener_get (app, ls->al_index);
1007 return app_listener_select_worker (app, al);
1011 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
1013 app_worker_map_t *wrk_map;
1014 app_worker_t *app_wrk;
1015 segment_manager_t *sm;
1018 app_wrk = app_worker_alloc (app);
1019 wrk_map = app_worker_map_alloc (app);
1020 wrk_map->wrk_index = app_wrk->wrk_index;
1021 app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
1024 * Setup first segment manager
1026 sm = segment_manager_alloc ();
1027 sm->app_wrk_index = app_wrk->wrk_index;
1029 if ((rv = segment_manager_init_first (sm)))
1031 app_worker_free (app_wrk);
1034 sm->first_is_protected = 1;
1039 app_wrk->connects_seg_manager = segment_manager_index (sm);
1040 app_wrk->listeners_table = hash_create (0, sizeof (u64));
1041 app_wrk->event_queue = segment_manager_event_queue (sm);
1042 app_wrk->app_is_builtin = application_is_builtin (app);
1050 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t * a)
1053 app_worker_map_t *wrk_map;
1054 app_worker_t *app_wrk;
1055 segment_manager_t *sm;
1059 app = application_get (a->app_index);
1061 return VNET_API_ERROR_INVALID_VALUE;
1065 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1068 /* Map worker api index to the app */
1069 app_wrk->api_client_index = a->api_client_index;
1070 application_api_table_add (app->app_index, a->api_client_index);
1072 sm = segment_manager_get (app_wrk->connects_seg_manager);
1073 fs = segment_manager_get_segment_w_lock (sm, 0);
1074 a->segment = &fs->ssvm;
1075 a->segment_handle = segment_manager_segment_handle (sm, fs);
1076 segment_manager_segment_reader_unlock (sm);
1077 a->evt_q = app_wrk->event_queue;
1078 a->wrk_map_index = app_wrk->wrk_map_index;
1082 wrk_map = app_worker_map_get (app, a->wrk_map_index);
1084 return VNET_API_ERROR_INVALID_VALUE;
1086 app_wrk = app_worker_get (wrk_map->wrk_index);
1088 return VNET_API_ERROR_INVALID_VALUE;
1090 application_api_table_del (app_wrk->api_client_index);
1091 if (appns_sapi_enabled ())
1092 sapi_socket_close_w_handle (app_wrk->api_client_index);
1093 app_worker_free (app_wrk);
1094 app_worker_map_free (app, wrk_map);
1095 if (application_n_workers (app) == 0)
1096 application_free (app);
1102 app_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
1104 app_namespace_t *app_ns;
1105 if (vec_len (namespace_id) == 0)
1107 /* Use default namespace */
1112 *app_ns_index = app_namespace_index_from_id (namespace_id);
1113 if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
1114 return VNET_API_ERROR_APP_INVALID_NS;
1115 app_ns = app_namespace_get (*app_ns_index);
1117 return VNET_API_ERROR_APP_INVALID_NS;
1118 if (app_ns->ns_secret != secret)
1119 return VNET_API_ERROR_APP_WRONG_NS_SECRET;
1124 app_name_from_api_index (u32 api_client_index)
1126 vl_api_registration_t *regp;
1127 regp = vl_api_client_index_to_registration (api_client_index);
1129 return format (0, "%s", regp->name);
1131 clib_warning ("api client index %u does not have an api registration!",
1133 return format (0, "unknown");
1137 * Attach application to vpp
1139 * Allocates a vpp app, i.e., a structure that keeps back pointers
1140 * to external app and a segment manager for shared memory fifo based
1141 * communication with the external app.
1144 vnet_application_attach (vnet_app_attach_args_t * a)
1147 application_t *app = 0;
1148 app_worker_t *app_wrk;
1149 segment_manager_t *sm;
1150 u32 app_ns_index = 0;
1155 if (a->api_client_index != APP_INVALID_INDEX)
1156 app = application_lookup (a->api_client_index);
1158 app = application_lookup_name (a->name);
1160 return VNET_API_ERROR_INVALID_VALUE;
1163 return VNET_API_ERROR_APP_ALREADY_ATTACHED;
1165 /* Socket api sets the name and validates namespace prior to attach */
1166 if (!a->use_sock_api)
1168 if (a->api_client_index != APP_INVALID_INDEX)
1170 app_name = app_name_from_api_index (a->api_client_index);
1174 secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
1175 if ((rv = app_validate_namespace (a->namespace_id, secret,
1178 a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
1181 if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
1184 app = application_get (a->app_index);
1185 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1188 a->app_evt_q = app_wrk->event_queue;
1189 app_wrk->api_client_index = a->api_client_index;
1190 sm = segment_manager_get (app_wrk->connects_seg_manager);
1191 fs = segment_manager_get_segment_w_lock (sm, 0);
1193 if (application_is_proxy (app))
1195 application_setup_proxy (app);
1196 /* The segment manager pool is reallocated because a new listener
1197 * is added. Re-grab segment manager to avoid dangling reference */
1198 sm = segment_manager_get (app_wrk->connects_seg_manager);
1201 ASSERT (vec_len (fs->ssvm.name) <= 128);
1202 a->segment = &fs->ssvm;
1203 a->segment_handle = segment_manager_segment_handle (sm, fs);
1205 segment_manager_segment_reader_unlock (sm);
1207 if (!application_is_builtin (app) && application_use_private_rx_mqs ())
1208 rv = app_rx_mqs_alloc (app);
1210 vec_free (app_name);
1215 * Detach application from vpp
1218 vnet_application_detach (vnet_app_detach_args_t * a)
1222 app = application_get_if_valid (a->app_index);
1225 clib_warning ("app not attached");
1226 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
1229 app_interface_check_thread_and_barrier (vnet_application_detach, a);
1230 application_detach_process (app, a->api_client_index);
1235 session_endpoint_in_ns (session_endpoint_cfg_t *sep)
1239 if (sep->flags & SESSION_ENDPT_CFG_F_PROXY_LISTEN)
1242 is_lep = session_endpoint_is_local ((session_endpoint_t *) sep);
1243 if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
1244 && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
1246 clib_warning ("sw_if_index %u not configured with ip %U",
1247 sep->sw_if_index, format_ip46_address, &sep->ip,
1252 return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
1256 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
1257 application_t * app, u8 is_connect)
1259 app_namespace_t *app_ns;
1260 u32 ns_index, fib_index;
1262 ns_index = app->ns_index;
1264 /* App is a transport proto, so fetch the calling app's ns */
1265 if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
1266 ns_index = sep->ns_index;
1268 app_ns = app_namespace_get (ns_index);
1272 /* Ask transport and network to bind to/connect using local interface
1273 * that "supports" app's namespace. This will fix our local connection
1277 /* If in default namespace and user requested a fib index use it */
1278 if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
1279 fib_index = sep->fib_index;
1281 fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
1282 sep->peer.fib_index = fib_index;
1283 sep->fib_index = fib_index;
1287 sep->sw_if_index = app_ns->sw_if_index;
1291 if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
1292 && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
1293 && sep->peer.sw_if_index != app_ns->sw_if_index)
1294 clib_warning ("Local sw_if_index different from app ns sw_if_index");
1296 sep->peer.sw_if_index = app_ns->sw_if_index;
1301 vnet_listen (vnet_listen_args_t * a)
1303 app_listener_t *app_listener;
1304 app_worker_t *app_wrk;
1308 ASSERT (vlib_thread_is_main_w_barrier ());
1310 app = application_get_if_valid (a->app_index);
1312 return SESSION_E_NOAPP;
1314 app_wrk = application_get_worker (app, a->wrk_map_index);
1316 return SESSION_E_INVALID_APPWRK;
1318 a->sep_ext.app_wrk_index = app_wrk->wrk_index;
1320 session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
1321 if (!session_endpoint_in_ns (&a->sep_ext))
1322 return SESSION_E_INVALID_NS;
1325 * Check if we already have an app listener
1327 app_listener = app_listener_lookup (app, &a->sep_ext);
1330 if (app_listener->app_index != app->app_index)
1331 return SESSION_E_ALREADY_LISTENING;
1332 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1334 a->handle = app_listener_handle (app_listener);
1339 * Create new app listener
1341 if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
1344 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1346 app_listener_cleanup (app_listener);
1350 a->handle = app_listener_handle (app_listener);
1355 vnet_connect (vnet_connect_args_t * a)
1357 app_worker_t *client_wrk;
1358 application_t *client;
1360 ASSERT (vlib_thread_is_main_w_barrier ());
1362 if (session_endpoint_is_zero (&a->sep))
1363 return SESSION_E_INVALID_RMT_IP;
1365 client = application_get (a->app_index);
1366 session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1367 client_wrk = application_get_worker (client, a->wrk_map_index);
1369 a->sep_ext.opaque = a->api_context;
1372 * First check the local scope for locally attached destinations.
1373 * If we have local scope, we pass *all* connects through it since we may
1374 * have special policy rules even for non-local destinations, think proxy.
1376 if (application_has_local_scope (client))
1380 a->sep_ext.original_tp = a->sep_ext.transport_proto;
1381 a->sep_ext.transport_proto = TRANSPORT_PROTO_NONE;
1382 rv = app_worker_connect_session (client_wrk, &a->sep_ext, &a->sh);
1383 a->sep_ext.transport_proto = a->sep_ext.original_tp;
1384 if (!rv || rv != SESSION_E_LOCAL_CONNECT)
1388 * Not connecting to a local server, propagate to transport
1390 return app_worker_connect_session (client_wrk, &a->sep_ext, &a->sh);
1394 vnet_unlisten (vnet_unlisten_args_t * a)
1396 app_worker_t *app_wrk;
1400 ASSERT (vlib_thread_is_main_w_barrier ());
1402 if (!(app = application_get_if_valid (a->app_index)))
1403 return SESSION_E_NOAPP;
1405 if (!(al = app_listener_get_w_handle (a->handle)))
1406 return SESSION_E_NOLISTEN;
1408 if (al->app_index != app->app_index)
1410 clib_warning ("app doesn't own handle %llu!", a->handle);
1411 return SESSION_E_OWNER;
1414 app_wrk = application_get_worker (app, a->wrk_map_index);
1417 clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1418 return SESSION_E_INVALID_APPWRK;
1421 return app_worker_stop_listen (app_wrk, al);
1425 vnet_shutdown_session (vnet_shutdown_args_t *a)
1427 app_worker_t *app_wrk;
1430 s = session_get_from_handle_if_valid (a->handle);
1432 return SESSION_E_NOSESSION;
1434 app_wrk = app_worker_get (s->app_wrk_index);
1435 if (app_wrk->app_index != a->app_index)
1436 return SESSION_E_OWNER;
1438 /* We're peeking into another's thread pool. Make sure */
1439 ASSERT (s->session_index == session_index_from_handle (a->handle));
1441 session_half_close (s);
1446 vnet_disconnect_session (vnet_disconnect_args_t * a)
1448 app_worker_t *app_wrk;
1451 s = session_get_from_handle_if_valid (a->handle);
1453 return SESSION_E_NOSESSION;
1455 app_wrk = app_worker_get (s->app_wrk_index);
1456 if (app_wrk->app_index != a->app_index)
1457 return SESSION_E_OWNER;
1459 /* We're peeking into another's thread pool. Make sure */
1460 ASSERT (s->session_index == session_index_from_handle (a->handle));
1467 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1469 app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1470 app_listener_t *app_listener;
1475 return SESSION_E_INVALID_APPWRK;
1477 hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1478 if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1480 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1482 app = application_get (old_wrk->app_index);
1484 return SESSION_E_NOAPP;
1486 app_listener = app_listener_get (app, s->al_index);
1488 /* Only remove from lb for now */
1489 app_listener->workers = clib_bitmap_set (app_listener->workers,
1490 old_wrk->wrk_map_index, 0);
1492 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1495 s->app_wrk_index = app_wrk->wrk_index;
1501 application_is_proxy (application_t * app)
1503 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1507 application_is_builtin (application_t * app)
1509 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1513 application_is_builtin_proxy (application_t * app)
1515 return (application_is_proxy (app) && application_is_builtin (app));
1519 application_has_local_scope (application_t * app)
1521 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1525 application_has_global_scope (application_t * app)
1527 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1530 static clib_error_t *
1531 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1532 u8 transport_proto, u8 is_start)
1534 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1535 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1536 session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1537 transport_connection_t *tc;
1538 app_worker_t *app_wrk;
1543 /* TODO decide if we want proxy to be enabled for all workers */
1544 app_wrk = application_get_default_worker (app);
1547 s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1550 sep.is_ip4 = is_ip4;
1551 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1552 sep.sw_if_index = app_ns->sw_if_index;
1553 sep.transport_proto = transport_proto;
1554 sep.app_wrk_index = app_wrk->wrk_index; /* only default */
1556 /* force global scope listener */
1558 app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1559 app_listener_alloc_and_init (app, &sep, &al);
1562 app_worker_start_listen (app_wrk, al);
1563 s = listen_session_get (al->session_index);
1564 s->flags |= SESSION_F_PROXY;
1569 s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1573 tc = listen_session_get_transport (s);
1575 if (!ip_is_zero (&tc->lcl_ip, 1))
1578 sep.is_ip4 = is_ip4;
1579 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1580 sep.transport_proto = transport_proto;
1582 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1584 session_lookup_add_session_endpoint (sti,
1585 (session_endpoint_t *) & sep,
1588 session_lookup_del_session_endpoint (sti,
1589 (session_endpoint_t *) & sep);
1596 application_start_stop_proxy_local_scope (application_t * app,
1597 u8 transport_proto, u8 is_start)
1599 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1600 app_namespace_t *app_ns;
1601 app_ns = app_namespace_get (app->ns_index);
1603 sep.transport_proto = transport_proto;
1608 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1611 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1616 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1618 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1623 application_start_stop_proxy (application_t * app,
1624 transport_proto_t transport_proto, u8 is_start)
1626 if (application_has_local_scope (app))
1627 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1629 if (application_has_global_scope (app))
1631 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1632 transport_proto, is_start);
1633 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1634 transport_proto, is_start);
1639 application_setup_proxy (application_t * app)
1641 u16 transports = app->proxied_transports;
1642 transport_proto_t tp;
1644 ASSERT (application_is_proxy (app));
1646 transport_proto_foreach (tp, transports)
1647 application_start_stop_proxy (app, tp, 1);
1651 application_remove_proxy (application_t * app)
1653 u16 transports = app->proxied_transports;
1654 transport_proto_t tp;
1656 ASSERT (application_is_proxy (app));
1658 transport_proto_foreach (tp, transports)
1659 application_start_stop_proxy (app, tp, 0);
1662 segment_manager_props_t *
1663 application_segment_manager_properties (application_t * app)
1665 return &app->sm_properties;
1668 segment_manager_props_t *
1669 application_get_segment_manager_properties (u32 app_index)
1671 application_t *app = application_get (app_index);
1672 return &app->sm_properties;
1676 application_format_listeners (application_t * app, int verbose)
1678 vlib_main_t *vm = vlib_get_main ();
1679 app_worker_map_t *wrk_map;
1680 app_worker_t *app_wrk;
1686 vlib_cli_output (vm, "%U", format_app_worker_listener, NULL /* header */,
1692 pool_foreach (wrk_map, app->worker_maps) {
1693 app_wrk = app_worker_get (wrk_map->wrk_index);
1694 if (hash_elts (app_wrk->listeners_table) == 0)
1696 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1697 vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1698 handle, sm_index, verbose);
1705 application_format_connects (application_t * app, int verbose)
1707 app_worker_map_t *wrk_map;
1708 app_worker_t *app_wrk;
1712 app_worker_format_connects (0, verbose);
1717 pool_foreach (wrk_map, app->worker_maps) {
1718 app_wrk = app_worker_get (wrk_map->wrk_index);
1719 app_worker_format_connects (app_wrk, verbose);
1725 format_cert_key_pair (u8 * s, va_list * args)
1727 app_cert_key_pair_t *ckpair = va_arg (*args, app_cert_key_pair_t *);
1728 int key_len = 0, cert_len = 0;
1729 cert_len = vec_len (ckpair->cert);
1730 key_len = vec_len (ckpair->key);
1731 if (ckpair->cert_key_index == 0)
1732 s = format (s, "DEFAULT (cert:%d, key:%d)", cert_len, key_len);
1734 s = format (s, "%d (cert:%d, key:%d)", ckpair->cert_key_index,
1740 format_crypto_engine (u8 * s, va_list * args)
1742 u32 engine = va_arg (*args, u32);
1745 case CRYPTO_ENGINE_NONE:
1746 return format (s, "none");
1747 case CRYPTO_ENGINE_MBEDTLS:
1748 return format (s, "mbedtls");
1749 case CRYPTO_ENGINE_OPENSSL:
1750 return format (s, "openssl");
1751 case CRYPTO_ENGINE_PICOTLS:
1752 return format (s, "picotls");
1753 case CRYPTO_ENGINE_VPP:
1754 return format (s, "vpp");
1756 return format (s, "unknown engine");
1762 unformat_crypto_engine (unformat_input_t * input, va_list * args)
1764 u8 *a = va_arg (*args, u8 *);
1765 if (unformat (input, "mbedtls"))
1766 *a = CRYPTO_ENGINE_MBEDTLS;
1767 else if (unformat (input, "openssl"))
1768 *a = CRYPTO_ENGINE_OPENSSL;
1769 else if (unformat (input, "picotls"))
1770 *a = CRYPTO_ENGINE_PICOTLS;
1771 else if (unformat (input, "vpp"))
1772 *a = CRYPTO_ENGINE_VPP;
1779 format_crypto_context (u8 * s, va_list * args)
1781 crypto_context_t *crctx = va_arg (*args, crypto_context_t *);
1782 s = format (s, "[0x%x][sub%d,ckpair%x]", crctx->ctx_index,
1783 crctx->n_subscribers, crctx->ckpair_index);
1784 s = format (s, "[%U]", format_crypto_engine, crctx->crypto_engine);
1789 format_application (u8 * s, va_list * args)
1791 application_t *app = va_arg (*args, application_t *);
1792 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1793 segment_manager_props_t *props;
1794 const u8 *app_ns_name, *app_name;
1795 app_worker_map_t *wrk_map;
1796 app_worker_t *app_wrk;
1801 s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1805 app_name = app_get_name (app);
1806 app_ns_name = app_namespace_id_from_index (app->ns_index);
1807 props = application_segment_manager_properties (app);
1810 s = format (s, "%-10u%-20v%-40v", app->app_index, app_name,
1815 s = format (s, "app-name %v app-index %u ns-index %u seg-size %U\n",
1816 app_name, app->app_index, app->ns_index,
1817 format_memory_size, props->add_segment_size);
1818 s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1819 format_memory_size, props->rx_fifo_size,
1820 format_memory_size, props->tx_fifo_size);
1823 pool_foreach (wrk_map, app->worker_maps) {
1824 app_wrk = app_worker_get (wrk_map->wrk_index);
1825 s = format (s, "%U", format_app_worker, app_wrk);
1833 application_format_all_listeners (vlib_main_t * vm, int verbose)
1837 if (!pool_elts (app_main.app_pool))
1839 vlib_cli_output (vm, "No active server bindings");
1843 application_format_listeners (0, verbose);
1846 pool_foreach (app, app_main.app_pool) {
1847 application_format_listeners (app, verbose);
1853 application_format_all_clients (vlib_main_t * vm, int verbose)
1857 if (!pool_elts (app_main.app_pool))
1859 vlib_cli_output (vm, "No active apps");
1863 application_format_connects (0, verbose);
1866 pool_foreach (app, app_main.app_pool) {
1867 application_format_connects (app, verbose);
1872 static clib_error_t *
1873 show_certificate_command_fn (vlib_main_t * vm, unformat_input_t * input,
1874 vlib_cli_command_t * cmd)
1876 app_cert_key_pair_t *ckpair;
1877 session_cli_return_if_not_enabled ();
1880 pool_foreach (ckpair, app_main.cert_key_pair_store) {
1881 vlib_cli_output (vm, "%U", format_cert_key_pair, ckpair);
1888 appliction_format_app_mq (vlib_main_t * vm, application_t * app)
1890 app_worker_map_t *map;
1895 pool_foreach (map, app->worker_maps) {
1896 wrk = app_worker_get (map->wrk_index);
1897 vlib_cli_output (vm, "[A%d][%d]%U", app->app_index,
1898 map->wrk_index, format_svm_msg_q,
1903 for (i = 0; i < vec_len (app->rx_mqs); i++)
1904 vlib_cli_output (vm, "[A%d][R%d]%U", app->app_index, i, format_svm_msg_q,
1908 static clib_error_t *
1909 appliction_format_all_app_mq (vlib_main_t * vm)
1914 n_threads = vlib_get_n_threads ();
1916 for (i = 0; i < n_threads; i++)
1918 vlib_cli_output (vm, "[Ctrl%d]%U", i, format_svm_msg_q,
1919 session_main_get_vpp_event_queue (i));
1923 pool_foreach (app, app_main.app_pool) {
1924 appliction_format_app_mq (vm, app);
1930 static clib_error_t *
1931 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1932 vlib_cli_command_t * cmd)
1934 int do_server = 0, do_client = 0, do_mq = 0, do_transports = 0;
1940 session_cli_return_if_not_enabled ();
1942 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1944 if (unformat (input, "server"))
1946 else if (unformat (input, "client"))
1948 else if (unformat (input, "transports"))
1950 else if (unformat (input, "mq"))
1952 else if (unformat (input, "%u", &app_index))
1954 else if (unformat (input, "verbose"))
1957 return clib_error_return (0, "unknown input `%U'",
1958 format_unformat_error, input);
1961 if (do_mq && app_index != ~0)
1963 app = application_get_if_valid (app_index);
1965 return clib_error_return (0, "No app with index %u", app_index);
1967 appliction_format_app_mq (vm, app);
1973 appliction_format_all_app_mq (vm);
1979 application_format_all_listeners (vm, verbose);
1985 application_format_all_clients (vm, verbose);
1989 if (app_index != ~0)
1991 app = application_get_if_valid (app_index);
1993 return clib_error_return (0, "No app with index %u", app_index);
1995 vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
1999 /* Print app related info */
2000 if (!do_server && !do_client)
2002 vlib_cli_output (vm, "%U", format_application, 0, 0);
2003 pool_foreach (app, app_main.app_pool) {
2004 is_ta = app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
2005 if ((!do_transports && !is_ta) || (do_transports && is_ta))
2006 vlib_cli_output (vm, "%U", format_application, app, 0);
2013 /* Certificate store */
2015 static app_cert_key_pair_t *
2016 app_cert_key_pair_alloc ()
2018 app_cert_key_pair_t *ckpair;
2019 pool_get (app_main.cert_key_pair_store, ckpair);
2020 clib_memset (ckpair, 0, sizeof (*ckpair));
2021 ckpair->cert_key_index = ckpair - app_main.cert_key_pair_store;
2025 app_cert_key_pair_t *
2026 app_cert_key_pair_get_if_valid (u32 index)
2028 if (pool_is_free_index (app_main.cert_key_pair_store, index))
2030 return app_cert_key_pair_get (index);
2033 app_cert_key_pair_t *
2034 app_cert_key_pair_get (u32 index)
2036 return pool_elt_at_index (app_main.cert_key_pair_store, index);
2039 app_cert_key_pair_t *
2040 app_cert_key_pair_get_default ()
2042 /* To maintain legacy bapi */
2043 return app_cert_key_pair_get (0);
2047 vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a)
2049 app_cert_key_pair_t *ckpair = app_cert_key_pair_alloc ();
2050 vec_validate (ckpair->cert, a->cert_len - 1);
2051 clib_memcpy_fast (ckpair->cert, a->cert, a->cert_len);
2052 vec_validate (ckpair->key, a->key_len - 1);
2053 clib_memcpy_fast (ckpair->key, a->key, a->key_len);
2054 a->index = ckpair->cert_key_index;
2059 vnet_app_add_cert_key_interest (u32 index, u32 app_index)
2061 app_cert_key_pair_t *ckpair;
2062 if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
2064 if (vec_search (ckpair->app_interests, app_index) != ~0)
2065 vec_add1 (ckpair->app_interests, app_index);
2070 vnet_app_del_cert_key_pair (u32 index)
2072 app_cert_key_pair_t *ckpair;
2076 if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
2077 return (VNET_API_ERROR_INVALID_VALUE);
2079 vec_foreach (app_index, ckpair->app_interests)
2081 if ((app = application_get_if_valid (*app_index))
2082 && app->cb_fns.app_cert_key_pair_delete_callback)
2083 app->cb_fns.app_cert_key_pair_delete_callback (ckpair);
2086 vec_free (ckpair->cert);
2087 vec_free (ckpair->key);
2088 pool_put (app_main.cert_key_pair_store, ckpair);
2093 application_init (vlib_main_t * vm)
2095 app_main_t *am = &app_main;
2098 n_workers = vlib_num_workers ();
2100 /* Index 0 was originally used by legacy apis, maintain as invalid */
2101 (void) app_cert_key_pair_alloc ();
2102 am->last_crypto_engine = CRYPTO_ENGINE_LAST;
2103 am->app_by_name = hash_create_vec (0, sizeof (u8), sizeof (uword));
2105 vec_validate (am->wrk, n_workers);
2110 VLIB_INIT_FUNCTION (application_init);
2112 VLIB_CLI_COMMAND (show_app_command, static) = {
2114 .short_help = "show app [index] [server|client] [mq] [verbose] "
2116 .function = show_app_command_fn,
2119 VLIB_CLI_COMMAND (show_certificate_command, static) = {
2120 .path = "show app certificate",
2121 .short_help = "list app certs and keys present in store",
2122 .function = show_certificate_command_fn,
2125 crypto_engine_type_t
2126 app_crypto_engine_type_add (void)
2128 return (++app_main.last_crypto_engine);
2132 app_crypto_engine_n_types (void)
2134 return (app_main.last_crypto_engine + 1);
2138 * fd.io coding-style-patch-verification: ON
2141 * eval: (c-set-style "gnu")