2 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vnet/session/application.h>
17 #include <vnet/session/application_interface.h>
18 #include <vnet/session/application_namespace.h>
19 #include <vnet/session/application_local.h>
20 #include <vnet/session/session.h>
22 static app_main_t app_main;
24 #define app_interface_check_thread_and_barrier(_fn, _arg) \
25 if (PREDICT_FALSE (!vlib_thread_is_main_w_barrier ())) \
27 vlib_rpc_call_main_thread (_fn, (u8 *) _arg, sizeof(*_arg)); \
31 static app_listener_t *
32 app_listener_alloc (application_t * app)
34 app_listener_t *app_listener;
35 pool_get (app->listeners, app_listener);
36 clib_memset (app_listener, 0, sizeof (*app_listener));
37 app_listener->al_index = app_listener - app->listeners;
38 app_listener->app_index = app->app_index;
39 app_listener->session_index = SESSION_INVALID_INDEX;
40 app_listener->local_index = SESSION_INVALID_INDEX;
41 app_listener->ls_handle = SESSION_INVALID_HANDLE;
46 app_listener_get (application_t * app, u32 app_listener_index)
48 return pool_elt_at_index (app->listeners, app_listener_index);
52 app_listener_free (application_t * app, app_listener_t * app_listener)
54 clib_bitmap_free (app_listener->workers);
56 clib_memset (app_listener, 0xfa, sizeof (*app_listener));
57 pool_put (app->listeners, app_listener);
61 app_listener_handle (app_listener_t * al)
67 app_listener_get_w_session (session_t * ls)
71 app = application_get_if_valid (ls->app_index);
74 return app_listener_get (app, ls->al_index);
78 app_listen_session_handle (session_t * ls)
81 al = app_listener_get_w_session (ls);
83 return listen_session_get_handle (ls);
88 app_listener_get_w_handle (session_handle_t handle)
91 ls = session_get_from_handle_if_valid (handle);
94 return app_listener_get_w_session (ls);
98 app_listener_lookup (application_t * app, session_endpoint_cfg_t * sep_ext)
100 u32 table_index, fib_proto;
101 session_endpoint_t *sep;
102 session_handle_t handle;
105 ip46_address_t original_ip;
107 sep = (session_endpoint_t *) sep_ext;
108 if (application_has_local_scope (app) && session_endpoint_is_local (sep))
110 table_index = application_local_session_table (app);
111 handle = session_lookup_endpoint_listener (table_index, sep, 1);
112 if (handle != SESSION_INVALID_HANDLE)
114 ls = listen_session_get_from_handle (handle);
115 return app_listener_get_w_session (ls);
119 fib_proto = session_endpoint_fib_proto (sep);
120 table_index = session_lookup_get_index_for_fib (fib_proto, sep->fib_index);
121 handle = session_lookup_endpoint_listener (table_index, sep, 1);
122 if (handle != SESSION_INVALID_HANDLE)
124 ls = listen_session_get_from_handle (handle);
125 return app_listener_get_w_session ((session_t *) ls);
129 * When binds to "inaddr_any", we add zero address in the local lookup table
130 * and interface address in the global lookup table. If local scope disable,
131 * the latter is the only clue to find the listener.
133 if (!application_has_local_scope (app) &&
134 ip_is_zero (&sep_ext->ip, sep_ext->is_ip4) &&
135 sep_ext->sw_if_index != ENDPOINT_INVALID_INDEX)
137 if ((iface_ip = ip_interface_get_first_ip (sep_ext->sw_if_index,
140 ip_copy (&original_ip, &sep_ext->ip, sep_ext->is_ip4);
141 ip_set (&sep_ext->ip, iface_ip, sep_ext->is_ip4);
142 handle = session_lookup_endpoint_listener (table_index, sep, 1);
143 ip_copy (&sep_ext->ip, &original_ip, sep_ext->is_ip4);
144 if (handle != SESSION_INVALID_HANDLE)
146 ls = listen_session_get_from_handle (handle);
147 return app_listener_get_w_session ((session_t *) ls);
156 app_listener_alloc_and_init (application_t * app,
157 session_endpoint_cfg_t * sep,
158 app_listener_t ** listener)
160 app_listener_t *app_listener;
161 transport_connection_t *tc;
162 u32 al_index, table_index;
168 app_listener = app_listener_alloc (app);
169 al_index = app_listener->al_index;
170 st = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
173 * Add session endpoint to local session table. Only binds to "inaddr_any"
174 * (i.e., zero address) are added to local scope table.
176 if (application_has_local_scope (app)
177 && session_endpoint_is_local ((session_endpoint_t *) sep))
179 session_type_t local_st;
181 local_st = session_type_from_proto_and_ip (TRANSPORT_PROTO_NONE,
183 ls = listen_session_alloc (0, local_st);
184 ls->app_index = app->app_index;
185 ls->app_wrk_index = sep->app_wrk_index;
186 lh = session_handle (ls);
188 if ((rv = session_listen (ls, sep)))
190 ls = session_get_from_handle (lh);
192 app_listener_free (app, app_listener);
196 ls = session_get_from_handle (lh);
197 app_listener = app_listener_get (app, al_index);
198 app_listener->local_index = ls->session_index;
199 app_listener->ls_handle = lh;
200 ls->al_index = al_index;
202 table_index = application_local_session_table (app);
203 session_lookup_add_session_endpoint (table_index,
204 (session_endpoint_t *) sep, lh);
207 if (application_has_global_scope (app))
210 * Start listening on local endpoint for requested transport and scope.
211 * Creates a stream session with state LISTENING to be used in session
212 * lookups, prior to establishing connection. Requests transport to
213 * build it's own specific listening connection.
215 ls = listen_session_alloc (0, st);
216 ls->app_index = app->app_index;
217 ls->app_wrk_index = sep->app_wrk_index;
219 /* Listen pool can be reallocated if the transport is
221 lh = listen_session_get_handle (ls);
223 if ((rv = session_listen (ls, sep)))
225 ls = listen_session_get_from_handle (lh);
227 app_listener_free (app, app_listener);
230 ls = listen_session_get_from_handle (lh);
231 app_listener = app_listener_get (app, al_index);
232 app_listener->session_index = ls->session_index;
233 app_listener->ls_handle = lh;
234 ls->al_index = al_index;
236 /* Add to the global lookup table after transport was initialized.
237 * Lookup table needs to be populated only now because sessions
238 * with cut-through transport are are added to app local tables that
239 * are not related to network fibs, i.e., cannot be added as
241 tc = session_get_transport (ls);
242 if (!(tc->flags & TRANSPORT_CONNECTION_F_NO_LOOKUP))
244 fib_protocol_t fib_proto;
245 fib_proto = session_endpoint_fib_proto ((session_endpoint_t *) sep);
246 /* Assume namespace vetted previously so make sure table exists */
247 table_index = session_lookup_get_or_alloc_index_for_fib (
248 fib_proto, sep->fib_index);
249 session_lookup_add_session_endpoint (table_index,
250 (session_endpoint_t *) sep,
257 app_listener_free (app, app_listener);
261 *listener = app_listener;
266 app_listener_cleanup (app_listener_t * al)
268 application_t *app = application_get (al->app_index);
271 if (al->session_index != SESSION_INVALID_INDEX)
273 ls = session_get (al->session_index, 0);
274 session_stop_listen (ls);
275 listen_session_free (ls);
277 if (al->local_index != SESSION_INVALID_INDEX)
279 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
282 table_index = application_local_session_table (app);
283 ls = listen_session_get (al->local_index);
284 ct_session_endpoint (ls, &sep);
285 session_lookup_del_session_endpoint (table_index, &sep);
286 session_stop_listen (ls);
287 listen_session_free (ls);
289 app_listener_free (app, al);
292 static app_worker_t *
293 app_listener_select_worker (application_t * app, app_listener_t * al)
297 app = application_get (al->app_index);
298 wrk_index = clib_bitmap_next_set (al->workers, al->accept_rotor + 1);
300 wrk_index = clib_bitmap_first_set (al->workers);
302 ASSERT (wrk_index != ~0);
303 al->accept_rotor = wrk_index;
304 return application_get_worker (app, wrk_index);
308 app_listener_get_session (app_listener_t * al)
310 if (al->session_index == SESSION_INVALID_INDEX)
313 return listen_session_get (al->session_index);
317 app_listener_get_local_session (app_listener_t * al)
319 if (al->local_index == SESSION_INVALID_INDEX)
321 return listen_session_get (al->local_index);
324 static app_worker_map_t *
325 app_worker_map_alloc (application_t * app)
327 app_worker_map_t *map;
328 pool_get (app->worker_maps, map);
329 clib_memset (map, 0, sizeof (*map));
334 app_worker_map_index (application_t * app, app_worker_map_t * map)
336 return (map - app->worker_maps);
340 app_worker_map_free (application_t * app, app_worker_map_t * map)
342 pool_put (app->worker_maps, map);
345 static app_worker_map_t *
346 app_worker_map_get (application_t * app, u32 map_index)
348 if (pool_is_free_index (app->worker_maps, map_index))
350 return pool_elt_at_index (app->worker_maps, map_index);
354 app_get_name (application_t * app)
360 application_session_table (application_t * app, u8 fib_proto)
362 app_namespace_t *app_ns;
363 app_ns = app_namespace_get (app->ns_index);
364 if (!application_has_global_scope (app))
365 return APP_INVALID_INDEX;
366 if (fib_proto == FIB_PROTOCOL_IP4)
367 return session_lookup_get_index_for_fib (fib_proto,
368 app_ns->ip4_fib_index);
370 return session_lookup_get_index_for_fib (fib_proto,
371 app_ns->ip6_fib_index);
375 application_local_session_table (application_t * app)
377 app_namespace_t *app_ns;
378 if (!application_has_local_scope (app))
379 return APP_INVALID_INDEX;
380 app_ns = app_namespace_get (app->ns_index);
381 return app_ns->local_table_index;
385 * Returns app name for app-index
388 application_name_from_index (u32 app_index)
390 application_t *app = application_get (app_index);
393 return app_get_name (app);
397 application_api_table_add (u32 app_index, u32 api_client_index)
399 if (api_client_index != APP_INVALID_INDEX)
400 hash_set (app_main.app_by_api_client_index, api_client_index, app_index);
404 application_api_table_del (u32 api_client_index)
406 hash_unset (app_main.app_by_api_client_index, api_client_index);
410 application_name_table_add (application_t * app)
412 hash_set_mem (app_main.app_by_name, app->name, app->app_index);
416 application_name_table_del (application_t * app)
418 hash_unset_mem (app_main.app_by_name, app->name);
422 application_lookup (u32 api_client_index)
425 p = hash_get (app_main.app_by_api_client_index, api_client_index);
427 return application_get_if_valid (p[0]);
433 application_lookup_name (const u8 * name)
436 p = hash_get_mem (app_main.app_by_name, name);
438 return application_get (p[0]);
444 appsl_pending_rx_mqs_add_tail (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
446 app_rx_mq_elt_t *head;
448 if (!aw->pending_rx_mqs)
450 elt->next = elt->prev = elt;
451 aw->pending_rx_mqs = elt;
455 head = aw->pending_rx_mqs;
457 ASSERT (head != elt);
459 elt->prev = head->prev;
462 head->prev->next = elt;
467 appsl_pending_rx_mqs_del (appsl_wrk_t *aw, app_rx_mq_elt_t *elt)
469 if (elt->next == elt)
471 elt->next = elt->prev = 0;
472 aw->pending_rx_mqs = 0;
476 if (elt == aw->pending_rx_mqs)
477 aw->pending_rx_mqs = elt->next;
479 elt->next->prev = elt->prev;
480 elt->prev->next = elt->next;
481 elt->next = elt->prev = 0;
484 vlib_node_registration_t appsl_rx_mqs_input_node;
486 VLIB_NODE_FN (appsl_rx_mqs_input_node)
487 (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
489 u32 thread_index = vm->thread_index, n_msgs = 0;
490 app_rx_mq_elt_t *elt, *next;
491 app_main_t *am = &app_main;
492 session_worker_t *wrk;
493 int __clib_unused rv;
497 aw = &am->wrk[thread_index];
498 elt = aw->pending_rx_mqs;
502 wrk = session_main_get_worker (thread_index);
506 if (!(elt->flags & APP_RX_MQ_F_POSTPONED))
507 rv = read (svm_msg_q_get_eventfd (elt->mq), &buf, sizeof (buf));
508 n_msgs += session_wrk_handle_mq (wrk, elt->mq);
511 appsl_pending_rx_mqs_del (aw, elt);
512 if (!svm_msg_q_is_empty (elt->mq))
514 elt->flags |= APP_RX_MQ_F_POSTPONED;
515 appsl_pending_rx_mqs_add_tail (aw, elt);
523 while (aw->pending_rx_mqs && elt != aw->pending_rx_mqs);
525 if (aw->pending_rx_mqs)
526 vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
528 if (n_msgs && wrk->state == SESSION_WRK_INTERRUPT)
529 vlib_node_set_interrupt_pending (vm, session_queue_node.index);
534 VLIB_REGISTER_NODE (appsl_rx_mqs_input_node) = {
535 .name = "appsl-rx-mqs-input",
536 .type = VLIB_NODE_TYPE_INPUT,
537 .state = VLIB_NODE_STATE_DISABLED,
540 static clib_error_t *
541 app_rx_mq_fd_read_ready (clib_file_t *cf)
543 app_rx_mq_handle_t *handle = (app_rx_mq_handle_t *) &cf->private_data;
544 vlib_main_t *vm = vlib_get_main ();
545 app_main_t *am = &app_main;
546 app_rx_mq_elt_t *mqe;
550 ASSERT (vlib_get_thread_index () == handle->thread_index);
551 app = application_get_if_valid (handle->app_index);
555 mqe = &app->rx_mqs[handle->thread_index];
556 if ((mqe->flags & APP_RX_MQ_F_PENDING) || svm_msg_q_is_empty (mqe->mq))
559 aw = &am->wrk[handle->thread_index];
560 appsl_pending_rx_mqs_add_tail (aw, mqe);
561 mqe->flags |= APP_RX_MQ_F_PENDING;
563 vlib_node_set_interrupt_pending (vm, appsl_rx_mqs_input_node.index);
568 static clib_error_t *
569 app_rx_mq_fd_write_ready (clib_file_t *cf)
571 clib_warning ("should not be called");
576 app_rx_mqs_epoll_add (application_t *app, app_rx_mq_elt_t *mqe)
578 clib_file_t template = { 0 };
579 app_rx_mq_handle_t handle;
583 thread_index = mqe - app->rx_mqs;
584 fd = svm_msg_q_get_eventfd (mqe->mq);
586 handle.app_index = app->app_index;
587 handle.thread_index = thread_index;
589 template.read_function = app_rx_mq_fd_read_ready;
590 template.write_function = app_rx_mq_fd_write_ready;
591 template.file_descriptor = fd;
592 template.private_data = handle.as_u64;
593 template.polling_thread_index = thread_index;
594 template.description =
595 format (0, "app-%u-rx-mq-%u", app->app_index, thread_index);
596 mqe->file_index = clib_file_add (&file_main, &template);
600 app_rx_mqs_epoll_del (application_t *app, app_rx_mq_elt_t *mqe)
602 u32 thread_index = mqe - app->rx_mqs;
603 app_main_t *am = &app_main;
606 aw = &am->wrk[thread_index];
608 session_wrk_handle_mq (session_main_get_worker (thread_index), mqe->mq);
610 if (mqe->flags & APP_RX_MQ_F_PENDING)
611 appsl_pending_rx_mqs_del (aw, mqe);
613 clib_file_del_by_index (&file_main, mqe->file_index);
617 application_rx_mq_get (application_t *app, u32 mq_index)
622 return app->rx_mqs[mq_index].mq;
626 app_rx_mqs_alloc (application_t *app)
628 u32 evt_q_length, evt_size = sizeof (session_event_t);
629 fifo_segment_t *eqs = &app->rx_mqs_segment;
630 u32 n_mqs = vlib_num_workers () + 1;
631 segment_manager_props_t *props;
634 props = application_segment_manager_properties (app);
635 evt_q_length = clib_max (props->evt_q_size, 128);
637 svm_msg_q_cfg_t _cfg, *cfg = &_cfg;
638 svm_msg_q_ring_cfg_t rc[SESSION_MQ_N_RINGS] = {
639 { evt_q_length, evt_size, 0 }, { evt_q_length >> 1, 256, 0 }
641 cfg->consumer_pid = 0;
643 cfg->q_nitems = evt_q_length;
646 eqs->ssvm.ssvm_size = svm_msg_q_size_to_alloc (cfg) * n_mqs + (1 << 20);
647 eqs->ssvm.name = format (0, "%v-rx-mqs-seg%c", app->name, 0);
649 if (ssvm_server_init (&eqs->ssvm, SSVM_SEGMENT_MEMFD))
651 clib_warning ("failed to initialize queue segment");
652 return SESSION_E_SEG_CREATE;
655 fifo_segment_init (eqs);
657 /* Fifo segment filled only with mqs */
658 eqs->h->n_mqs = n_mqs;
659 vec_validate (app->rx_mqs, n_mqs - 1);
661 for (i = 0; i < n_mqs; i++)
663 app->rx_mqs[i].mq = fifo_segment_msg_q_alloc (eqs, i, cfg);
664 if (svm_msg_q_alloc_eventfd (app->rx_mqs[i].mq))
666 clib_warning ("eventfd returned");
667 fifo_segment_cleanup (eqs);
668 ssvm_delete (&eqs->ssvm);
669 return SESSION_E_EVENTFD_ALLOC;
671 app_rx_mqs_epoll_add (app, &app->rx_mqs[i]);
672 app->rx_mqs[i].app_index = app->app_index;
679 application_use_private_rx_mqs (void)
681 return session_main.use_private_rx_mqs;
685 application_get_rx_mqs_segment (application_t *app)
687 if (application_use_private_rx_mqs ())
688 return &app->rx_mqs_segment;
689 return session_main_get_wrk_mqs_segment ();
693 application_enable_rx_mqs_nodes (u8 is_en)
695 u8 state = is_en ? VLIB_NODE_STATE_INTERRUPT : VLIB_NODE_STATE_DISABLED;
698 vlib_node_set_state (this_vlib_main, appsl_rx_mqs_input_node.index, state);
701 static application_t *
702 application_alloc (void)
705 pool_get (app_main.app_pool, app);
706 clib_memset (app, 0, sizeof (*app));
707 app->app_index = app - app_main.app_pool;
712 application_get (u32 app_index)
714 if (app_index == APP_INVALID_INDEX)
716 return pool_elt_at_index (app_main.app_pool, app_index);
720 application_get_if_valid (u32 app_index)
722 if (pool_is_free_index (app_main.app_pool, app_index))
725 return pool_elt_at_index (app_main.app_pool, app_index);
729 _null_app_tx_callback (session_t *s)
735 application_verify_cb_fns (session_cb_vft_t * cb_fns)
737 if (cb_fns->session_accept_callback == 0)
738 clib_warning ("No accept callback function provided");
739 if (cb_fns->session_connected_callback == 0)
740 clib_warning ("No session connected callback function provided");
741 if (cb_fns->session_disconnect_callback == 0)
742 clib_warning ("No session disconnect callback function provided");
743 if (cb_fns->session_reset_callback == 0)
744 clib_warning ("No session reset callback function provided");
745 if (!cb_fns->builtin_app_tx_callback)
746 cb_fns->builtin_app_tx_callback = _null_app_tx_callback;
750 * Check app config for given segment type
752 * Returns 1 on success and 0 otherwise
755 application_verify_cfg (ssvm_segment_type_t st)
758 if (st == SSVM_SEGMENT_MEMFD)
760 is_valid = (session_main_get_wrk_mqs_segment () != 0);
762 clib_warning ("memfd seg: vpp's event qs IN binary api svm region");
765 else if (st == SSVM_SEGMENT_SHM)
767 is_valid = (session_main_get_wrk_mqs_segment () == 0);
769 clib_warning ("shm seg: vpp's event qs NOT IN binary api svm region");
776 static session_error_t
777 application_alloc_and_init (app_init_args_t *a)
779 ssvm_segment_type_t seg_type = SSVM_SEGMENT_MEMFD;
780 segment_manager_props_t *props;
784 app = application_alloc ();
787 * Make sure we support the requested configuration
789 if ((opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_IS_BUILTIN) &&
790 !(opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_MEMFD_FOR_BUILTIN))
791 seg_type = SSVM_SEGMENT_PRIVATE;
793 if ((opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD) &&
794 seg_type != SSVM_SEGMENT_MEMFD)
796 clib_warning ("mq eventfds can only be used if socket transport is "
797 "used for binary api");
798 return SESSION_E_NOSUPPORT;
801 if (!application_verify_cfg (seg_type))
802 return SESSION_E_NOSUPPORT;
804 if (opts[APP_OPTIONS_PREALLOC_FIFO_PAIRS] &&
805 opts[APP_OPTIONS_PREALLOC_FIFO_HDRS])
806 return SESSION_E_NOSUPPORT;
808 /* Check that the obvious things are properly set up */
809 application_verify_cb_fns (a->session_cb_vft);
811 app->flags = opts[APP_OPTIONS_FLAGS];
812 app->cb_fns = *a->session_cb_vft;
813 app->ns_index = opts[APP_OPTIONS_NAMESPACE];
814 app->proxied_transports = opts[APP_OPTIONS_PROXY_TRANSPORT];
815 app->name = vec_dup (a->name);
817 /* If no scope enabled, default to global */
818 if (!application_has_global_scope (app)
819 && !application_has_local_scope (app))
820 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
822 props = application_segment_manager_properties (app);
823 segment_manager_props_init (props);
824 props->segment_size = opts[APP_OPTIONS_SEGMENT_SIZE];
825 props->prealloc_fifos = opts[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
826 props->prealloc_fifo_hdrs = opts[APP_OPTIONS_PREALLOC_FIFO_HDRS];
827 if (opts[APP_OPTIONS_ADD_SEGMENT_SIZE])
829 props->add_segment_size = opts[APP_OPTIONS_ADD_SEGMENT_SIZE];
830 props->add_segment = 1;
832 if (opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_USE_HUGE_PAGE)
833 props->huge_page = 1;
834 if (opts[APP_OPTIONS_RX_FIFO_SIZE])
835 props->rx_fifo_size = opts[APP_OPTIONS_RX_FIFO_SIZE];
836 if (opts[APP_OPTIONS_TX_FIFO_SIZE])
837 props->tx_fifo_size = opts[APP_OPTIONS_TX_FIFO_SIZE];
838 if (opts[APP_OPTIONS_EVT_QUEUE_SIZE])
839 props->evt_q_size = opts[APP_OPTIONS_EVT_QUEUE_SIZE];
840 if (opts[APP_OPTIONS_FLAGS] & APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD)
841 props->use_mq_eventfd = 1;
842 if (opts[APP_OPTIONS_TLS_ENGINE])
843 app->tls_engine = opts[APP_OPTIONS_TLS_ENGINE];
844 if (opts[APP_OPTIONS_MAX_FIFO_SIZE])
845 props->max_fifo_size = opts[APP_OPTIONS_MAX_FIFO_SIZE];
846 if (opts[APP_OPTIONS_HIGH_WATERMARK])
847 props->high_watermark = opts[APP_OPTIONS_HIGH_WATERMARK];
848 if (opts[APP_OPTIONS_LOW_WATERMARK])
849 props->low_watermark = opts[APP_OPTIONS_LOW_WATERMARK];
850 if (opts[APP_OPTIONS_PCT_FIRST_ALLOC])
851 props->pct_first_alloc = opts[APP_OPTIONS_PCT_FIRST_ALLOC];
852 props->segment_type = seg_type;
854 /* Add app to lookup by api_client_index table */
855 if (!application_is_builtin (app))
856 application_api_table_add (app->app_index, a->api_client_index);
858 application_name_table_add (app);
860 a->app_index = app->app_index;
862 APP_DBG ("New app name: %v api index: %u index %u", app->name,
863 a->api_client_index, app->app_index);
869 application_free (application_t * app)
871 app_worker_map_t *wrk_map;
872 app_worker_t *app_wrk;
875 * The app event queue allocated in first segment is cleared with
876 * the segment manager. No need to explicitly free it.
878 APP_DBG ("Delete app name %v index: %d", app->name, app->app_index);
880 if (application_is_proxy (app))
881 application_remove_proxy (app);
888 pool_flush (wrk_map, app->worker_maps, ({
889 app_wrk = app_worker_get (wrk_map->wrk_index);
890 app_worker_free (app_wrk);
893 pool_free (app->worker_maps);
896 * Free rx mqs if allocated
901 for (i = 0; i < vec_len (app->rx_mqs); i++)
902 app_rx_mqs_epoll_del (app, &app->rx_mqs[i]);
904 fifo_segment_cleanup (&app->rx_mqs_segment);
905 ssvm_delete (&app->rx_mqs_segment.ssvm);
906 vec_free (app->rx_mqs);
910 * Cleanup remaining state
912 if (application_is_builtin (app))
913 application_name_table_del (app);
914 vec_free (app->name);
915 pool_put (app_main.app_pool, app);
919 application_detach_process (application_t * app, u32 api_client_index)
921 vnet_app_worker_add_del_args_t _args = { 0 }, *args = &_args;
922 app_worker_map_t *wrk_map;
923 u32 *wrks = 0, *wrk_index;
924 app_worker_t *app_wrk;
926 if (api_client_index == ~0)
928 application_free (app);
932 APP_DBG ("Detaching for app %v index %u api client index %u", app->name,
933 app->app_index, api_client_index);
936 pool_foreach (wrk_map, app->worker_maps) {
937 app_wrk = app_worker_get (wrk_map->wrk_index);
938 if (app_wrk->api_client_index == api_client_index)
939 vec_add1 (wrks, app_wrk->wrk_index);
945 clib_warning ("no workers for app %u api_index %u", app->app_index,
950 args->app_index = app->app_index;
951 args->api_client_index = api_client_index;
952 vec_foreach (wrk_index, wrks)
954 app_wrk = app_worker_get (wrk_index[0]);
955 args->wrk_map_index = app_wrk->wrk_map_index;
957 vnet_app_worker_add_del (args);
963 application_namespace_cleanup (app_namespace_t *app_ns)
965 u32 *app_indices = 0, *app_index;
969 ns_index = app_namespace_index (app_ns);
970 pool_foreach (app, app_main.app_pool)
971 if (app->ns_index == ns_index)
972 vec_add1 (app_indices, app->ns_index);
974 vec_foreach (app_index, app_indices)
976 app = application_get (*app_index);
978 if (application_is_proxy (app))
979 application_remove_proxy (app);
980 app->flags &= ~APP_OPTIONS_FLAGS_IS_PROXY;
982 application_free (app);
984 vec_free (app_indices);
988 application_get_worker (application_t * app, u32 wrk_map_index)
990 app_worker_map_t *map;
991 map = app_worker_map_get (app, wrk_map_index);
994 return app_worker_get (map->wrk_index);
998 application_get_default_worker (application_t * app)
1000 return application_get_worker (app, 0);
1004 application_n_workers (application_t * app)
1006 return pool_elts (app->worker_maps);
1010 application_listener_select_worker (session_t * ls)
1015 app = application_get (ls->app_index);
1016 al = app_listener_get (app, ls->al_index);
1017 return app_listener_select_worker (app, al);
1021 application_alloc_worker_and_init (application_t * app, app_worker_t ** wrk)
1023 app_worker_map_t *wrk_map;
1024 app_worker_t *app_wrk;
1025 segment_manager_t *sm;
1028 app_wrk = app_worker_alloc (app);
1029 wrk_map = app_worker_map_alloc (app);
1030 wrk_map->wrk_index = app_wrk->wrk_index;
1031 app_wrk->wrk_map_index = app_worker_map_index (app, wrk_map);
1034 * Setup first segment manager
1036 sm = segment_manager_alloc ();
1037 sm->app_wrk_index = app_wrk->wrk_index;
1039 if ((rv = segment_manager_init_first (sm)))
1041 app_worker_free (app_wrk);
1044 sm->first_is_protected = 1;
1049 app_wrk->connects_seg_manager = segment_manager_index (sm);
1050 app_wrk->listeners_table = hash_create (0, sizeof (u64));
1051 app_wrk->event_queue = segment_manager_event_queue (sm);
1052 app_wrk->app_is_builtin = application_is_builtin (app);
1060 vnet_app_worker_add_del (vnet_app_worker_add_del_args_t *a)
1063 app_worker_map_t *wrk_map;
1064 app_worker_t *app_wrk;
1065 segment_manager_t *sm;
1069 app = application_get (a->app_index);
1071 return SESSION_E_INVALID;
1075 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1078 /* Map worker api index to the app */
1079 app_wrk->api_client_index = a->api_client_index;
1080 application_api_table_add (app->app_index, a->api_client_index);
1082 sm = segment_manager_get (app_wrk->connects_seg_manager);
1083 fs = segment_manager_get_segment_w_lock (sm, 0);
1084 a->segment = &fs->ssvm;
1085 a->segment_handle = segment_manager_segment_handle (sm, fs);
1086 segment_manager_segment_reader_unlock (sm);
1087 a->evt_q = app_wrk->event_queue;
1088 a->wrk_map_index = app_wrk->wrk_map_index;
1092 wrk_map = app_worker_map_get (app, a->wrk_map_index);
1094 return SESSION_E_INVALID;
1096 app_wrk = app_worker_get (wrk_map->wrk_index);
1098 return SESSION_E_INVALID;
1100 application_api_table_del (app_wrk->api_client_index);
1101 if (appns_sapi_enabled ())
1102 sapi_socket_close_w_handle (app_wrk->api_client_index);
1103 app_worker_free (app_wrk);
1104 app_worker_map_free (app, wrk_map);
1105 if (application_n_workers (app) == 0)
1106 application_free (app);
1111 static session_error_t
1112 app_validate_namespace (u8 *namespace_id, u64 secret, u32 *app_ns_index)
1114 app_namespace_t *app_ns;
1115 if (vec_len (namespace_id) == 0)
1117 /* Use default namespace */
1122 *app_ns_index = app_namespace_index_from_id (namespace_id);
1123 if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
1124 return SESSION_E_INVALID_NS;
1125 app_ns = app_namespace_get (*app_ns_index);
1127 return SESSION_E_INVALID_NS;
1128 if (app_ns->ns_secret != secret)
1129 return SESSION_E_WRONG_NS_SECRET;
1134 app_name_from_api_index (u32 api_client_index)
1136 vl_api_registration_t *regp;
1137 regp = vl_api_client_index_to_registration (api_client_index);
1139 return format (0, "%s", regp->name);
1141 clib_warning ("api client index %u does not have an api registration!",
1143 return format (0, "unknown");
1147 * Attach application to vpp
1149 * Allocates a vpp app, i.e., a structure that keeps back pointers
1150 * to external app and a segment manager for shared memory fifo based
1151 * communication with the external app.
1154 vnet_application_attach (vnet_app_attach_args_t *a)
1157 application_t *app = 0;
1158 app_worker_t *app_wrk;
1159 segment_manager_t *sm;
1160 u32 app_ns_index = 0;
1165 if (a->api_client_index != APP_INVALID_INDEX)
1166 app = application_lookup (a->api_client_index);
1168 app = application_lookup_name (a->name);
1170 return SESSION_E_INVALID;
1173 return SESSION_E_APP_ATTACHED;
1175 /* Socket api sets the name and validates namespace prior to attach */
1176 if (!a->use_sock_api)
1178 if (a->api_client_index != APP_INVALID_INDEX)
1180 app_name = app_name_from_api_index (a->api_client_index);
1184 secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
1185 if ((rv = app_validate_namespace (a->namespace_id, secret,
1188 a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
1191 if ((rv = application_alloc_and_init ((app_init_args_t *) a)))
1194 app = application_get (a->app_index);
1195 if ((rv = application_alloc_worker_and_init (app, &app_wrk)))
1198 a->app_evt_q = app_wrk->event_queue;
1199 app_wrk->api_client_index = a->api_client_index;
1200 sm = segment_manager_get (app_wrk->connects_seg_manager);
1201 fs = segment_manager_get_segment_w_lock (sm, 0);
1203 if (application_is_proxy (app))
1205 application_setup_proxy (app);
1206 /* The segment manager pool is reallocated because a new listener
1207 * is added. Re-grab segment manager to avoid dangling reference */
1208 sm = segment_manager_get (app_wrk->connects_seg_manager);
1211 ASSERT (vec_len (fs->ssvm.name) <= 128);
1212 a->segment = &fs->ssvm;
1213 a->segment_handle = segment_manager_segment_handle (sm, fs);
1215 segment_manager_segment_reader_unlock (sm);
1217 if (!application_is_builtin (app) && application_use_private_rx_mqs ())
1218 rv = app_rx_mqs_alloc (app);
1220 vec_free (app_name);
1225 * Detach application from vpp
1228 vnet_application_detach (vnet_app_detach_args_t *a)
1232 app = application_get_if_valid (a->app_index);
1235 clib_warning ("app not attached");
1236 return SESSION_E_NOAPP;
1239 app_interface_check_thread_and_barrier (vnet_application_detach, a);
1240 application_detach_process (app, a->api_client_index);
1245 session_endpoint_in_ns (session_endpoint_cfg_t *sep)
1249 if (sep->flags & SESSION_ENDPT_CFG_F_PROXY_LISTEN)
1252 is_lep = session_endpoint_is_local ((session_endpoint_t *) sep);
1253 if (!is_lep && sep->sw_if_index != ENDPOINT_INVALID_INDEX
1254 && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
1256 clib_warning ("sw_if_index %u not configured with ip %U",
1257 sep->sw_if_index, format_ip46_address, &sep->ip,
1262 return (is_lep || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
1266 session_endpoint_update_for_app (session_endpoint_cfg_t * sep,
1267 application_t * app, u8 is_connect)
1269 app_namespace_t *app_ns;
1270 u32 ns_index, fib_index;
1272 ns_index = app->ns_index;
1274 /* App is a transport proto, so fetch the calling app's ns */
1275 if (app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP)
1276 ns_index = sep->ns_index;
1278 app_ns = app_namespace_get (ns_index);
1282 /* Ask transport and network to bind to/connect using local interface
1283 * that "supports" app's namespace. This will fix our local connection
1287 /* If in default namespace and user requested a fib index use it */
1288 if (ns_index == 0 && sep->fib_index != ENDPOINT_INVALID_INDEX)
1289 fib_index = sep->fib_index;
1291 fib_index = sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
1292 sep->peer.fib_index = fib_index;
1293 sep->fib_index = fib_index;
1297 sep->sw_if_index = app_ns->sw_if_index;
1301 if (app_ns->sw_if_index != APP_NAMESPACE_INVALID_INDEX
1302 && sep->peer.sw_if_index != ENDPOINT_INVALID_INDEX
1303 && sep->peer.sw_if_index != app_ns->sw_if_index)
1304 clib_warning ("Local sw_if_index different from app ns sw_if_index");
1306 sep->peer.sw_if_index = app_ns->sw_if_index;
1311 vnet_listen (vnet_listen_args_t *a)
1313 app_listener_t *app_listener;
1314 app_worker_t *app_wrk;
1318 ASSERT (vlib_thread_is_main_w_barrier ());
1320 app = application_get_if_valid (a->app_index);
1322 return SESSION_E_NOAPP;
1324 app_wrk = application_get_worker (app, a->wrk_map_index);
1326 return SESSION_E_INVALID_APPWRK;
1328 a->sep_ext.app_wrk_index = app_wrk->wrk_index;
1330 session_endpoint_update_for_app (&a->sep_ext, app, 0 /* is_connect */ );
1331 if (!session_endpoint_in_ns (&a->sep_ext))
1332 return SESSION_E_INVALID_NS;
1335 * Check if we already have an app listener
1337 app_listener = app_listener_lookup (app, &a->sep_ext);
1340 if (app_listener->app_index != app->app_index)
1341 return SESSION_E_ALREADY_LISTENING;
1342 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1344 a->handle = app_listener_handle (app_listener);
1349 * Create new app listener
1351 if ((rv = app_listener_alloc_and_init (app, &a->sep_ext, &app_listener)))
1354 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1356 app_listener_cleanup (app_listener);
1360 a->handle = app_listener_handle (app_listener);
1365 vnet_connect (vnet_connect_args_t *a)
1367 app_worker_t *client_wrk;
1368 application_t *client;
1370 ASSERT (session_vlib_thread_is_cl_thread ());
1372 if (session_endpoint_is_zero (&a->sep))
1373 return SESSION_E_INVALID_RMT_IP;
1375 client = application_get (a->app_index);
1376 session_endpoint_update_for_app (&a->sep_ext, client, 1 /* is_connect */ );
1377 client_wrk = application_get_worker (client, a->wrk_map_index);
1379 a->sep_ext.opaque = a->api_context;
1382 * First check the local scope for locally attached destinations.
1383 * If we have local scope, we pass *all* connects through it since we may
1384 * have special policy rules even for non-local destinations, think proxy.
1386 if (application_has_local_scope (client))
1390 a->sep_ext.original_tp = a->sep_ext.transport_proto;
1391 a->sep_ext.transport_proto = TRANSPORT_PROTO_NONE;
1392 rv = app_worker_connect_session (client_wrk, &a->sep_ext, &a->sh);
1393 a->sep_ext.transport_proto = a->sep_ext.original_tp;
1394 if (!rv || rv != SESSION_E_LOCAL_CONNECT)
1398 * Not connecting to a local server, propagate to transport
1400 return app_worker_connect_session (client_wrk, &a->sep_ext, &a->sh);
1404 vnet_unlisten (vnet_unlisten_args_t *a)
1406 app_worker_t *app_wrk;
1410 ASSERT (vlib_thread_is_main_w_barrier ());
1412 if (!(app = application_get_if_valid (a->app_index)))
1413 return SESSION_E_NOAPP;
1415 if (!(al = app_listener_get_w_handle (a->handle)))
1416 return SESSION_E_NOLISTEN;
1418 if (al->app_index != app->app_index)
1420 clib_warning ("app doesn't own handle %llu!", a->handle);
1421 return SESSION_E_OWNER;
1424 app_wrk = application_get_worker (app, a->wrk_map_index);
1427 clib_warning ("no app %u worker %u", app->app_index, a->wrk_map_index);
1428 return SESSION_E_INVALID_APPWRK;
1431 return app_worker_stop_listen (app_wrk, al);
1435 vnet_shutdown_session (vnet_shutdown_args_t *a)
1437 app_worker_t *app_wrk;
1440 s = session_get_from_handle_if_valid (a->handle);
1442 return SESSION_E_NOSESSION;
1444 app_wrk = app_worker_get (s->app_wrk_index);
1445 if (app_wrk->app_index != a->app_index)
1446 return SESSION_E_OWNER;
1448 /* We're peeking into another's thread pool. Make sure */
1449 ASSERT (s->session_index == session_index_from_handle (a->handle));
1451 session_half_close (s);
1456 vnet_disconnect_session (vnet_disconnect_args_t *a)
1458 app_worker_t *app_wrk;
1461 s = session_get_from_handle_if_valid (a->handle);
1463 return SESSION_E_NOSESSION;
1465 app_wrk = app_worker_get (s->app_wrk_index);
1466 if (app_wrk->app_index != a->app_index)
1467 return SESSION_E_OWNER;
1469 /* We're peeking into another's thread pool. Make sure */
1470 ASSERT (s->session_index == session_index_from_handle (a->handle));
1477 application_change_listener_owner (session_t * s, app_worker_t * app_wrk)
1479 app_worker_t *old_wrk = app_worker_get (s->app_wrk_index);
1480 app_listener_t *app_listener;
1485 return SESSION_E_INVALID_APPWRK;
1487 hash_unset (old_wrk->listeners_table, listen_session_get_handle (s));
1488 if (session_transport_service_type (s) == TRANSPORT_SERVICE_CL
1490 segment_manager_dealloc_fifos (s->rx_fifo, s->tx_fifo);
1492 app = application_get (old_wrk->app_index);
1494 return SESSION_E_NOAPP;
1496 app_listener = app_listener_get (app, s->al_index);
1498 /* Only remove from lb for now */
1499 app_listener->workers = clib_bitmap_set (app_listener->workers,
1500 old_wrk->wrk_map_index, 0);
1502 if ((rv = app_worker_start_listen (app_wrk, app_listener)))
1505 s->app_wrk_index = app_wrk->wrk_index;
1511 application_is_proxy (application_t * app)
1513 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
1517 application_is_builtin (application_t * app)
1519 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
1523 application_is_builtin_proxy (application_t * app)
1525 return (application_is_proxy (app) && application_is_builtin (app));
1529 application_has_local_scope (application_t * app)
1531 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1535 application_has_global_scope (application_t * app)
1537 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
1541 application_original_dst_is_enabled (application_t *app)
1543 return app->flags & APP_OPTIONS_FLAGS_GET_ORIGINAL_DST;
1546 static clib_error_t *
1547 application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
1548 u8 transport_proto, u8 is_start)
1550 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
1551 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
1552 session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
1553 transport_connection_t *tc;
1554 app_worker_t *app_wrk;
1559 /* TODO decide if we want proxy to be enabled for all workers */
1560 app_wrk = application_get_default_worker (app);
1563 s = app_worker_first_listener (app_wrk, fib_proto, transport_proto);
1566 sep.is_ip4 = is_ip4;
1567 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1568 sep.sw_if_index = app_ns->sw_if_index;
1569 sep.transport_proto = transport_proto;
1570 sep.app_wrk_index = app_wrk->wrk_index; /* only default */
1572 /* force global scope listener */
1574 app->flags &= ~APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
1575 app_listener_alloc_and_init (app, &sep, &al);
1578 app_worker_start_listen (app_wrk, al);
1579 s = listen_session_get (al->session_index);
1580 s->flags |= SESSION_F_PROXY;
1585 s = app_worker_proxy_listener (app_wrk, fib_proto, transport_proto);
1589 tc = listen_session_get_transport (s);
1591 if (!ip_is_zero (&tc->lcl_ip, 1))
1594 sep.is_ip4 = is_ip4;
1595 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
1596 sep.transport_proto = transport_proto;
1598 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
1600 session_lookup_add_session_endpoint (sti,
1601 (session_endpoint_t *) & sep,
1604 session_lookup_del_session_endpoint (sti,
1605 (session_endpoint_t *) & sep);
1612 application_start_stop_proxy_local_scope (application_t * app,
1613 u8 transport_proto, u8 is_start)
1615 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
1616 app_namespace_t *app_ns;
1617 app_ns = app_namespace_get (app->ns_index);
1619 sep.transport_proto = transport_proto;
1624 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1627 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
1632 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1634 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
1639 application_start_stop_proxy (application_t * app,
1640 transport_proto_t transport_proto, u8 is_start)
1642 if (application_has_local_scope (app))
1643 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
1645 if (application_has_global_scope (app))
1647 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
1648 transport_proto, is_start);
1649 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
1650 transport_proto, is_start);
1655 application_setup_proxy (application_t * app)
1657 u16 transports = app->proxied_transports;
1658 transport_proto_t tp;
1660 ASSERT (application_is_proxy (app));
1662 transport_proto_foreach (tp, transports)
1663 application_start_stop_proxy (app, tp, 1);
1667 application_remove_proxy (application_t * app)
1669 u16 transports = app->proxied_transports;
1670 transport_proto_t tp;
1672 ASSERT (application_is_proxy (app));
1674 transport_proto_foreach (tp, transports)
1675 application_start_stop_proxy (app, tp, 0);
1678 segment_manager_props_t *
1679 application_segment_manager_properties (application_t * app)
1681 return &app->sm_properties;
1684 segment_manager_props_t *
1685 application_get_segment_manager_properties (u32 app_index)
1687 application_t *app = application_get (app_index);
1688 return &app->sm_properties;
1692 application_format_listeners (application_t * app, int verbose)
1694 vlib_main_t *vm = vlib_get_main ();
1695 app_worker_map_t *wrk_map;
1696 app_worker_t *app_wrk;
1702 vlib_cli_output (vm, "%U", format_app_worker_listener, NULL /* header */,
1708 pool_foreach (wrk_map, app->worker_maps) {
1709 app_wrk = app_worker_get (wrk_map->wrk_index);
1710 if (hash_elts (app_wrk->listeners_table) == 0)
1712 hash_foreach (handle, sm_index, app_wrk->listeners_table, ({
1713 vlib_cli_output (vm, "%U", format_app_worker_listener, app_wrk,
1714 handle, sm_index, verbose);
1721 application_format_connects (application_t * app, int verbose)
1723 app_worker_map_t *wrk_map;
1724 app_worker_t *app_wrk;
1728 app_worker_format_connects (0, verbose);
1733 pool_foreach (wrk_map, app->worker_maps) {
1734 app_wrk = app_worker_get (wrk_map->wrk_index);
1735 app_worker_format_connects (app_wrk, verbose);
1741 format_cert_key_pair (u8 * s, va_list * args)
1743 app_cert_key_pair_t *ckpair = va_arg (*args, app_cert_key_pair_t *);
1744 int key_len = 0, cert_len = 0;
1745 cert_len = vec_len (ckpair->cert);
1746 key_len = vec_len (ckpair->key);
1747 if (ckpair->cert_key_index == 0)
1748 s = format (s, "DEFAULT (cert:%d, key:%d)", cert_len, key_len);
1750 s = format (s, "%d (cert:%d, key:%d)", ckpair->cert_key_index,
1756 format_crypto_engine (u8 * s, va_list * args)
1758 u32 engine = va_arg (*args, u32);
1761 case CRYPTO_ENGINE_NONE:
1762 return format (s, "none");
1763 case CRYPTO_ENGINE_MBEDTLS:
1764 return format (s, "mbedtls");
1765 case CRYPTO_ENGINE_OPENSSL:
1766 return format (s, "openssl");
1767 case CRYPTO_ENGINE_PICOTLS:
1768 return format (s, "picotls");
1769 case CRYPTO_ENGINE_VPP:
1770 return format (s, "vpp");
1772 return format (s, "unknown engine");
1778 unformat_crypto_engine (unformat_input_t * input, va_list * args)
1780 u8 *a = va_arg (*args, u8 *);
1781 if (unformat (input, "mbedtls"))
1782 *a = CRYPTO_ENGINE_MBEDTLS;
1783 else if (unformat (input, "openssl"))
1784 *a = CRYPTO_ENGINE_OPENSSL;
1785 else if (unformat (input, "picotls"))
1786 *a = CRYPTO_ENGINE_PICOTLS;
1787 else if (unformat (input, "vpp"))
1788 *a = CRYPTO_ENGINE_VPP;
1795 format_crypto_context (u8 * s, va_list * args)
1797 crypto_context_t *crctx = va_arg (*args, crypto_context_t *);
1798 s = format (s, "[0x%x][sub%d,ckpair%x]", crctx->ctx_index,
1799 crctx->n_subscribers, crctx->ckpair_index);
1800 s = format (s, "[%U]", format_crypto_engine, crctx->crypto_engine);
1805 format_application (u8 * s, va_list * args)
1807 application_t *app = va_arg (*args, application_t *);
1808 CLIB_UNUSED (int verbose) = va_arg (*args, int);
1809 segment_manager_props_t *props;
1810 const u8 *app_ns_name, *app_name;
1811 app_worker_map_t *wrk_map;
1812 app_worker_t *app_wrk;
1817 s = format (s, "%-10s%-20s%-40s", "Index", "Name", "Namespace");
1821 app_name = app_get_name (app);
1822 app_ns_name = app_namespace_id_from_index (app->ns_index);
1823 props = application_segment_manager_properties (app);
1826 s = format (s, "%-10u%-20v%-40v", app->app_index, app_name,
1831 s = format (s, "app-name %v app-index %u ns-index %u seg-size %U\n",
1832 app_name, app->app_index, app->ns_index,
1833 format_memory_size, props->add_segment_size);
1834 s = format (s, "rx-fifo-size %U tx-fifo-size %U workers:\n",
1835 format_memory_size, props->rx_fifo_size,
1836 format_memory_size, props->tx_fifo_size);
1839 pool_foreach (wrk_map, app->worker_maps) {
1840 app_wrk = app_worker_get (wrk_map->wrk_index);
1841 s = format (s, "%U", format_app_worker, app_wrk);
1849 application_format_all_listeners (vlib_main_t * vm, int verbose)
1853 if (!pool_elts (app_main.app_pool))
1855 vlib_cli_output (vm, "No active server bindings");
1859 application_format_listeners (0, verbose);
1862 pool_foreach (app, app_main.app_pool) {
1863 application_format_listeners (app, verbose);
1869 application_format_all_clients (vlib_main_t * vm, int verbose)
1873 if (!pool_elts (app_main.app_pool))
1875 vlib_cli_output (vm, "No active apps");
1879 application_format_connects (0, verbose);
1882 pool_foreach (app, app_main.app_pool) {
1883 application_format_connects (app, verbose);
1888 static clib_error_t *
1889 show_certificate_command_fn (vlib_main_t * vm, unformat_input_t * input,
1890 vlib_cli_command_t * cmd)
1892 app_cert_key_pair_t *ckpair;
1893 session_cli_return_if_not_enabled ();
1896 pool_foreach (ckpair, app_main.cert_key_pair_store) {
1897 vlib_cli_output (vm, "%U", format_cert_key_pair, ckpair);
1904 appliction_format_app_mq (vlib_main_t * vm, application_t * app)
1906 app_worker_map_t *map;
1911 pool_foreach (map, app->worker_maps) {
1912 wrk = app_worker_get (map->wrk_index);
1913 vlib_cli_output (vm, "[A%d][%d]%U", app->app_index,
1914 map->wrk_index, format_svm_msg_q,
1919 for (i = 0; i < vec_len (app->rx_mqs); i++)
1920 vlib_cli_output (vm, "[A%d][R%d]%U", app->app_index, i, format_svm_msg_q,
1924 static clib_error_t *
1925 appliction_format_all_app_mq (vlib_main_t * vm)
1930 n_threads = vlib_get_n_threads ();
1932 for (i = 0; i < n_threads; i++)
1934 vlib_cli_output (vm, "[Ctrl%d]%U", i, format_svm_msg_q,
1935 session_main_get_vpp_event_queue (i));
1939 pool_foreach (app, app_main.app_pool) {
1940 appliction_format_app_mq (vm, app);
1946 static clib_error_t *
1947 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
1948 vlib_cli_command_t * cmd)
1950 int do_server = 0, do_client = 0, do_mq = 0, do_transports = 0;
1956 session_cli_return_if_not_enabled ();
1958 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1960 if (unformat (input, "server"))
1962 else if (unformat (input, "client"))
1964 else if (unformat (input, "transports"))
1966 else if (unformat (input, "mq"))
1968 else if (unformat (input, "%u", &app_index))
1970 else if (unformat (input, "verbose"))
1973 return clib_error_return (0, "unknown input `%U'",
1974 format_unformat_error, input);
1977 if (do_mq && app_index != ~0)
1979 app = application_get_if_valid (app_index);
1981 return clib_error_return (0, "No app with index %u", app_index);
1983 appliction_format_app_mq (vm, app);
1989 appliction_format_all_app_mq (vm);
1995 application_format_all_listeners (vm, verbose);
2001 application_format_all_clients (vm, verbose);
2005 if (app_index != ~0)
2007 app = application_get_if_valid (app_index);
2009 return clib_error_return (0, "No app with index %u", app_index);
2011 vlib_cli_output (vm, "%U", format_application, app, /* verbose */ 1);
2015 /* Print app related info */
2016 if (!do_server && !do_client)
2018 vlib_cli_output (vm, "%U", format_application, 0, 0);
2019 pool_foreach (app, app_main.app_pool) {
2020 is_ta = app->flags & APP_OPTIONS_FLAGS_IS_TRANSPORT_APP;
2021 if ((!do_transports && !is_ta) || (do_transports && is_ta))
2022 vlib_cli_output (vm, "%U", format_application, app, 0);
2029 /* Certificate store */
2031 static app_cert_key_pair_t *
2032 app_cert_key_pair_alloc ()
2034 app_cert_key_pair_t *ckpair;
2035 pool_get (app_main.cert_key_pair_store, ckpair);
2036 clib_memset (ckpair, 0, sizeof (*ckpair));
2037 ckpair->cert_key_index = ckpair - app_main.cert_key_pair_store;
2041 app_cert_key_pair_t *
2042 app_cert_key_pair_get_if_valid (u32 index)
2044 if (pool_is_free_index (app_main.cert_key_pair_store, index))
2046 return app_cert_key_pair_get (index);
2049 app_cert_key_pair_t *
2050 app_cert_key_pair_get (u32 index)
2052 return pool_elt_at_index (app_main.cert_key_pair_store, index);
2055 app_cert_key_pair_t *
2056 app_cert_key_pair_get_default ()
2058 /* To maintain legacy bapi */
2059 return app_cert_key_pair_get (0);
2063 vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a)
2065 app_cert_key_pair_t *ckpair = app_cert_key_pair_alloc ();
2066 vec_validate (ckpair->cert, a->cert_len - 1);
2067 clib_memcpy_fast (ckpair->cert, a->cert, a->cert_len);
2068 vec_validate (ckpair->key, a->key_len - 1);
2069 clib_memcpy_fast (ckpair->key, a->key, a->key_len);
2070 a->index = ckpair->cert_key_index;
2075 vnet_app_add_cert_key_interest (u32 index, u32 app_index)
2077 app_cert_key_pair_t *ckpair;
2078 if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
2080 if (vec_search (ckpair->app_interests, app_index) != ~0)
2081 vec_add1 (ckpair->app_interests, app_index);
2086 vnet_app_del_cert_key_pair (u32 index)
2088 app_cert_key_pair_t *ckpair;
2092 if (!(ckpair = app_cert_key_pair_get_if_valid (index)))
2093 return SESSION_E_INVALID;
2095 vec_foreach (app_index, ckpair->app_interests)
2097 if ((app = application_get_if_valid (*app_index))
2098 && app->cb_fns.app_cert_key_pair_delete_callback)
2099 app->cb_fns.app_cert_key_pair_delete_callback (ckpair);
2102 vec_free (ckpair->cert);
2103 vec_free (ckpair->key);
2104 pool_put (app_main.cert_key_pair_store, ckpair);
2109 application_init (vlib_main_t * vm)
2111 app_main_t *am = &app_main;
2114 n_workers = vlib_num_workers ();
2116 /* Index 0 was originally used by legacy apis, maintain as invalid */
2117 (void) app_cert_key_pair_alloc ();
2118 am->last_crypto_engine = CRYPTO_ENGINE_LAST;
2119 am->app_by_name = hash_create_vec (0, sizeof (u8), sizeof (uword));
2121 vec_validate (am->wrk, n_workers);
2126 VLIB_INIT_FUNCTION (application_init);
2128 VLIB_CLI_COMMAND (show_app_command, static) = {
2130 .short_help = "show app [index] [server|client] [mq] [verbose] "
2132 .function = show_app_command_fn,
2135 VLIB_CLI_COMMAND (show_certificate_command, static) = {
2136 .path = "show app certificate",
2137 .short_help = "list app certs and keys present in store",
2138 .function = show_certificate_command_fn,
2141 crypto_engine_type_t
2142 app_crypto_engine_type_add (void)
2144 return (++app_main.last_crypto_engine);
2148 app_crypto_engine_n_types (void)
2150 return (app_main.last_crypto_engine + 1);
2154 * fd.io coding-style-patch-verification: ON
2157 * eval: (c-set-style "gnu")