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;
84 app->first_segment_manager = ~0;
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);
107 * Cleanup segment managers
109 if ((app->connects_seg_manager != (u32) ~ 0) &&
110 (app->connects_seg_manager != app->first_segment_manager))
112 sm = segment_manager_get (app->connects_seg_manager);
113 segment_manager_del (sm);
117 hash_foreach (handle, index, app->listeners_table,
119 vec_add1 (handles, handle);
123 /* Actual listener cleanup */
124 for (i = 0; i < vec_len (handles); i++)
126 a->app_index = app->index;
127 a->handle = handles[i];
128 /* seg manager is removed when unbind completes */
132 if (app->first_segment_manager != ~0)
134 sm = segment_manager_get (app->first_segment_manager);
135 segment_manager_first_segment_maybe_del (sm);
138 application_table_del (app);
139 pool_put (app_pool, app);
143 application_verify_cb_fns (session_cb_vft_t * cb_fns)
145 if (cb_fns->session_accept_callback == 0)
146 clib_warning ("No accept callback function provided");
147 if (cb_fns->session_connected_callback == 0)
148 clib_warning ("No session connected callback function provided");
149 if (cb_fns->session_disconnect_callback == 0)
150 clib_warning ("No session disconnect callback function provided");
151 if (cb_fns->session_reset_callback == 0)
152 clib_warning ("No session reset callback function provided");
156 application_init (application_t * app, u32 api_client_index, u64 * options,
157 session_cb_vft_t * cb_fns)
159 segment_manager_t *sm;
160 segment_manager_properties_t *props;
161 u32 app_evt_queue_size, first_seg_size;
164 app_evt_queue_size = options[APP_EVT_QUEUE_SIZE] > 0 ?
165 options[APP_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
167 /* Setup segment manager */
168 sm = segment_manager_new ();
169 sm->app_index = app->index;
170 props = &app->sm_properties;
171 props->add_segment_size = options[SESSION_OPTIONS_ADD_SEGMENT_SIZE];
172 props->rx_fifo_size = options[SESSION_OPTIONS_RX_FIFO_SIZE];
173 props->tx_fifo_size = options[SESSION_OPTIONS_TX_FIFO_SIZE];
174 props->add_segment = props->add_segment_size != 0;
175 props->preallocated_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
176 props->use_private_segment = options[APP_OPTIONS_FLAGS]
177 & APP_OPTIONS_FLAGS_BUILTIN_APP;
178 props->private_segment_count = options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT];
179 props->private_segment_size = options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE];
181 first_seg_size = options[SESSION_OPTIONS_SEGMENT_SIZE];
182 if ((rv = segment_manager_init (sm, props, first_seg_size)))
185 app->first_segment_manager = segment_manager_index (sm);
186 app->api_client_index = api_client_index;
187 app->flags = options[APP_OPTIONS_FLAGS];
188 app->cb_fns = *cb_fns;
190 /* Allocate app event queue in the first shared-memory segment */
191 app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
193 /* Check that the obvious things are properly set up */
194 application_verify_cb_fns (cb_fns);
196 /* Add app to lookup by api_client_index table */
197 application_table_add (app);
203 application_get (u32 index)
205 return pool_elt_at_index (app_pool, index);
209 application_get_if_valid (u32 index)
211 if (pool_is_free_index (app_pool, index))
214 return pool_elt_at_index (app_pool, index);
218 application_get_index (application_t * app)
220 return app - app_pool;
223 static segment_manager_t *
224 application_alloc_segment_manager (application_t * app)
226 segment_manager_t *sm = 0;
228 if (app->first_segment_manager != (u32) ~ 0
229 && app->first_segment_manager_in_use == 0)
231 sm = segment_manager_get (app->first_segment_manager);
232 app->first_segment_manager_in_use = 1;
236 sm = segment_manager_new ();
237 sm->properties = &app->sm_properties;
243 * Start listening local transport endpoint for requested transport.
245 * Creates a 'dummy' stream session with state LISTENING to be used in session
246 * lookups, prior to establishing connection. Requests transport to build
247 * it's own specific listening connection.
250 application_start_listen (application_t * srv, session_type_t session_type,
251 transport_endpoint_t * tep, u64 * res)
253 segment_manager_t *sm;
257 s = listen_session_new (session_type);
258 s->app_index = srv->index;
260 if (stream_session_listen (s, tep))
263 /* Allocate segment manager. All sessions derived out of a listen session
264 * have fifos allocated by the same segment manager. */
265 sm = application_alloc_segment_manager (srv);
269 /* Add to app's listener table. Useful to find all child listeners
270 * when app goes down, although, just for unbinding this is not needed */
271 handle = listen_session_get_handle (s);
272 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
278 listen_session_del (s);
283 * Stop listening on session associated to handle
286 application_stop_listen (application_t * srv, u64 handle)
288 stream_session_t *listener;
290 segment_manager_t *sm;
292 if (srv && hash_get (srv->listeners_table, handle) == 0)
294 clib_warning ("app doesn't own handle %llu!", handle);
298 listener = listen_session_get_from_handle (handle);
299 stream_session_stop_listen (listener);
301 indexp = hash_get (srv->listeners_table, handle);
304 sm = segment_manager_get (*indexp);
305 segment_manager_del (sm);
306 if (srv->first_segment_manager == *indexp)
308 srv->first_segment_manager_in_use = 0;
309 srv->first_segment_manager = ~0;
311 hash_unset (srv->listeners_table, handle);
312 listen_session_del (listener);
318 application_open_session (application_t * app, session_type_t sst,
319 transport_endpoint_t * tep, u32 api_context)
321 segment_manager_t *sm;
322 transport_connection_t *tc = 0;
325 /* Make sure we have a segment manager for connects */
326 if (app->connects_seg_manager == (u32) ~ 0)
328 sm = application_alloc_segment_manager (app);
331 app->connects_seg_manager = segment_manager_index (sm);
334 if ((rv = stream_session_open (app->index, sst, tep, &tc)))
337 /* Store api_context for when the reply comes. Not the nicest thing
338 * but better than allocating a separate half-open pool. */
339 tc->s_index = api_context;
345 application_get_connect_segment_manager (application_t * app)
347 ASSERT (app->connects_seg_manager != (u32) ~ 0);
348 return segment_manager_get (app->connects_seg_manager);
352 application_get_listen_segment_manager (application_t * app,
353 stream_session_t * s)
356 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
358 return segment_manager_get (*smp);
362 app_get_name_from_reg_index (application_t * app)
366 vl_api_registration_t *regp;
367 regp = vl_api_client_index_to_registration (app->api_client_index);
369 app_name = format (0, "builtin-%d%c", app->index, 0);
371 app_name = format (0, "%s%c", regp->name, 0);
377 application_is_proxy (application_t * app)
379 return !(app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
383 format_application_listener (u8 * s, va_list * args)
385 application_t *app = va_arg (*args, application_t *);
386 u64 handle = va_arg (*args, u64);
387 u32 index = va_arg (*args, u32);
388 int verbose = va_arg (*args, int);
389 stream_session_t *listener;
395 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
396 "API Client", "ListenerID", "SegManager");
398 s = format (s, "%-40s%-20s", "Connection", "App");
403 app_name = app_get_name_from_reg_index (app);
404 listener = listen_session_get_from_handle (handle);
405 str = format (0, "%U", format_stream_session, listener, verbose);
409 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
410 app->api_client_index, handle, index);
413 s = format (s, "%-40s%-20s", str, app_name);
420 application_format_connects (application_t * app, int verbose)
422 vlib_main_t *vm = vlib_get_main ();
423 segment_manager_t *sm;
424 u8 *app_name, *s = 0;
431 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
432 "API Client", "SegManager");
434 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
439 if (app->connects_seg_manager == (u32) ~ 0)
442 app_name = app_get_name_from_reg_index (app);
444 /* Across all fifo segments */
445 sm = segment_manager_get (app->connects_seg_manager);
446 for (j = 0; j < vec_len (sm->segment_indices); j++)
448 svm_fifo_segment_private_t *fifo_segment;
452 fifo_segment = svm_fifo_get_segment (sm->segment_indices[j]);
453 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
456 u32 session_index, thread_index;
457 stream_session_t *session;
459 session_index = fifo->master_session_index;
460 thread_index = fifo->master_thread_index;
462 session = stream_session_get (session_index, thread_index);
463 str = format (0, "%U", format_stream_session, session, verbose);
466 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
467 app->api_client_index, app->connects_seg_manager);
469 s = format (s, "%-40s%-20s", str, app_name);
471 vlib_cli_output (vm, "%v", s);
472 vec_reset_length (s);
484 format_application (u8 * s, va_list * args)
486 application_t *app = va_arg (*args, application_t *);
487 CLIB_UNUSED (int verbose) = va_arg (*args, int);
493 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s", "Index", "Name",
494 "API Client", "Add seg size", "Rx fifo size",
497 s = format (s, "%-10s%-20s%-20s", "Index", "Name", "API Client");
501 app_name = app_get_name_from_reg_index (app);
503 s = format (s, "%-10d%-20s%-15d%-15d%-15d%-15d", app->index, app_name,
504 app->api_client_index, app->sm_properties.add_segment_size,
505 app->sm_properties.rx_fifo_size,
506 app->sm_properties.tx_fifo_size);
508 s = format (s, "%-10d%-20s%-20d", app->index, app_name,
509 app->api_client_index);
513 static clib_error_t *
514 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
515 vlib_cli_command_t * cmd)
522 if (!session_manager_is_enabled ())
524 clib_error_return (0, "session layer is not enabled");
527 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
529 if (unformat (input, "server"))
531 else if (unformat (input, "client"))
533 else if (unformat (input, "verbose"))
543 if (pool_elts (app_pool))
545 vlib_cli_output (vm, "%U", format_application_listener,
546 0 /* header */ , 0, 0,
549 pool_foreach (app, app_pool,
551 /* App's listener sessions */
552 if (hash_elts (app->listeners_table) == 0)
554 hash_foreach (handle, index, app->listeners_table,
556 vlib_cli_output (vm, "%U", format_application_listener, app,
557 handle, index, verbose);
563 vlib_cli_output (vm, "No active server bindings");
568 if (pool_elts (app_pool))
570 application_format_connects (0, verbose);
573 pool_foreach (app, app_pool,
575 if (app->connects_seg_manager == (u32)~0)
577 application_format_connects (app, verbose);
582 vlib_cli_output (vm, "No active client bindings");
585 /* Print app related info */
586 if (!do_server && !do_client)
588 vlib_cli_output (vm, "%U", format_application, 0, verbose);
589 pool_foreach (app, app_pool, (
591 vlib_cli_output (vm, "%U",
592 format_application, app,
602 VLIB_CLI_COMMAND (show_app_command, static) =
605 .short_help = "show app [server|client] [verbose]",
606 .function = show_app_command_fn,
611 * fd.io coding-style-patch-verification: ON
614 * eval: (c-set-style "gnu")