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_main_t *am = &app_main;
35 app_listener_t *app_listener;
37 pool_get (am->listeners, app_listener);
38 clib_memset (app_listener, 0, sizeof (*app_listener));
39 app_listener->al_index = app_listener - am->listeners;
40 app_listener->app_index = app->app_index;
41 app_listener->session_index = SESSION_INVALID_INDEX;
42 app_listener->local_index = SESSION_INVALID_INDEX;
43 app_listener->ls_handle = SESSION_INVALID_HANDLE;
48 app_listener_get (u32 app_listener_index)
50 app_main_t *am = &app_main;
52 return pool_elt_at_index (am->listeners, app_listener_index);
56 app_listener_free (application_t * app, app_listener_t * app_listener)
58 app_main_t *am = &app_main;
60 clib_bitmap_free (app_listener->workers);
61 vec_free (app_listener->cl_listeners);
63 clib_memset (app_listener, 0xfa, sizeof (*app_listener));
64 pool_put (am->listeners, app_listener);
68 app_listener_handle (app_listener_t * al)
74 app_listen_session_handle (session_t * ls)
77 /* TODO(fcoras): quic session handles */
78 if (ls->al_index == SESSION_INVALID_INDEX)
79 return listen_session_get_handle (ls);
80 al = app_listener_get (ls->al_index);
85 app_listener_get_w_handle (session_handle_t handle)
88 ls = session_get_from_handle_if_valid (handle);
91 return app_listener_get (ls->al_index);
95 app_listener_lookup (application_t * app, session_endpoint_cfg_t * sep_ext)
97 u32 table_index, fib_proto;
98 session_endpoint_t *sep;
99 session_handle_t handle;
102 ip46_address_t original_ip;
104 sep = (session_endpoint_t *) sep_ext;
105 if (application_has_local_scope (app) && session_endpoint_is_local (sep))
107 table_index = application_local_session_table (app);
108 handle = session_lookup_endpoint_listener (table_index, sep, 1);
109 if (handle != SESSION_INVALID_HANDLE)
111 ls = listen_session_get_from_handle (handle);
112 return app_listener_get (ls->al_index);
116 fib_proto = session_endpoint_fib_proto (sep);
117 table_index = session_lookup_get_index_for_fib (fib_proto, sep->fib_index);
118 handle = session_lookup_endpoint_listener (table_index, sep, 1);
119 if (handle != SESSION_INVALID_HANDLE)
121 ls = listen_session_get_from_handle (handle);
122 return app_listener_get (ls->al_index);
126 * When binds to "inaddr_any", we add zero address in the local lookup table
127 * and interface address in the global lookup table. If local scope disable,
128 * the latter is the only clue to find the listener.
130 if (!application_has_local_scope (app) &&
131 ip_is_zero (&sep_ext->ip, sep_ext->is_ip4) &&
132 sep_ext->sw_if_index != ENDPOINT_INVALID_INDEX)
134 if ((iface_ip = ip_interface_get_first_ip (sep_ext->sw_if_index,
137 ip_copy (&original_ip, &sep_ext->ip, sep_ext->is_ip4);
138 ip_set (&sep_ext->ip, iface_ip, sep_ext->is_ip4);
139 handle = session_lookup_endpoint_listener (table_index, sep, 1);
140 ip_copy (&sep_ext->ip, &original_ip, sep_ext->is_ip4);
141 if (handle != SESSION_INVALID_HANDLE)
143 ls = listen_session_get_from_handle (handle);
144 return app_listener_get (ls->al_index);
153 app_listener_alloc_and_init (application_t * app,
154 session_endpoint_cfg_t * sep,
155 app_listener_t ** listener)
157 app_listener_t *app_listener;
158 transport_connection_t *tc;
159 u32 al_index, table_index;
165 app_listener = app_listener_alloc (app);
166 al_index = app_listener->al_index;
167 st = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
170 * Add session endpoint to local session table. Only binds to "inaddr_any"
171 * (i.e., zero address) are added to local scope table.
173 if (application_has_local_scope (app)
174 && session_endpoint_is_local ((session_endpoint_t *) sep))
176 session_type_t local_st;
178 local_st = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE,
180 ls = listen_session_alloc (0, local_st);
181 ls->app_wrk_index = sep->app_wrk_index;
182 lh = session_handle (ls);
184 if ((rv = session_listen (ls, sep)))
186 ls = session_get_from_handle (lh);
188 app_listener_free (app, app_listener);
192 ls = session_get_from_handle (lh);
193 app_listener = app_listener_get (al_index);
194 app_listener->local_index = ls->session_index;
195 app_listener->ls_handle = lh;
196 ls->al_index = al_index;
198 table_index = application_local_session_table (app);
199 session_lookup_add_session_endpoint (table_index,
200 (session_endpoint_t *) sep, lh);
203 if (application_has_global_scope (app))
206 * Start listening on local endpoint for requested transport and scope.
207 * Creates a stream session with state LISTENING to be used in session
208 * lookups, prior to establishing connection. Requests transport to
209 * build it's own specific listening connection.
211 ls = listen_session_alloc (0, st);
212 ls->app_wrk_index = sep->app_wrk_index;
214 /* Listen pool can be reallocated if the transport is
216 lh = listen_session_get_handle (ls);
218 if ((rv = session_listen (ls, sep)))
220 ls = listen_session_get_from_handle (lh);
222 app_listener_free (app, app_listener);
225 ls = listen_session_get_from_handle (lh);
226 app_listener = app_listener_get (al_index);
227 app_listener->session_index = ls->session_index;
228 app_listener->ls_handle = lh;
229 ls->al_index = al_index;
231 /* Add to the global lookup table after transport was initialized.
232 * Lookup table needs to be populated only now because sessions
233 * with cut-through transport are are added to app local tables that
234 * are not related to network fibs, i.e., cannot be added as
236 tc = session_get_transport (ls);
237 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
239 fib_protocol_t fib_proto;
240 fib_proto = session_endpoint_fib_proto ((session_endpoint_t *) sep);
241 /* Assume namespace vetted previously so make sure table exists */
242 table_index = session_lookup_get_or_alloc_index_for_fib (
243 fib_proto, sep->fib_index);
244 session_lookup_add_session_endpoint (table_index,
245 (session_endpoint_t *) sep,
252 app_listener_free (app, app_listener);
256 *listener = app_listener;
261 app_listener_cleanup (app_listener_t * al)
263 application_t *app = application_get (al->app_index);
266 if (al->session_index != SESSION_INVALID_INDEX)
268 ls = session_get (al->session_index, 0);
269 session_stop_listen (ls);
270 listen_session_free (ls);
272 if (al->local_index != SESSION_INVALID_INDEX)
274 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
277 table_index = application_local_session_table (app);
278 ls = listen_session_get (al->local_index);
279 ct_session_endpoint (ls, &sep);
280 session_lookup_del_session_endpoint (table_index, &sep);
281 session_stop_listen (ls);
282 listen_session_free (ls);
284 app_listener_free (app, al);
287 static app_worker_t *
288 app_listener_select_worker (app_listener_t *al)
293 app = application_get (al->app_index);
294 wrk_index = clib_bitmap_next_set (al->workers, al->accept_rotor + 1);
296 wrk_index = clib_bitmap_first_set (al->workers);
298 ASSERT (wrk_index != ~0);
299 al->accept_rotor = wrk_index;
300 return application_get_worker (app, wrk_index);
304 app_listener_get_session (app_listener_t * al)
306 if (al->session_index == SESSION_INVALID_INDEX)
309 return listen_session_get (al->session_index);
313 app_listener_get_local_session (app_listener_t * al)
315 if (al->local_index == SESSION_INVALID_INDEX)
317 return listen_session_get (al->local_index);
321 app_listener_get_wrk_cl_session (app_listener_t *al, u32 wrk_map_index)
323 u32 si = vec_elt (al->cl_listeners, wrk_map_index);
324 return session_get (si, 0 /* listener thread */);
327 static app_worker_map_t *
328 app_worker_map_alloc (application_t * app)
330 app_worker_map_t *map;
331 pool_get (app->worker_maps, map);
332 clib_memset (map, 0, sizeof (*map));
337 app_worker_map_index (application_t * app, app_worker_map_t * map)
339 return (map - app->worker_maps);
343 app_worker_map_free (application_t * app, app_worker_map_t * map)
345 pool_put (app->worker_maps, map);
348 static app_worker_map_t *
349 app_worker_map_get (application_t * app, u32 map_index)
351 if (pool_is_free_index (app->worker_maps, map_index))
353 return pool_elt_at_index (app->worker_maps, map_index);
357 app_get_name (application_t * app)
363 application_session_table (application_t * app, u8 fib_proto)
365 app_namespace_t *app_ns;
366 app_ns = app_namespace_get (app->ns_index);
367 if (!application_has_global_scope (app))
368 return APP_INVALID_INDEX;
369 if (fib_proto == FIB_PROTOCOL_IP4)
370 return session_lookup_get_index_for_fib (fib_proto,
371 app_ns->ip4_fib_index);
373 return session_lookup_get_index_for_fib (fib_proto,
374 app_ns->ip6_fib_index);
378 application_local_session_table (application_t * app)
380 app_namespace_t *app_ns;
381 if (!application_has_local_scope (app))
382 return APP_INVALID_INDEX;
383 app_ns = app_namespace_get (app->ns_index);
384 return app_ns->local_table_index;
388 * Returns app name for app-index
391 application_name_from_index (u32 app_index)
393 application_t *app = application_get (app_index);
396 return app_get_name (app);
400 application_api_table_add (u32 app_index, u32 api_client_index)
402 if (api_client_index != APP_INVALID_INDEX)
403 hash_set (app_main.app_by_api_client_index, api_client_index, app_index);
407 application_api_table_del (u32 api_client_index)
409 hash_unset (app_main.app_by_api_client_index, api_client_index);
413 application_name_table_add (application_t * app)
415 hash_set_mem (app_main.app_by_name, app->name, app->app_index);
419 application_name_table_del (application_t * app)
421 hash_unset_mem (app_main.app_by_name, app->name);
425 application_lookup (u32 api_client_index)
428 p = hash_get (app_main.app_by_api_client_index, api_client_index);
430 return application_get_if_valid (p[0]);
436 application_lookup_name (const u8 * name)
439 p = hash_get_mem (app_main.app_by_name, name);
441 return application_get (p[0]);
447 appsl_pending_rx_mqs_add_tail (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
449 app_rx_mq_elt_t *head;
451 if (!aw->pending_rx_mqs)
453 elt->next = elt->prev = elt;
454 aw->pending_rx_mqs = elt;
458 head = aw->pending_rx_mqs;
460 ASSERT (head != elt);
462 elt->prev = head->prev;
465 head->prev->next = elt;
470 appsl_pending_rx_mqs_del (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
472 if (elt->next == elt)
474 elt->next = elt->prev = 0;
475 aw->pending_rx_mqs = 0;
479 if (elt == aw->pending_rx_mqs)
480 aw->pending_rx_mqs = elt->next;
482 elt->next->prev = elt->prev;
483 elt->prev->next = elt->next;
484 elt->next = elt->prev = 0;
487 vlib_node_registration_t appsl_rx_mqs_input_node;
489 VLIB_NODE_FN (appsl_rx_mqs_input_node)
490 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
492 u32 thread_index = vm->thread_index, n_msgs = 0;
493 app_rx_mq_elt_t *elt, *next;
494 app_main_t *am = &app_main;
495 session_worker_t *wrk;
496 int __clib_unused rv;
500 aw = &am->wrk[thread_index];
501 elt = aw->pending_rx_mqs;
505 wrk = session_main_get_worker (thread_index);
509 if (!(elt->flags & APP_RX_MQ_F_POSTPONED))
510 rv = read (svm_msg_q_get_eventfd (elt->mq), &buf, sizeof (buf));
511 n_msgs += session_wrk_handle_mq (wrk, elt->mq);
514 appsl_pending_rx_mqs_del (aw, elt);
515 if (!svm_msg_q_is_empty (elt->mq))
517 elt->flags |= APP_RX_MQ_F_POSTPONED;
518 appsl_pending_rx_mqs_add_tail (aw, elt);
526 while (aw->pending_rx_mqs && elt != aw->pending_rx_mqs);
528 if (aw->pending_rx_mqs)
529 vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
531 if (n_msgs && wrk->state == SESSION_WRK_INTERRUPT)
532 vlib_node_set_interrupt_pending (vm, session_queue_node.index);
537 VLIB_REGISTER_NODE (appsl_rx_mqs_input_node) = {
538 .name = "appsl-rx-mqs-input",
539 .type = VLIB_NODE_TYPE_INPUT,
540 .state = VLIB_NODE_STATE_DISABLED,
543 static clib_error_t *
544 app_rx_mq_fd_read_ready (clib_file_t *cf)
546 app_rx_mq_handle_t *handle = (app_rx_mq_handle_t *) &cf->private_data;
547 vlib_main_t *vm = vlib_get_main ();
548 app_main_t *am = &app_main;
549 app_rx_mq_elt_t *mqe;
553 ASSERT (vlib_get_thread_index () == handle->thread_index);
554 app = application_get_if_valid (handle->app_index);
558 mqe = &app->rx_mqs[handle->thread_index];
559 if ((mqe->flags & APP_RX_MQ_F_PENDING) || svm_msg_q_is_empty (mqe->mq))
562 aw = &am->wrk[handle->thread_index];
563 appsl_pending_rx_mqs_add_tail (aw, mqe);
564 mqe->flags |= APP_RX_MQ_F_PENDING;
566 vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
571 static clib_error_t *
572 app_rx_mq_fd_write_ready (clib_file_t *cf)
574 clib_warning ("should not be called");
579 app_rx_mqs_epoll_add (application_t *app, app_rx_mq_elt_t *mqe)
581 clib_file_t template = { 0 };
582 app_rx_mq_handle_t handle;
586 thread_index = mqe - app->rx_mqs;
587 fd = svm_msg_q_get_eventfd (mqe->mq);
589 handle.app_index = app->app_index;
590 handle.thread_index = thread_index;
592 template.read_function = app_rx_mq_fd_read_ready;
593 template.write_function = app_rx_mq_fd_write_ready;
594 template.file_descriptor = fd;
595 template.private_data = handle.as_u64;
596 template.polling_thread_index = thread_index;
597 template.description =
598 format (0, "app-%u-rx-mq-%u", app->app_index, thread_index);
599 mqe->file_index = clib_file_add (&file_main, &template);
603 app_rx_mqs_epoll_del (application_t *app, app_rx_mq_elt_t *mqe)
605 u32 thread_index = mqe - app->rx_mqs;
606 app_main_t *am = &app_main;
609 aw = &am->wrk[thread_index];
611 session_wrk_handle_mq (session_main_get_worker (thread_index), mqe->mq);
613 if (mqe->flags & APP_RX_MQ_F_PENDING)
614 appsl_pending_rx_mqs_del (aw, mqe);
616 clib_file_del_by_index (&file_main, mqe->file_index);
620 application_rx_mq_get (application_t *app, u32 mq_index)
625 return app->rx_mqs[mq_index].mq;
629 app_rx_mqs_alloc (application_t *app)
631 u32 evt_q_length, evt_size = sizeof (session_event_t);
632 fifo_segment_t *eqs = &app->rx_mqs_segment;
633 u32 n_mqs = vlib_num_workers () + 1;
634 segment_manager_props_t *props;
637 props = application_segment_manager_properties (app);
638 evt_q_length = clib_max (props->evt_q_size, 128);
640 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
641 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
642 { evt_q_length, evt_size, 0 }, { evt_q_length >> 1, 256, 0 }
644 cfg->consumer_pid = 0;
646 cfg->q_nitems = evt_q_length;
649 eqs->ssvm.ssvm_size = svm_msg_q_size_to_alloc (cfg) * n_mqs + (1 << 20);
650 eqs->ssvm.name = format (0, "%v-rx-mqs-seg%c", app->name, 0);
652 if (ssvm_server_init (&eqs->ssvm, SSVM_SEGMENT_MEMFD))
654 clib_warning ("failed to initialize queue segment");
655 return SESSION_E_SEG_CREATE;
658 fifo_segment_init (eqs);
660 /* Fifo segment filled only with mqs */
661 eqs->h->n_mqs = n_mqs;
662 vec_validate (app->rx_mqs, n_mqs - 1);
664 for (i = 0; i < n_mqs; i++)
666 app->rx_mqs[i].mq = fifo_segment_msg_q_alloc (eqs, i, cfg);
667 if (svm_msg_q_alloc_eventfd (app->rx_mqs[i].mq))
669 clib_warning ("eventfd returned");
670 fifo_segment_cleanup (eqs);
671 ssvm_delete (&eqs->ssvm);
672 return SESSION_E_EVENTFD_ALLOC;
674 app_rx_mqs_epoll_add (app, &app->rx_mqs[i]);
675 app->rx_mqs[i].app_index = app->app_index;
682 application_use_private_rx_mqs (void)
684 return session_main.use_private_rx_mqs;
688 application_get_rx_mqs_segment (application_t *app)
690 if (application_use_private_rx_mqs ())
691 return &app->rx_mqs_segment;
692 return session_main_get_wrk_mqs_segment ();
696 application_enable_rx_mqs_nodes (u8 is_en)
698 u8 state = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
701 vlib_node_set_state (this_vlib_main, appsl_rx_mqs_input_node.index, state);
704 static application_t *
705 application_alloc (void)
708 pool_get (app_main.app_pool, app);
709 clib_memset (app, 0, sizeof (*app));
710 app->app_index = app - app_main.app_pool;
715 application_get (u32 app_index)
717 if (app_index == APP_INVALID_INDEX)
719 return pool_elt_at_index (app_main.app_pool, app_index);
723 application_get_if_valid (u32 app_index)
725 if (pool_is_free_index (app_main.app_pool, app_index))
728 return pool_elt_at_index (app_main.app_pool, app_index);
732 _null_app_tx_callback (session_t *s)
738 application_verify_cb_fns (session_cb_vft_t * cb_fns)
740 if (cb_fns->session_accept_callback == 0)
741 clib_warning ("No accept callback function provided");
742 if (cb_fns->session_connected_callback == 0)
743 clib_warning ("No session connected callback function provided");
744 if (cb_fns->session_disconnect_callback == 0)
745 clib_warning ("No session disconnect callback function provided");
746 if (cb_fns->session_reset_callback == 0)
747 clib_warning ("No session reset callback function provided");
748 if (!cb_fns->builtin_app_tx_callback)
749 cb_fns->builtin_app_tx_callback = _null_app_tx_callback;
753 * Check app config for given segment type
755 * Returns 1 on success and 0 otherwise
758 application_verify_cfg (ssvm_segment_type_t st)
761 if (st == SSVM_SEGMENT_MEMFD)
763 is_valid = (session_main_get_wrk_mqs_segment () != 0);
765 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
768 else if (st == SSVM_SEGMENT_SHM)
770 is_valid = (session_main_get_wrk_mqs_segment () == 0);
772 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
779 static session_error_t
780 application_alloc_and_init (app_init_args_t *a)
782 ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
783 segment_manager_props_t *props;
787 app = application_alloc ();
790 * Make sure we support the requested configuration
792 if ((opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN) &&
793 !(opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_MEMFD_FOR_BUILTIN))
794 seg_type = SSVM_SEGMENT_PRIVATE;
796 if ((opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD) &&
797 seg_type != SSVM_SEGMENT_MEMFD)
799 clib_warning ("mq eventfds can only be used if socket transport is "
800 "used for binary api");
801 return SESSION_E_NOSUPPORT;
804 if (!application_verify_cfg (seg_type))
805 return SESSION_E_NOSUPPORT;
807 if (opts[APP_OPTIONS_PREALLOC_FIFO_PAIRS] &&
808 opts[APP_OPTIONS_PREALLOC_FIFO_HDRS])
809 return SESSION_E_NOSUPPORT;
811 /* Check that the obvious things are properly set up */
812 application_verify_cb_fns (a->session_cb_vft);
814 app->flags = opts[APP_OPTIONS_FLAGS];
815 app->cb_fns = *a->session_cb_vft;
816 app->ns_index = opts[APP_OPTIONS_NAMESPACE];
817 app->proxied_transports = opts[APP_OPTIONS_PROXY_TRANSPORT];
818 app->name = vec_dup (a->name);
820 /* If no scope enabled, default to global */
821 if (!application_has_global_scope (app)
822 && !application_has_local_scope (app))
823 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
825 props = application_segment_manager_properties (app);
826 segment_manager_props_init (props);
827 props->segment_size = opts[APP_OPTIONS_SEGMENT_SIZE];
828 props->prealloc_fifos = opts[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
829 props->prealloc_fifo_hdrs = opts[APP_OPTIONS_PREALLOC_FIFO_HDRS];
830 if (opts[APP_OPTIONS_ADD_SEGMENT_SIZE])
832 props->add_segment_size = opts[APP_OPTIONS_ADD_SEGMENT_SIZE];
833 props->add_segment = 1;
835 if (opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_USE_HUGE_PAGE)
836 props->huge_page = 1;
837 if (opts[APP_OPTIONS_RX_FIFO_SIZE])
838 props->rx_fifo_size = opts[APP_OPTIONS_RX_FIFO_SIZE];
839 if (opts[APP_OPTIONS_TX_FIFO_SIZE])
840 props->tx_fifo_size = opts[APP_OPTIONS_TX_FIFO_SIZE];
841 if (opts[APP_OPTIONS_EVT_QUEUE_SIZE])
842 props->evt_q_size = opts[APP_OPTIONS_EVT_QUEUE_SIZE];
843 if (opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
844 props->use_mq_eventfd = 1;
845 if (opts[APP_OPTIONS_TLS_ENGINE])
846 app->tls_engine = opts[APP_OPTIONS_TLS_ENGINE];
847 if (opts[APP_OPTIONS_MAX_FIFO_SIZE])
848 props->max_fifo_size = opts[APP_OPTIONS_MAX_FIFO_SIZE];
849 if (opts[APP_OPTIONS_HIGH_WATERMARK])
850 props->high_watermark = opts[APP_OPTIONS_HIGH_WATERMARK];
851 if (opts[APP_OPTIONS_LOW_WATERMARK])
852 props->low_watermark = opts[APP_OPTIONS_LOW_WATERMARK];
853 if (opts[APP_OPTIONS_PCT_FIRST_ALLOC])
854 props->pct_first_alloc = opts[APP_OPTIONS_PCT_FIRST_ALLOC];
855 props->segment_type = seg_type;
857 /* Add app to lookup by api_client_index table */
858 if (!application_is_builtin (app))
859 application_api_table_add (app->app_index, a->api_client_index);
861 application_name_table_add (app);
863 a->app_index = app->app_index;
865 APP_DBG ("New app name: %v api index: %u index %u", app->name,
866 a->api_client_index, app->app_index);
872 application_free (application_t * app)
874 app_worker_map_t *wrk_map;
875 app_worker_t *app_wrk;
878 * The app event queue allocated in first segment is cleared with
879 * the segment manager. No need to explicitly free it.
881 APP_DBG ("Delete app name %v index: %d", app->name, app->app_index);
883 if (application_is_proxy (app))
884 application_remove_proxy (app);
891 pool_flush (wrk_map, app->worker_maps, ({
892 app_wrk = app_worker_get (wrk_map->wrk_index);
893 app_worker_free (app_wrk);
896 pool_free (app->worker_maps);
899 * Free rx mqs if allocated
904 for (i = 0; i < vec_len (app->rx_mqs); i++)
905 app_rx_mqs_epoll_del (app, &app->rx_mqs[i]);
907 fifo_segment_cleanup (&app->rx_mqs_segment);
908 ssvm_delete (&app->rx_mqs_segment.ssvm);
909 vec_free (app->rx_mqs);
913 * Cleanup remaining state
915 if (application_is_builtin (app))
916 application_name_table_del (app);
917 vec_free (app->name);
918 pool_put (app_main.app_pool, app);
922 application_detach_process (application_t * app, u32 api_client_index)
924 vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
925 app_worker_map_t *wrk_map;
926 u32 *wrks = 0, *wrk_index;
927 app_worker_t *app_wrk;
929 if (api_client_index == ~0)
931 application_free (app);
935 APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
936 app->app_index, api_client_index);
939 pool_foreach (wrk_map, app->worker_maps) {
940 app_wrk = app_worker_get (wrk_map->wrk_index);
941 if (app_wrk->api_client_index == api_client_index)
942 vec_add1 (wrks, app_wrk->wrk_index);
948 clib_warning ("no workers for app %u api_index %u", app->app_index,
953 args->app_index = app->app_index;
954 args->api_client_index = api_client_index;
955 vec_foreach (wrk_index, wrks)
957 app_wrk = app_worker_get (wrk_index[0]);
958 args->wrk_map_index = app_wrk->wrk_map_index;
960 vnet_app_worker_add_del (args);
966 application_namespace_cleanup (app_namespace_t *app_ns)
968 u32 *app_indices = 0, *app_index;
972 ns_index = app_namespace_index (app_ns);
973 pool_foreach (app, app_main.app_pool)
974 if (app->ns_index == ns_index)
975 vec_add1 (app_indices, app->ns_index);
977 vec_foreach (app_index, app_indices)
979 app = application_get (*app_index);
981 if (application_is_proxy (app))
982 application_remove_proxy (app);
983 app->flags &= ~APP_OPTIONS_FLAGS_IS_PROXY;
985 application_free (app);
987 vec_free (app_indices);
991 application_get_worker (application_t * app, u32 wrk_map_index)
993 app_worker_map_t *map;
994 map = app_worker_map_get (app, wrk_map_index);
997 return app_worker_get (map->wrk_index);
1001 application_get_default_worker (application_t * app)
1003 return application_get_worker (app, 0);
1007 application_n_workers (application_t * app)
1009 return pool_elts (app->worker_maps);
1013 application_listener_select_worker (session_t * ls)
1017 al = app_listener_get (ls->al_index);
1018 return app_listener_select_worker (al);
1022 app_listener_cl_flow_hash (session_dgram_hdr_t *hdr)
1028 hash = clib_crc32c_u32 (hash, hdr->rmt_ip.ip4.as_u32);
1029 hash = clib_crc32c_u32 (hash, hdr->lcl_ip.ip4.as_u32);
1030 hash = clib_crc32c_u16 (hash, hdr->rmt_port);
1031 hash = clib_crc32c_u16 (hash, hdr->lcl_port);
1035 hash = clib_crc32c_u64 (hash, hdr->rmt_ip.ip6.as_u64[0]);
1036 hash = clib_crc32c_u64 (hash, hdr->rmt_ip.ip6.as_u64[1]);
1037 hash = clib_crc32c_u64 (hash, hdr->lcl_ip.ip6.as_u64[0]);
1038 hash = clib_crc32c_u64 (hash, hdr->lcl_ip.ip6.as_u64[1]);
1039 hash = clib_crc32c_u16 (hash, hdr->rmt_port);
1040 hash = clib_crc32c_u16 (hash, hdr->lcl_port);
1047 app_listener_select_wrk_cl_session (session_t *ls, session_dgram_hdr_t *hdr)
1049 u32 wrk_map_index = 0;
1052 al = app_listener_get (ls->al_index);
1053 /* Crude test to check if only worker 0 is set */
1054 if (al->workers[0] != 1)
1056 u32 hash = app_listener_cl_flow_hash (hdr);
1057 hash %= vec_len (al->workers) * sizeof (uword);
1058 wrk_map_index = clib_bitmap_next_set (al->workers, hash);
1059 if (wrk_map_index == ~0)
1060 wrk_map_index = clib_bitmap_first_set (al->workers);
1063 return app_listener_get_wrk_cl_session (al, wrk_map_index);
1067 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
1069 app_worker_map_t *wrk_map;
1070 app_worker_t *app_wrk;
1071 segment_manager_t *sm;
1074 app_wrk = app_worker_alloc (app);
1075 wrk_map = app_worker_map_alloc (app);
1076 wrk_map->wrk_index = app_wrk->wrk_index;
1077 app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
1080 * Setup first segment manager
1082 sm = segment_manager_alloc ();
1083 sm->app_wrk_index = app_wrk->wrk_index;
1085 if ((rv = segment_manager_init_first (sm)))
1087 app_worker_free (app_wrk);
1090 sm->first_is_protected = 1;
1095 app_wrk->connects_seg_manager = segment_manager_index (sm);
1096 app_wrk->listeners_table = hash_create (0, sizeof (u64));
1097 app_wrk->event_queue = segment_manager_event_queue (sm);
1098 app_wrk->app_is_builtin = application_is_builtin (app);
1106 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t *a)
1109 app_worker_map_t *wrk_map;
1110 app_worker_t *app_wrk;
1111 segment_manager_t *sm;
1115 app = application_get (a->app_index);
1117 return SESSION_E_INVALID;
1121 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1124 /* Map worker api index to the app */
1125 app_wrk->api_client_index = a->api_client_index;
1126 application_api_table_add (app->app_index, a->api_client_index);
1128 sm = segment_manager_get (app_wrk->connects_seg_manager);
1129 fs = segment_manager_get_segment_w_lock (sm, 0);
1130 a->segment = &fs->ssvm;
1131 a->segment_handle = segment_manager_segment_handle (sm, fs);
1132 segment_manager_segment_reader_unlock (sm);
1133 a->evt_q = app_wrk->event_queue;
1134 a->wrk_map_index = app_wrk->wrk_map_index;
1138 wrk_map = app_worker_map_get (app, a->wrk_map_index);
1140 return SESSION_E_INVALID;
1142 app_wrk = app_worker_get (wrk_map->wrk_index);
1144 return SESSION_E_INVALID;
1146 application_api_table_del (app_wrk->api_client_index);
1147 if (appns_sapi_enabled ())
1148 sapi_socket_close_w_handle (app_wrk->api_client_index);
1149 app_worker_free (app_wrk);
1150 app_worker_map_free (app, wrk_map);
1151 if (application_n_workers (app) == 0)
1152 application_free (app);
1157 static session_error_t
1158 app_validate_namespace (u8 *namespace_id, u64 secret, u32 *app_ns_index)
1160 app_namespace_t *app_ns;
1161 if (vec_len (namespace_id) == 0)
1163 /* Use default namespace */
1168 *app_ns_index = app_namespace_index_from_id (namespace_id);
1169 if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
1170 return SESSION_E_INVALID_NS;
1171 app_ns = app_namespace_get (*app_ns_index);
1173 return SESSION_E_INVALID_NS;
1174 if (app_ns->ns_secret != secret)
1175 return SESSION_E_WRONG_NS_SECRET;
1180 app_name_from_api_index (u32 api_client_index)
1182 vl_api_registration_t *regp;
1183 regp = vl_api_client_index_to_registration (api_client_index);
1185 return format (0, "%s", regp->name);
1187 clib_warning ("api client index %u does not have an api registration!",
1189 return format (0, "unknown");
1193 * Attach application to vpp
1195 * Allocates a vpp app, i.e., a structure that keeps back pointers
1196 * to external app and a segment manager for shared memory fifo based
1197 * communication with the external app.
1200 vnet_application_attach (vnet_app_attach_args_t *a)
1203 application_t *app = 0;
1204 app_worker_t *app_wrk;
1205 segment_manager_t *sm;
1206 u32 app_ns_index = 0;
1211 if (a->api_client_index != APP_INVALID_INDEX)
1212 app = application_lookup (a->api_client_index);
1214 app = application_lookup_name (a->name);
1216 return SESSION_E_INVALID;
1219 return SESSION_E_APP_ATTACHED;
1221 /* Socket api sets the name and validates namespace prior to attach */
1222 if (!a->use_sock_api)
1224 if (a->api_client_index != APP_INVALID_INDEX)
1226 app_name = app_name_from_api_index (a->api_client_index);
1230 secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
1231 if ((rv = app_validate_namespace (a->namespace_id, secret,
1234 a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
1237 if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
1240 app = application_get (a->app_index);
1241 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1244 a->app_evt_q = app_wrk->event_queue;
1245 app_wrk->api_client_index = a->api_client_index;
1246 sm = segment_manager_get (app_wrk->connects_seg_manager);
1247 fs = segment_manager_get_segment_w_lock (sm, 0);
1249 if (application_is_proxy (app))
1251 application_setup_proxy (app);
1252 /* The segment manager pool is reallocated because a new listener
1253 * is added. Re-grab segment manager to avoid dangling reference */
1254 sm = segment_manager_get (app_wrk->connects_seg_manager);
1257 ASSERT (vec_len (fs->ssvm.name) <= 128);
1258 a->segment = &fs->ssvm;
1259 a->segment_handle = segment_manager_segment_handle (sm, fs);
1261 segment_manager_segment_reader_unlock (sm);
1263 if (!application_is_builtin (app) && application_use_private_rx_mqs ())
1264 rv = app_rx_mqs_alloc (app);
1266 vec_free (app_name);
1271 * Detach application from vpp
1274 vnet_application_detach (vnet_app_detach_args_t *a)
1278 app = application_get_if_valid (a->app_index);
1281 clib_warning ("app not attached");
1282 return SESSION_E_NOAPP;
1285 app_interface_check_thread_and_barrier (vnet_application_detach, a);
1286 application_detach_process (app, a->api_client_index);
1291 session_endpoint_in_ns (session_endpoint_cfg_t *sep)
1295 if (sep->flags & SESSION_ENDPT_CFG_F_PROXY_LISTEN)
1298 is_lep = session_endpoint_is_local ((session_endpoint_t *) sep);
1299 if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
1300 && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
1302 clib_warning ("sw_if_index %u not configured with ip %U",
1303 sep->sw_if_index, format_ip46_address, &sep->ip,
1308 return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
1312 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
1313 application_t * app, u8 is_connect)
1315 app_namespace_t *app_ns;
1316 u32 ns_index, fib_index;
1318 ns_index = app->ns_index;
1320 /* App is a transport proto, so fetch the calling app's ns */
1321 if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
1322 ns_index = sep->ns_index;
1324 app_ns = app_namespace_get (ns_index);
1328 /* Ask transport and network to bind to/connect using local interface
1329 * that "supports" app's namespace. This will fix our local connection
1333 /* If in default namespace and user requested a fib index use it */
1334 if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
1335 fib_index = sep->fib_index;
1337 fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
1338 sep->peer.fib_index = fib_index;
1339 sep->fib_index = fib_index;
1343 sep->sw_if_index = app_ns->sw_if_index;
1347 if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
1348 && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
1349 && sep->peer.sw_if_index != app_ns->sw_if_index)
1350 clib_warning ("Local sw_if_index different from app ns sw_if_index");
1352 sep->peer.sw_if_index = app_ns->sw_if_index;
1357 vnet_listen (vnet_listen_args_t *a)
1359 app_listener_t *app_listener;
1360 app_worker_t *app_wrk;
1364 ASSERT (vlib_thread_is_main_w_barrier ());
1366 app = application_get_if_valid (a->app_index);
1368 return SESSION_E_NOAPP;
1370 app_wrk = application_get_worker (app, a->wrk_map_index);
1372 return SESSION_E_INVALID_APPWRK;
1374 a->sep_ext.app_wrk_index = app_wrk->wrk_index;
1376 session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
1377 if (!session_endpoint_in_ns (&a->sep_ext))
1378 return SESSION_E_INVALID_NS;
1381 * Check if we already have an app listener
1383 app_listener = app_listener_lookup (app, &a->sep_ext);
1386 if (app_listener->app_index != app->app_index)
1387 return SESSION_E_ALREADY_LISTENING;
1388 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1390 a->handle = app_listener_handle (app_listener);
1395 * Create new app listener
1397 if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
1400 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1402 app_listener_cleanup (app_listener);
1406 a->handle = app_listener_handle (app_listener);
1411 vnet_connect (vnet_connect_args_t *a)
1413 app_worker_t *client_wrk;
1414 application_t *client;
1416 ASSERT (session_vlib_thread_is_cl_thread ());
1418 if (session_endpoint_is_zero (&a->sep))
1419 return SESSION_E_INVALID_RMT_IP;
1421 client = application_get (a->app_index);
1422 session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1423 client_wrk = application_get_worker (client, a->wrk_map_index);
1425 a->sep_ext.opaque = a->api_context;
1428 * First check the local scope for locally attached destinations.
1429 * If we have local scope, we pass *all* connects through it since we may
1430 * have special policy rules even for non-local destinations, think proxy.
1432 if (application_has_local_scope (client))
1436 a->sep_ext.original_tp = a->sep_ext.transport_proto;
1437 a->sep_ext.transport_proto = TRANSPORT_PROTO_NONE;
1438 rv = app_worker_connect_session (client_wrk, &a->sep_ext, &a->sh);
1439 a->sep_ext.transport_proto = a->sep_ext.original_tp;
1440 if (!rv || rv != SESSION_E_LOCAL_CONNECT)
1444 * Not connecting to a local server, propagate to transport
1446 return app_worker_connect_session (client_wrk, &a->sep_ext, &a->sh);
1450 vnet_unlisten (vnet_unlisten_args_t *a)
1452 app_worker_t *app_wrk;
1456 ASSERT (vlib_thread_is_main_w_barrier ());
1458 if (!(app = application_get_if_valid (a->app_index)))
1459 return SESSION_E_NOAPP;
1461 if (!(al = app_listener_get_w_handle (a->handle)))
1462 return SESSION_E_NOLISTEN;
1464 if (al->app_index != app->app_index)
1466 clib_warning ("app doesn't own handle %llu!", a->handle);
1467 return SESSION_E_OWNER;
1470 app_wrk = application_get_worker (app, a->wrk_map_index);
1473 clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1474 return SESSION_E_INVALID_APPWRK;
1477 return app_worker_stop_listen (app_wrk, al);
1481 vnet_shutdown_session (vnet_shutdown_args_t *a)
1483 app_worker_t *app_wrk;
1486 s = session_get_from_handle_if_valid (a->handle);
1488 return SESSION_E_NOSESSION;
1490 app_wrk = app_worker_get (s->app_wrk_index);
1491 if (app_wrk->app_index != a->app_index)
1492 return SESSION_E_OWNER;
1494 /* We're peeking into another's thread pool. Make sure */
1495 ASSERT (s->session_index == session_index_from_handle (a->handle));
1497 session_half_close (s);
1502 vnet_disconnect_session (vnet_disconnect_args_t *a)
1504 app_worker_t *app_wrk;
1507 s = session_get_from_handle_if_valid (a->handle);
1509 return SESSION_E_NOSESSION;
1511 app_wrk = app_worker_get (s->app_wrk_index);
1512 if (app_wrk->app_index != a->app_index)
1513 return SESSION_E_OWNER;
1515 /* We're peeking into another's thread pool. Make sure */
1516 ASSERT (s->session_index == session_index_from_handle (a->handle));
1523 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1525 app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1526 app_listener_t *app_listener;
1531 return SESSION_E_INVALID_APPWRK;
1533 hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1534 if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1536 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1538 app = application_get (old_wrk->app_index);
1540 return SESSION_E_NOAPP;
1542 app_listener = app_listener_get (s->al_index);
1544 /* Only remove from lb for now */
1545 app_listener->workers = clib_bitmap_set (app_listener->workers,
1546 old_wrk->wrk_map_index, 0);
1548 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1551 s->app_wrk_index = app_wrk->wrk_index;
1557 application_is_proxy (application_t * app)
1559 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1563 application_is_builtin (application_t * app)
1565 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1569 application_is_builtin_proxy (application_t * app)
1571 return (application_is_proxy (app) && application_is_builtin (app));
1575 application_has_local_scope (application_t * app)
1577 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1581 application_has_global_scope (application_t * app)
1583 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1587 application_original_dst_is_enabled (application_t *app)
1589 return app->flags & APP_OPTIONS_FLAGS_GET_ORIGINAL_DST;
1592 static clib_error_t *
1593 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1594 u8 transport_proto, u8 is_start)
1596 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1597 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1598 session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1599 transport_connection_t *tc;
1600 app_worker_t *app_wrk;
1605 /* TODO decide if we want proxy to be enabled for all workers */
1606 app_wrk = application_get_default_worker (app);
1609 s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1612 sep.is_ip4 = is_ip4;
1613 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1614 sep.sw_if_index = app_ns->sw_if_index;
1615 sep.transport_proto = transport_proto;
1616 sep.app_wrk_index = app_wrk->wrk_index; /* only default */
1618 /* force global scope listener */
1620 app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1621 app_listener_alloc_and_init (app, &sep, &al);
1624 app_worker_start_listen (app_wrk, al);
1625 s = listen_session_get (al->session_index);
1626 s->flags |= SESSION_F_PROXY;
1631 s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1635 tc = listen_session_get_transport (s);
1637 if (!ip_is_zero (&tc->lcl_ip, 1))
1640 sep.is_ip4 = is_ip4;
1641 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1642 sep.transport_proto = transport_proto;
1644 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1646 session_lookup_add_session_endpoint (sti,
1647 (session_endpoint_t *) & sep,
1650 session_lookup_del_session_endpoint (sti,
1651 (session_endpoint_t *) & sep);
1658 application_start_stop_proxy_local_scope (application_t * app,
1659 u8 transport_proto, u8 is_start)
1661 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1662 app_namespace_t *app_ns;
1663 app_ns = app_namespace_get (app->ns_index);
1665 sep.transport_proto = transport_proto;
1670 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1673 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1678 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1680 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1685 application_start_stop_proxy (application_t * app,
1686 transport_proto_t transport_proto, u8 is_start)
1688 if (application_has_local_scope (app))
1689 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1691 if (application_has_global_scope (app))
1693 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1694 transport_proto, is_start);
1695 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1696 transport_proto, is_start);
1701 application_setup_proxy (application_t * app)
1703 u16 transports = app->proxied_transports;
1704 transport_proto_t tp;
1706 ASSERT (application_is_proxy (app));
1708 transport_proto_foreach (tp, transports)
1709 application_start_stop_proxy (app, tp, 1);
1713 application_remove_proxy (application_t * app)
1715 u16 transports = app->proxied_transports;
1716 transport_proto_t tp;
1718 ASSERT (application_is_proxy (app));
1720 transport_proto_foreach (tp, transports)
1721 application_start_stop_proxy (app, tp, 0);
1724 segment_manager_props_t *
1725 application_segment_manager_properties (application_t * app)
1727 return &app->sm_properties;
1730 segment_manager_props_t *
1731 application_get_segment_manager_properties (u32 app_index)
1733 application_t *app = application_get (app_index);
1734 return &app->sm_properties;
1738 application_format_listeners (application_t * app, int verbose)
1740 vlib_main_t *vm = vlib_get_main ();
1741 app_worker_map_t *wrk_map;
1742 app_worker_t *app_wrk;
1748 vlib_cli_output (vm, "%U", format_app_worker_listener, NULL /* header */,
1754 pool_foreach (wrk_map, app->worker_maps) {
1755 app_wrk = app_worker_get (wrk_map->wrk_index);
1756 if (hash_elts (app_wrk->listeners_table) == 0)
1758 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1759 vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1760 handle, sm_index, verbose);
1767 application_format_connects (application_t * app, int verbose)
1769 app_worker_map_t *wrk_map;
1770 app_worker_t *app_wrk;
1774 app_worker_format_connects (0, verbose);
1779 pool_foreach (wrk_map, app->worker_maps) {
1780 app_wrk = app_worker_get (wrk_map->wrk_index);
1781 app_worker_format_connects (app_wrk, verbose);
1787 format_cert_key_pair (u8 * s, va_list * args)
1789 app_cert_key_pair_t *ckpair = va_arg (*args, app_cert_key_pair_t *);
1790 int key_len = 0, cert_len = 0;
1791 cert_len = vec_len (ckpair->cert);
1792 key_len = vec_len (ckpair->key);
1793 if (ckpair->cert_key_index == 0)
1794 s = format (s, "DEFAULT (cert:%d, key:%d)", cert_len, key_len);
1796 s = format (s, "%d (cert:%d, key:%d)", ckpair->cert_key_index,
1802 format_crypto_engine (u8 * s, va_list * args)
1804 u32 engine = va_arg (*args, u32);
1807 case CRYPTO_ENGINE_NONE:
1808 return format (s, "none");
1809 case CRYPTO_ENGINE_MBEDTLS:
1810 return format (s, "mbedtls");
1811 case CRYPTO_ENGINE_OPENSSL:
1812 return format (s, "openssl");
1813 case CRYPTO_ENGINE_PICOTLS:
1814 return format (s, "picotls");
1815 case CRYPTO_ENGINE_VPP:
1816 return format (s, "vpp");
1818 return format (s, "unknown engine");
1824 unformat_crypto_engine (unformat_input_t * input, va_list * args)
1826 u8 *a = va_arg (*args, u8 *);
1827 if (unformat (input, "mbedtls"))
1828 *a = CRYPTO_ENGINE_MBEDTLS;
1829 else if (unformat (input, "openssl"))
1830 *a = CRYPTO_ENGINE_OPENSSL;
1831 else if (unformat (input, "picotls"))
1832 *a = CRYPTO_ENGINE_PICOTLS;
1833 else if (unformat (input, "vpp"))
1834 *a = CRYPTO_ENGINE_VPP;
1841 format_crypto_context (u8 * s, va_list * args)
1843 crypto_context_t *crctx = va_arg (*args, crypto_context_t *);
1844 s = format (s, "[0x%x][sub%d,ckpair%x]", crctx->ctx_index,
1845 crctx->n_subscribers, crctx->ckpair_index);
1846 s = format (s, "[%U]", format_crypto_engine, crctx->crypto_engine);
1851 format_application (u8 * s, va_list * args)
1853 application_t *app = va_arg (*args, application_t *);
1854 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1855 segment_manager_props_t *props;
1856 const u8 *app_ns_name, *app_name;
1857 app_worker_map_t *wrk_map;
1858 app_worker_t *app_wrk;
1863 s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1867 app_name = app_get_name (app);
1868 app_ns_name = app_namespace_id_from_index (app->ns_index);
1869 props = application_segment_manager_properties (app);
1872 s = format (s, "%-10u%-20v%-40v", app->app_index, app_name,
1877 s = format (s, "app-name %v app-index %u ns-index %u seg-size %U\n",
1878 app_name, app->app_index, app->ns_index,
1879 format_memory_size, props->add_segment_size);
1880 s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1881 format_memory_size, props->rx_fifo_size,
1882 format_memory_size, props->tx_fifo_size);
1885 pool_foreach (wrk_map, app->worker_maps) {
1886 app_wrk = app_worker_get (wrk_map->wrk_index);
1887 s = format (s, "%U", format_app_worker, app_wrk);
1895 application_format_all_listeners (vlib_main_t * vm, int verbose)
1899 if (!pool_elts (app_main.app_pool))
1901 vlib_cli_output (vm, "No active server bindings");
1905 application_format_listeners (0, verbose);
1908 pool_foreach (app, app_main.app_pool) {
1909 application_format_listeners (app, verbose);
1915 application_format_all_clients (vlib_main_t * vm, int verbose)
1919 if (!pool_elts (app_main.app_pool))
1921 vlib_cli_output (vm, "No active apps");
1925 application_format_connects (0, verbose);
1928 pool_foreach (app, app_main.app_pool) {
1929 application_format_connects (app, verbose);
1934 static clib_error_t *
1935 show_certificate_command_fn (vlib_main_t * vm, unformat_input_t * input,
1936 vlib_cli_command_t * cmd)
1938 app_cert_key_pair_t *ckpair;
1939 session_cli_return_if_not_enabled ();
1942 pool_foreach (ckpair, app_main.cert_key_pair_store) {
1943 vlib_cli_output (vm, "%U", format_cert_key_pair, ckpair);
1950 appliction_format_app_mq (vlib_main_t * vm, application_t * app)
1952 app_worker_map_t *map;
1957 pool_foreach (map, app->worker_maps) {
1958 wrk = app_worker_get (map->wrk_index);
1959 vlib_cli_output (vm, "[A%d][%d]%U", app->app_index,
1960 map->wrk_index, format_svm_msg_q,
1965 for (i = 0; i < vec_len (app->rx_mqs); i++)
1966 vlib_cli_output (vm, "[A%d][R%d]%U", app->app_index, i, format_svm_msg_q,
1970 static clib_error_t *
1971 appliction_format_all_app_mq (vlib_main_t * vm)
1976 n_threads = vlib_get_n_threads ();
1978 for (i = 0; i < n_threads; i++)
1980 vlib_cli_output (vm, "[Ctrl%d]%U", i, format_svm_msg_q,
1981 session_main_get_vpp_event_queue (i));
1985 pool_foreach (app, app_main.app_pool) {
1986 appliction_format_app_mq (vm, app);
1992 static clib_error_t *
1993 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1994 vlib_cli_command_t * cmd)
1996 int do_server = 0, do_client = 0, do_mq = 0, do_transports = 0;
2002 session_cli_return_if_not_enabled ();
2004 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2006 if (unformat (input, "server"))
2008 else if (unformat (input, "client"))
2010 else if (unformat (input, "transports"))
2012 else if (unformat (input, "mq"))
2014 else if (unformat (input, "%u", &app_index))
2016 else if (unformat (input, "verbose"))
2019 return clib_error_return (0, "unknown input `%U'",
2020 format_unformat_error, input);
2023 if (do_mq && app_index != ~0)
2025 app = application_get_if_valid (app_index);
2027 return clib_error_return (0, "No app with index %u", app_index);
2029 appliction_format_app_mq (vm, app);
2035 appliction_format_all_app_mq (vm);
2041 application_format_all_listeners (vm, verbose);
2047 application_format_all_clients (vm, verbose);
2051 if (app_index != ~0)
2053 app = application_get_if_valid (app_index);
2055 return clib_error_return (0, "No app with index %u", app_index);
2057 vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
2061 /* Print app related info */
2062 if (!do_server && !do_client)
2064 vlib_cli_output (vm, "%U", format_application, 0, 0);
2065 pool_foreach (app, app_main.app_pool) {
2066 is_ta = app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
2067 if ((!do_transports && !is_ta) || (do_transports && is_ta))
2068 vlib_cli_output (vm, "%U", format_application, app, 0);
2075 /* Certificate store */
2077 static app_cert_key_pair_t *
2078 app_cert_key_pair_alloc ()
2080 app_cert_key_pair_t *ckpair;
2081 pool_get (app_main.cert_key_pair_store, ckpair);
2082 clib_memset (ckpair, 0, sizeof (*ckpair));
2083 ckpair->cert_key_index = ckpair - app_main.cert_key_pair_store;
2087 app_cert_key_pair_t *
2088 app_cert_key_pair_get_if_valid (u32 index)
2090 if (pool_is_free_index (app_main.cert_key_pair_store, index))
2092 return app_cert_key_pair_get (index);
2095 app_cert_key_pair_t *
2096 app_cert_key_pair_get (u32 index)
2098 return pool_elt_at_index (app_main.cert_key_pair_store, index);
2101 app_cert_key_pair_t *
2102 app_cert_key_pair_get_default ()
2104 /* To maintain legacy bapi */
2105 return app_cert_key_pair_get (0);
2109 vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a)
2111 app_cert_key_pair_t *ckpair = app_cert_key_pair_alloc ();
2112 vec_validate (ckpair->cert, a->cert_len - 1);
2113 clib_memcpy_fast (ckpair->cert, a->cert, a->cert_len);
2114 vec_validate (ckpair->key, a->key_len - 1);
2115 clib_memcpy_fast (ckpair->key, a->key, a->key_len);
2116 a->index = ckpair->cert_key_index;
2121 vnet_app_add_cert_key_interest (u32 index, u32 app_index)
2123 app_cert_key_pair_t *ckpair;
2124 if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
2126 if (vec_search (ckpair->app_interests, app_index) != ~0)
2127 vec_add1 (ckpair->app_interests, app_index);
2132 vnet_app_del_cert_key_pair (u32 index)
2134 app_cert_key_pair_t *ckpair;
2138 if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
2139 return SESSION_E_INVALID;
2141 vec_foreach (app_index, ckpair->app_interests)
2143 if ((app = application_get_if_valid (*app_index))
2144 && app->cb_fns.app_cert_key_pair_delete_callback)
2145 app->cb_fns.app_cert_key_pair_delete_callback (ckpair);
2148 vec_free (ckpair->cert);
2149 vec_free (ckpair->key);
2150 pool_put (app_main.cert_key_pair_store, ckpair);
2155 application_init (vlib_main_t * vm)
2157 app_main_t *am = &app_main;
2160 n_workers = vlib_num_workers ();
2162 /* Index 0 was originally used by legacy apis, maintain as invalid */
2163 (void) app_cert_key_pair_alloc ();
2164 am->last_crypto_engine = CRYPTO_ENGINE_LAST;
2165 am->app_by_name = hash_create_vec (0, sizeof (u8), sizeof (uword));
2167 vec_validate (am->wrk, n_workers);
2172 VLIB_INIT_FUNCTION (application_init);
2174 VLIB_CLI_COMMAND (show_app_command, static) = {
2176 .short_help = "show app [index] [server|client] [mq] [verbose] "
2178 .function = show_app_command_fn,
2181 VLIB_CLI_COMMAND (show_certificate_command, static) = {
2182 .path = "show app certificate",
2183 .short_help = "list app certs and keys present in store",
2184 .function = show_certificate_command_fn,
2187 crypto_engine_type_t
2188 app_crypto_engine_type_add (void)
2190 return (++app_main.last_crypto_engine);
2194 app_crypto_engine_n_types (void)
2196 return (app_main.last_crypto_engine + 1);
2200 * fd.io coding-style-patch-verification: ON
2203 * eval: (c-set-style "gnu")