2 * Copyright (c) 2017 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/session.h>
21 * Pool from which we allocate all applications
23 static application_t *app_pool;
26 * Hash table of apps by api client index
28 static uword *app_by_api_client_index;
31 * Default application event queue size
33 static u32 default_app_evt_queue_size = 128;
36 application_api_queue_is_full (application_t * app)
38 unix_shared_memory_queue_t *q;
40 /* builtin servers are always OK */
41 if (app->api_client_index == ~0)
44 q = vl_api_client_index_to_input_queue (app->api_client_index);
48 if (q->cursize == q->maxsize)
54 application_table_add (application_t * app)
56 hash_set (app_by_api_client_index, app->api_client_index, app->index);
60 application_table_del (application_t * app)
62 hash_unset (app_by_api_client_index, app->api_client_index);
66 application_lookup (u32 api_client_index)
69 p = hash_get (app_by_api_client_index, api_client_index);
71 return application_get (p[0]);
80 pool_get (app_pool, app);
81 memset (app, 0, sizeof (*app));
82 app->index = application_get_index (app);
83 app->connects_seg_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
84 app->first_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
86 clib_warning ("[%d] New app (%d)", getpid (), app->index);
91 application_del (application_t * app)
93 segment_manager_t *sm;
95 u32 index, *handles = 0;
97 vnet_unbind_args_t _a, *a = &_a;
100 * The app event queue allocated in first segment is cleared with
101 * the segment manager. No need to explicitly free it.
104 clib_warning ("[%d] Delete app (%d)", getpid (), app->index);
111 hash_foreach (handle, index, app->listeners_table,
113 vec_add1 (handles, handle);
114 sm = segment_manager_get (index);
115 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
119 for (i = 0; i < vec_len (handles); i++)
121 a->app_index = app->index;
122 a->handle = handles[i];
123 /* seg manager is removed when unbind completes */
128 * Connects segment manager cleanup
131 if (app->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
133 sm = segment_manager_get (app->connects_seg_manager);
134 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
135 segment_manager_init_del (sm);
139 /* If first segment manager is used by a listener */
140 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
141 && app->first_segment_manager != app->connects_seg_manager)
143 sm = segment_manager_get (app->first_segment_manager);
144 /* .. and has no fifos, e.g. it might be used for redirected sessions,
146 if (!segment_manager_has_fifos (sm))
148 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
149 segment_manager_del (sm);
153 application_table_del (app);
154 pool_put (app_pool, app);
158 application_verify_cb_fns (session_cb_vft_t * cb_fns)
160 if (cb_fns->session_accept_callback == 0)
161 clib_warning ("No accept callback function provided");
162 if (cb_fns->session_connected_callback == 0)
163 clib_warning ("No session connected callback function provided");
164 if (cb_fns->session_disconnect_callback == 0)
165 clib_warning ("No session disconnect callback function provided");
166 if (cb_fns->session_reset_callback == 0)
167 clib_warning ("No session reset callback function provided");
171 application_init (application_t * app, u32 api_client_index, u64 * options,
172 session_cb_vft_t * cb_fns)
174 segment_manager_t *sm;
175 segment_manager_properties_t *props;
176 u32 app_evt_queue_size, first_seg_size;
177 u32 default_rx_fifo_size = 16 << 10, default_tx_fifo_size = 16 << 10;
180 app_evt_queue_size = options[APP_EVT_QUEUE_SIZE] > 0 ?
181 options[APP_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
183 /* Setup segment manager */
184 sm = segment_manager_new ();
185 sm->app_index = app->index;
186 props = &app->sm_properties;
187 props->add_segment_size = options[SESSION_OPTIONS_ADD_SEGMENT_SIZE];
188 props->rx_fifo_size = options[SESSION_OPTIONS_RX_FIFO_SIZE];
189 props->rx_fifo_size =
190 props->rx_fifo_size ? props->rx_fifo_size : default_rx_fifo_size;
191 props->tx_fifo_size = options[SESSION_OPTIONS_TX_FIFO_SIZE];
192 props->tx_fifo_size =
193 props->tx_fifo_size ? props->tx_fifo_size : default_tx_fifo_size;
194 props->add_segment = props->add_segment_size != 0;
195 props->preallocated_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
196 props->use_private_segment = options[APP_OPTIONS_FLAGS]
197 & APP_OPTIONS_FLAGS_BUILTIN_APP;
198 props->private_segment_count = options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT];
199 props->private_segment_size = options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE];
201 first_seg_size = options[SESSION_OPTIONS_SEGMENT_SIZE];
202 if ((rv = segment_manager_init (sm, props, first_seg_size)))
204 sm->first_is_protected = 1;
206 app->first_segment_manager = segment_manager_index (sm);
207 app->api_client_index = api_client_index;
208 app->flags = options[APP_OPTIONS_FLAGS];
209 app->cb_fns = *cb_fns;
211 /* Allocate app event queue in the first shared-memory segment */
212 app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
214 /* Check that the obvious things are properly set up */
215 application_verify_cb_fns (cb_fns);
217 /* Add app to lookup by api_client_index table */
218 application_table_add (app);
224 application_get (u32 index)
226 return pool_elt_at_index (app_pool, index);
230 application_get_if_valid (u32 index)
232 if (pool_is_free_index (app_pool, index))
235 return pool_elt_at_index (app_pool, index);
239 application_get_index (application_t * app)
241 return app - app_pool;
244 static segment_manager_t *
245 application_alloc_segment_manager (application_t * app)
247 segment_manager_t *sm = 0;
249 /* If the first segment manager is not in use, don't allocate a new one */
250 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
251 && app->first_segment_manager_in_use == 0)
253 sm = segment_manager_get (app->first_segment_manager);
254 app->first_segment_manager_in_use = 1;
258 sm = segment_manager_new ();
259 sm->properties = &app->sm_properties;
265 * Start listening local transport endpoint for requested transport.
267 * Creates a 'dummy' stream session with state LISTENING to be used in session
268 * lookups, prior to establishing connection. Requests transport to build
269 * it's own specific listening connection.
272 application_start_listen (application_t * srv, session_type_t session_type,
273 transport_endpoint_t * tep, u64 * res)
275 segment_manager_t *sm;
279 s = listen_session_new (session_type);
280 s->app_index = srv->index;
282 if (stream_session_listen (s, tep))
285 /* Allocate segment manager. All sessions derived out of a listen session
286 * have fifos allocated by the same segment manager. */
287 sm = application_alloc_segment_manager (srv);
291 /* Add to app's listener table. Useful to find all child listeners
292 * when app goes down, although, just for unbinding this is not needed */
293 handle = listen_session_get_handle (s);
294 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
300 listen_session_del (s);
305 * Stop listening on session associated to handle
308 application_stop_listen (application_t * srv, u64 handle)
310 stream_session_t *listener;
312 segment_manager_t *sm;
314 if (srv && hash_get (srv->listeners_table, handle) == 0)
316 clib_warning ("app doesn't own handle %llu!", handle);
320 listener = listen_session_get_from_handle (handle);
321 stream_session_stop_listen (listener);
323 indexp = hash_get (srv->listeners_table, handle);
326 sm = segment_manager_get (*indexp);
327 if (srv->first_segment_manager == *indexp)
329 /* Delete sessions but don't remove segment manager */
330 srv->first_segment_manager_in_use = 0;
331 segment_manager_del_sessions (sm);
335 segment_manager_init_del (sm);
337 hash_unset (srv->listeners_table, handle);
338 listen_session_del (listener);
344 application_open_session (application_t * app, session_type_t sst,
345 transport_endpoint_t * tep, u32 api_context)
347 segment_manager_t *sm;
348 transport_connection_t *tc = 0;
351 /* Make sure we have a segment manager for connects */
352 if (app->connects_seg_manager == (u32) ~ 0)
354 sm = application_alloc_segment_manager (app);
357 app->connects_seg_manager = segment_manager_index (sm);
360 if ((rv = stream_session_open (app->index, sst, tep, &tc)))
363 /* Store api_context for when the reply comes. Not the nicest thing
364 * but better than allocating a separate half-open pool. */
365 tc->s_index = api_context;
371 application_get_connect_segment_manager (application_t * app)
373 ASSERT (app->connects_seg_manager != (u32) ~ 0);
374 return segment_manager_get (app->connects_seg_manager);
378 application_get_listen_segment_manager (application_t * app,
379 stream_session_t * s)
382 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
384 return segment_manager_get (*smp);
388 app_get_name_from_reg_index (application_t * app)
392 vl_api_registration_t *regp;
393 regp = vl_api_client_index_to_registration (app->api_client_index);
395 app_name = format (0, "builtin-%d%c", app->index, 0);
397 app_name = format (0, "%s%c", regp->name, 0);
403 application_is_proxy (application_t * app)
405 return !(app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
409 application_add_segment_notify (u32 app_index, u32 fifo_segment_index)
411 application_t *app = application_get (app_index);
415 /* Send an API message to the external app, to map new segment */
416 ASSERT (app->cb_fns.add_segment_callback);
418 segment_manager_get_segment_info (fifo_segment_index, &seg_name, &seg_size);
419 return app->cb_fns.add_segment_callback (app->api_client_index, seg_name,
424 format_application_listener (u8 * s, va_list * args)
426 application_t *app = va_arg (*args, application_t *);
427 u64 handle = va_arg (*args, u64);
428 u32 index = va_arg (*args, u32);
429 int verbose = va_arg (*args, int);
430 stream_session_t *listener;
436 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
437 "API Client", "ListenerID", "SegManager");
439 s = format (s, "%-40s%-20s", "Connection", "App");
444 app_name = app_get_name_from_reg_index (app);
445 listener = listen_session_get_from_handle (handle);
446 str = format (0, "%U", format_stream_session, listener, verbose);
450 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
451 app->api_client_index, handle, index);
454 s = format (s, "%-40s%-20s", str, app_name);
461 application_format_connects (application_t * app, int verbose)
463 vlib_main_t *vm = vlib_get_main ();
464 segment_manager_t *sm;
465 u8 *app_name, *s = 0;
472 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
473 "API Client", "SegManager");
475 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
480 if (app->connects_seg_manager == (u32) ~ 0)
483 app_name = app_get_name_from_reg_index (app);
485 /* Across all fifo segments */
486 sm = segment_manager_get (app->connects_seg_manager);
487 for (j = 0; j < vec_len (sm->segment_indices); j++)
489 svm_fifo_segment_private_t *fifo_segment;
493 fifo_segment = svm_fifo_segment_get_segment (sm->segment_indices[j]);
494 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
497 u32 session_index, thread_index;
498 stream_session_t *session;
500 session_index = fifo->master_session_index;
501 thread_index = fifo->master_thread_index;
503 session = stream_session_get (session_index, thread_index);
504 str = format (0, "%U", format_stream_session, session, verbose);
507 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
508 app->api_client_index, app->connects_seg_manager);
510 s = format (s, "%-40s%-20s", str, app_name);
512 vlib_cli_output (vm, "%v", s);
513 vec_reset_length (s);
525 format_application (u8 * s, va_list * args)
527 application_t *app = va_arg (*args, application_t *);
528 CLIB_UNUSED (int verbose) = va_arg (*args, int);
534 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s", "Index", "Name",
535 "API Client", "Add seg size", "Rx fifo size",
538 s = format (s, "%-10s%-20s%-20s", "Index", "Name", "API Client");
542 app_name = app_get_name_from_reg_index (app);
544 s = format (s, "%-10d%-20s%-15d%-15d%-15d%-15d", app->index, app_name,
545 app->api_client_index, app->sm_properties.add_segment_size,
546 app->sm_properties.rx_fifo_size,
547 app->sm_properties.tx_fifo_size);
549 s = format (s, "%-10d%-20s%-20d", app->index, app_name,
550 app->api_client_index);
554 static clib_error_t *
555 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
556 vlib_cli_command_t * cmd)
563 if (!session_manager_is_enabled ())
565 clib_error_return (0, "session layer is not enabled");
568 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
570 if (unformat (input, "server"))
572 else if (unformat (input, "client"))
574 else if (unformat (input, "verbose"))
584 if (pool_elts (app_pool))
586 vlib_cli_output (vm, "%U", format_application_listener,
587 0 /* header */ , 0, 0,
590 pool_foreach (app, app_pool,
592 /* App's listener sessions */
593 if (hash_elts (app->listeners_table) == 0)
595 hash_foreach (handle, index, app->listeners_table,
597 vlib_cli_output (vm, "%U", format_application_listener, app,
598 handle, index, verbose);
604 vlib_cli_output (vm, "No active server bindings");
609 if (pool_elts (app_pool))
611 application_format_connects (0, verbose);
614 pool_foreach (app, app_pool,
616 if (app->connects_seg_manager == (u32)~0)
618 application_format_connects (app, verbose);
623 vlib_cli_output (vm, "No active client bindings");
626 /* Print app related info */
627 if (!do_server && !do_client)
629 vlib_cli_output (vm, "%U", format_application, 0, verbose);
630 pool_foreach (app, app_pool, (
632 vlib_cli_output (vm, "%U",
633 format_application, app,
643 VLIB_CLI_COMMAND (show_app_command, static) =
646 .short_help = "show app [server|client] [verbose]",
647 .function = show_app_command_fn,
652 * fd.io coding-style-patch-verification: ON
655 * eval: (c-set-style "gnu")