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 = ~0;
88 application_del (application_t * app)
90 segment_manager_t *sm;
92 u32 index, *handles = 0;
94 vnet_unbind_args_t _a, *a = &_a;
97 * The app event queue allocated in first segment is cleared with
98 * the segment manager. No need to explicitly free it.
102 * Cleanup segment managers
104 if (app->connects_seg_manager != (u32) ~ 0)
106 sm = segment_manager_get (app->connects_seg_manager);
107 segment_manager_del (sm);
111 hash_foreach (handle, index, app->listeners_table,
113 vec_add1 (handles, handle);
117 /* Actual listener cleanup */
118 for (i = 0; i < vec_len (handles); i++)
120 a->app_index = app->api_client_index;
121 a->handle = handles[i];
122 /* seg manager is removed when unbind completes */
126 application_table_del (app);
127 pool_put (app_pool, app);
131 application_verify_cb_fns (session_cb_vft_t * cb_fns)
133 if (cb_fns->session_accept_callback == 0)
134 clib_warning ("No accept callback function provided");
135 if (cb_fns->session_connected_callback == 0)
136 clib_warning ("No session connected callback function provided");
137 if (cb_fns->session_disconnect_callback == 0)
138 clib_warning ("No session disconnect callback function provided");
139 if (cb_fns->session_reset_callback == 0)
140 clib_warning ("No session reset callback function provided");
144 application_init (application_t * app, u32 api_client_index, u64 * options,
145 session_cb_vft_t * cb_fns)
147 segment_manager_t *sm;
148 segment_manager_properties_t *props;
149 u32 app_evt_queue_size, first_seg_size;
152 app_evt_queue_size = options[APP_EVT_QUEUE_SIZE] > 0 ?
153 options[APP_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
155 /* Setup segment manager */
156 sm = segment_manager_new ();
157 sm->app_index = app->index;
158 props = &app->sm_properties;
159 props->add_segment_size = options[SESSION_OPTIONS_ADD_SEGMENT_SIZE];
160 props->rx_fifo_size = options[SESSION_OPTIONS_RX_FIFO_SIZE];
161 props->tx_fifo_size = options[SESSION_OPTIONS_TX_FIFO_SIZE];
162 props->add_segment = props->add_segment_size != 0;
163 props->preallocated_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
164 props->use_private_segment = options[APP_OPTIONS_FLAGS]
165 & APP_OPTIONS_FLAGS_BUILTIN_APP;
167 first_seg_size = options[SESSION_OPTIONS_SEGMENT_SIZE];
168 if ((rv = segment_manager_init (sm, props, first_seg_size)))
171 app->first_segment_manager = segment_manager_index (sm);
172 app->api_client_index = api_client_index;
173 app->flags = options[APP_OPTIONS_FLAGS];
174 app->cb_fns = *cb_fns;
176 /* Allocate app event queue in the first shared-memory segment */
177 app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
179 /* Check that the obvious things are properly set up */
180 application_verify_cb_fns (cb_fns);
182 /* Add app to lookup by api_client_index table */
183 application_table_add (app);
189 application_get (u32 index)
191 return pool_elt_at_index (app_pool, index);
195 application_get_if_valid (u32 index)
197 if (pool_is_free_index (app_pool, index))
200 return pool_elt_at_index (app_pool, index);
204 application_get_index (application_t * app)
206 return app - app_pool;
209 static segment_manager_t *
210 application_alloc_segment_manager (application_t * app)
212 segment_manager_t *sm = 0;
214 if (app->first_segment_manager != (u32) ~ 0)
216 sm = segment_manager_get (app->first_segment_manager);
217 app->first_segment_manager = ~0;
221 sm = segment_manager_new ();
222 if (segment_manager_init (sm, &app->sm_properties, 0))
228 * Start listening local transport endpoint for requested transport.
230 * Creates a 'dummy' stream session with state LISTENING to be used in session
231 * lookups, prior to establishing connection. Requests transport to build
232 * it's own specific listening connection.
235 application_start_listen (application_t * srv, session_type_t session_type,
236 transport_endpoint_t * tep, u64 * res)
238 segment_manager_t *sm;
242 s = listen_session_new (session_type);
243 s->app_index = srv->index;
245 if (stream_session_listen (s, tep))
248 /* Allocate segment manager. All sessions derived out of a listen session
249 * have fifos allocated by the same segment manager. */
250 sm = application_alloc_segment_manager (srv);
254 /* Add to app's listener table. Useful to find all child listeners
255 * when app goes down, although, just for unbinding this is not needed */
256 handle = listen_session_get_handle (s);
257 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
263 listen_session_del (s);
268 * Stop listening on session associated to handle
271 application_stop_listen (application_t * srv, u64 handle)
273 stream_session_t *listener;
275 segment_manager_t *sm;
277 if (srv && hash_get (srv->listeners_table, handle) == 0)
279 clib_warning ("app doesn't own handle %llu!", handle);
283 listener = listen_session_get_from_handle (handle);
284 stream_session_stop_listen (listener);
286 indexp = hash_get (srv->listeners_table, handle);
289 sm = segment_manager_get (*indexp);
290 segment_manager_del (sm);
291 hash_unset (srv->listeners_table, handle);
292 listen_session_del (listener);
298 application_open_session (application_t * app, session_type_t sst,
299 transport_endpoint_t * tep, u32 api_context)
301 segment_manager_t *sm;
302 transport_connection_t *tc = 0;
305 /* Make sure we have a segment manager for connects */
306 if (app->connects_seg_manager == (u32) ~ 0)
308 sm = application_alloc_segment_manager (app);
311 app->connects_seg_manager = segment_manager_index (sm);
314 if ((rv = stream_session_open (app->index, sst, tep, &tc)))
317 /* Store api_context for when the reply comes. Not the nicest thing
318 * but better allocating a separate half-open pool. */
319 tc->s_index = api_context;
325 application_get_connect_segment_manager (application_t * app)
327 ASSERT (app->connects_seg_manager != (u32) ~ 0);
328 return segment_manager_get (app->connects_seg_manager);
332 application_get_listen_segment_manager (application_t * app,
333 stream_session_t * s)
336 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
338 return segment_manager_get (*smp);
342 app_get_name_from_reg_index (application_t * app)
346 vl_api_registration_t *regp;
347 regp = vl_api_client_index_to_registration (app->api_client_index);
349 app_name = format (0, "builtin-%d%c", app->index, 0);
351 app_name = format (0, "%s%c", regp->name, 0);
357 format_application_listener (u8 * s, va_list * args)
359 application_t *app = va_arg (*args, application_t *);
360 u64 handle = va_arg (*args, u64);
361 u32 index = va_arg (*args, u32);
362 int verbose = va_arg (*args, int);
363 stream_session_t *listener;
369 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
370 "API Client", "ListenerID", "SegManager");
372 s = format (s, "%-40s%-20s", "Connection", "App");
377 app_name = app_get_name_from_reg_index (app);
378 listener = listen_session_get_from_handle (handle);
379 str = format (0, "%U", format_stream_session, listener, verbose);
383 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
384 app->api_client_index, handle, index);
387 s = format (s, "%-40s%-20s", str, app_name);
394 application_format_connects (application_t * app, int verbose)
396 vlib_main_t *vm = vlib_get_main ();
397 segment_manager_t *sm;
398 u8 *app_name, *s = 0;
405 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
406 "API Client", "SegManager");
408 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
413 if (app->connects_seg_manager == (u32) ~ 0)
416 app_name = app_get_name_from_reg_index (app);
418 /* Across all fifo segments */
419 sm = segment_manager_get (app->connects_seg_manager);
420 for (j = 0; j < vec_len (sm->segment_indices); j++)
422 svm_fifo_segment_private_t *fifo_segment;
426 fifo_segment = svm_fifo_get_segment (sm->segment_indices[j]);
427 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
430 u32 session_index, thread_index;
431 stream_session_t *session;
433 session_index = fifo->master_session_index;
434 thread_index = fifo->master_thread_index;
436 session = stream_session_get (session_index, thread_index);
437 str = format (0, "%U", format_stream_session, session, verbose);
440 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
441 app->api_client_index, app->connects_seg_manager);
443 s = format (s, "%-40s%-20s", str, app_name);
445 vlib_cli_output (vm, "%v", s);
446 vec_reset_length (s);
458 format_application (u8 * s, va_list * args)
460 application_t *app = va_arg (*args, application_t *);
461 CLIB_UNUSED (int verbose) = va_arg (*args, int);
467 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s", "Index", "Name",
468 "API Client", "Add seg size", "Rx fifo size",
471 s = format (s, "%-10s%-20s%-20s", "Index", "Name", "API Client");
475 app_name = app_get_name_from_reg_index (app);
477 s = format (s, "%-10d%-20s%-15d%-15d%-15d%-15d", app->index, app_name,
478 app->api_client_index, app->sm_properties.add_segment_size,
479 app->sm_properties.rx_fifo_size,
480 app->sm_properties.tx_fifo_size);
482 s = format (s, "%-10d%-20s%-20d", app->index, app_name,
483 app->api_client_index);
487 static clib_error_t *
488 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
489 vlib_cli_command_t * cmd)
496 if (!session_manager_is_enabled ())
498 clib_error_return (0, "session layer is not enabled");
501 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
503 if (unformat (input, "server"))
505 else if (unformat (input, "client"))
507 else if (unformat (input, "verbose"))
517 if (pool_elts (app_pool))
519 vlib_cli_output (vm, "%U", format_application_listener,
520 0 /* header */ , 0, 0,
523 pool_foreach (app, app_pool,
525 /* App's listener sessions */
526 if (hash_elts (app->listeners_table) == 0)
528 hash_foreach (handle, index, app->listeners_table,
530 vlib_cli_output (vm, "%U", format_application_listener, app,
531 handle, index, verbose);
537 vlib_cli_output (vm, "No active server bindings");
542 if (pool_elts (app_pool))
544 application_format_connects (0, verbose);
547 pool_foreach (app, app_pool,
549 if (app->connects_seg_manager == (u32)~0)
551 application_format_connects (app, verbose);
556 vlib_cli_output (vm, "No active client bindings");
559 /* Print app related info */
560 if (!do_server && !do_client)
562 vlib_cli_output (vm, "%U", format_application, 0, verbose);
563 pool_foreach (app, app_pool, (
565 vlib_cli_output (vm, "%U",
566 format_application, app,
576 VLIB_CLI_COMMAND (show_app_command, static) =
579 .short_help = "show app [server|client] [verbose]",
580 .function = show_app_command_fn,
585 * fd.io coding-style-patch-verification: ON
588 * eval: (c-set-style "gnu")