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);
117 for (i = 0; i < vec_len (handles); i++)
119 a->app_index = app->index;
120 a->handle = handles[i];
121 /* seg manager is removed when unbind completes */
126 * Connects segment manager cleanup
129 if (app->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
131 sm = segment_manager_get (app->connects_seg_manager);
132 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
133 segment_manager_init_del (sm);
137 /* If first segment manager is used by a listener */
138 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
139 && app->first_segment_manager != app->connects_seg_manager)
141 sm = segment_manager_get (app->first_segment_manager);
142 /* .. and has no fifos, e.g. it might be used for redirected sessions,
144 if (!segment_manager_has_fifos (sm))
146 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
147 segment_manager_del (sm);
151 application_table_del (app);
152 pool_put (app_pool, app);
156 application_verify_cb_fns (session_cb_vft_t * cb_fns)
158 if (cb_fns->session_accept_callback == 0)
159 clib_warning ("No accept callback function provided");
160 if (cb_fns->session_connected_callback == 0)
161 clib_warning ("No session connected callback function provided");
162 if (cb_fns->session_disconnect_callback == 0)
163 clib_warning ("No session disconnect callback function provided");
164 if (cb_fns->session_reset_callback == 0)
165 clib_warning ("No session reset callback function provided");
169 application_init (application_t * app, u32 api_client_index, u64 * options,
170 session_cb_vft_t * cb_fns)
172 segment_manager_t *sm;
173 segment_manager_properties_t *props;
174 u32 app_evt_queue_size, first_seg_size;
175 u32 default_rx_fifo_size = 16 << 10, default_tx_fifo_size = 16 << 10;
178 app_evt_queue_size = options[APP_EVT_QUEUE_SIZE] > 0 ?
179 options[APP_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
181 /* Setup segment manager */
182 sm = segment_manager_new ();
183 sm->app_index = app->index;
184 props = &app->sm_properties;
185 props->add_segment_size = options[SESSION_OPTIONS_ADD_SEGMENT_SIZE];
186 props->rx_fifo_size = options[SESSION_OPTIONS_RX_FIFO_SIZE];
187 props->rx_fifo_size =
188 props->rx_fifo_size ? props->rx_fifo_size : default_rx_fifo_size;
189 props->tx_fifo_size = options[SESSION_OPTIONS_TX_FIFO_SIZE];
190 props->tx_fifo_size =
191 props->tx_fifo_size ? props->tx_fifo_size : default_tx_fifo_size;
192 props->add_segment = props->add_segment_size != 0;
193 props->preallocated_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
194 props->use_private_segment = options[APP_OPTIONS_FLAGS]
195 & APP_OPTIONS_FLAGS_BUILTIN_APP;
196 props->private_segment_count = options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT];
197 props->private_segment_size = options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE];
199 first_seg_size = options[SESSION_OPTIONS_SEGMENT_SIZE];
200 if ((rv = segment_manager_init (sm, props, first_seg_size)))
202 sm->first_is_protected = 1;
204 app->first_segment_manager = segment_manager_index (sm);
205 app->api_client_index = api_client_index;
206 app->flags = options[APP_OPTIONS_FLAGS];
207 app->cb_fns = *cb_fns;
209 /* Allocate app event queue in the first shared-memory segment */
210 app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
212 /* Check that the obvious things are properly set up */
213 application_verify_cb_fns (cb_fns);
215 /* Add app to lookup by api_client_index table */
216 application_table_add (app);
222 application_get (u32 index)
224 return pool_elt_at_index (app_pool, index);
228 application_get_if_valid (u32 index)
230 if (pool_is_free_index (app_pool, index))
233 return pool_elt_at_index (app_pool, index);
237 application_get_index (application_t * app)
239 return app - app_pool;
242 static segment_manager_t *
243 application_alloc_segment_manager (application_t * app)
245 segment_manager_t *sm = 0;
247 /* If the first segment manager is not in use, don't allocate a new one */
248 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
249 && app->first_segment_manager_in_use == 0)
251 sm = segment_manager_get (app->first_segment_manager);
252 app->first_segment_manager_in_use = 1;
256 sm = segment_manager_new ();
257 sm->properties = &app->sm_properties;
263 * Start listening local transport endpoint for requested transport.
265 * Creates a 'dummy' stream session with state LISTENING to be used in session
266 * lookups, prior to establishing connection. Requests transport to build
267 * it's own specific listening connection.
270 application_start_listen (application_t * srv, session_type_t session_type,
271 transport_endpoint_t * tep, u64 * res)
273 segment_manager_t *sm;
277 s = listen_session_new (session_type);
278 s->app_index = srv->index;
280 if (stream_session_listen (s, tep))
283 /* Allocate segment manager. All sessions derived out of a listen session
284 * have fifos allocated by the same segment manager. */
285 sm = application_alloc_segment_manager (srv);
289 /* Add to app's listener table. Useful to find all child listeners
290 * when app goes down, although, just for unbinding this is not needed */
291 handle = listen_session_get_handle (s);
292 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
298 listen_session_del (s);
303 * Stop listening on session associated to handle
306 application_stop_listen (application_t * srv, u64 handle)
308 stream_session_t *listener;
310 segment_manager_t *sm;
312 if (srv && hash_get (srv->listeners_table, handle) == 0)
314 clib_warning ("app doesn't own handle %llu!", handle);
318 listener = listen_session_get_from_handle (handle);
319 stream_session_stop_listen (listener);
321 indexp = hash_get (srv->listeners_table, handle);
324 sm = segment_manager_get (*indexp);
325 if (srv->first_segment_manager == *indexp)
327 /* Delete sessions but don't remove segment manager */
328 srv->first_segment_manager_in_use = 0;
329 segment_manager_del_sessions (sm);
333 segment_manager_init_del (sm);
335 hash_unset (srv->listeners_table, handle);
336 listen_session_del (listener);
342 application_open_session (application_t * app, session_type_t sst,
343 transport_endpoint_t * tep, u32 api_context)
345 segment_manager_t *sm;
346 transport_connection_t *tc = 0;
349 /* Make sure we have a segment manager for connects */
350 if (app->connects_seg_manager == (u32) ~ 0)
352 sm = application_alloc_segment_manager (app);
355 app->connects_seg_manager = segment_manager_index (sm);
358 if ((rv = stream_session_open (app->index, sst, tep, &tc)))
361 /* Store api_context for when the reply comes. Not the nicest thing
362 * but better than allocating a separate half-open pool. */
363 tc->s_index = api_context;
369 application_get_connect_segment_manager (application_t * app)
371 ASSERT (app->connects_seg_manager != (u32) ~ 0);
372 return segment_manager_get (app->connects_seg_manager);
376 application_get_listen_segment_manager (application_t * app,
377 stream_session_t * s)
380 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
382 return segment_manager_get (*smp);
386 app_get_name_from_reg_index (application_t * app)
390 vl_api_registration_t *regp;
391 regp = vl_api_client_index_to_registration (app->api_client_index);
393 app_name = format (0, "builtin-%d%c", app->index, 0);
395 app_name = format (0, "%s%c", regp->name, 0);
401 application_is_proxy (application_t * app)
403 return !(app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
407 application_add_segment_notify (u32 app_index, u32 fifo_segment_index)
409 application_t *app = application_get (app_index);
413 /* Send an API message to the external app, to map new segment */
414 ASSERT (app->cb_fns.add_segment_callback);
416 segment_manager_get_segment_info (fifo_segment_index, &seg_name, &seg_size);
417 return app->cb_fns.add_segment_callback (app->api_client_index, seg_name,
422 format_application_listener (u8 * s, va_list * args)
424 application_t *app = va_arg (*args, application_t *);
425 u64 handle = va_arg (*args, u64);
426 u32 index = va_arg (*args, u32);
427 int verbose = va_arg (*args, int);
428 stream_session_t *listener;
434 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
435 "API Client", "ListenerID", "SegManager");
437 s = format (s, "%-40s%-20s", "Connection", "App");
442 app_name = app_get_name_from_reg_index (app);
443 listener = listen_session_get_from_handle (handle);
444 str = format (0, "%U", format_stream_session, listener, verbose);
448 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
449 app->api_client_index, handle, index);
452 s = format (s, "%-40s%-20s", str, app_name);
459 application_format_connects (application_t * app, int verbose)
461 vlib_main_t *vm = vlib_get_main ();
462 segment_manager_t *sm;
463 u8 *app_name, *s = 0;
470 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
471 "API Client", "SegManager");
473 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
478 if (app->connects_seg_manager == (u32) ~ 0)
481 app_name = app_get_name_from_reg_index (app);
483 /* Across all fifo segments */
484 sm = segment_manager_get (app->connects_seg_manager);
485 for (j = 0; j < vec_len (sm->segment_indices); j++)
487 svm_fifo_segment_private_t *fifo_segment;
491 fifo_segment = svm_fifo_segment_get_segment (sm->segment_indices[j]);
492 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
495 u32 session_index, thread_index;
496 stream_session_t *session;
498 session_index = fifo->master_session_index;
499 thread_index = fifo->master_thread_index;
501 session = stream_session_get (session_index, thread_index);
502 str = format (0, "%U", format_stream_session, session, verbose);
505 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
506 app->api_client_index, app->connects_seg_manager);
508 s = format (s, "%-40s%-20s", str, app_name);
510 vlib_cli_output (vm, "%v", s);
511 vec_reset_length (s);
523 format_application (u8 * s, va_list * args)
525 application_t *app = va_arg (*args, application_t *);
526 CLIB_UNUSED (int verbose) = va_arg (*args, int);
532 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s", "Index", "Name",
533 "API Client", "Add seg size", "Rx fifo size",
536 s = format (s, "%-10s%-20s%-20s", "Index", "Name", "API Client");
540 app_name = app_get_name_from_reg_index (app);
542 s = format (s, "%-10d%-20s%-15d%-15d%-15d%-15d", app->index, app_name,
543 app->api_client_index, app->sm_properties.add_segment_size,
544 app->sm_properties.rx_fifo_size,
545 app->sm_properties.tx_fifo_size);
547 s = format (s, "%-10d%-20s%-20d", app->index, app_name,
548 app->api_client_index);
552 static clib_error_t *
553 show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
554 vlib_cli_command_t * cmd)
561 if (!session_manager_is_enabled ())
563 clib_error_return (0, "session layer is not enabled");
566 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
568 if (unformat (input, "server"))
570 else if (unformat (input, "client"))
572 else if (unformat (input, "verbose"))
582 if (pool_elts (app_pool))
584 vlib_cli_output (vm, "%U", format_application_listener,
585 0 /* header */ , 0, 0,
588 pool_foreach (app, app_pool,
590 /* App's listener sessions */
591 if (hash_elts (app->listeners_table) == 0)
593 hash_foreach (handle, index, app->listeners_table,
595 vlib_cli_output (vm, "%U", format_application_listener, app,
596 handle, index, verbose);
602 vlib_cli_output (vm, "No active server bindings");
607 if (pool_elts (app_pool))
609 application_format_connects (0, verbose);
612 pool_foreach (app, app_pool,
614 if (app->connects_seg_manager == (u32)~0)
616 application_format_connects (app, verbose);
621 vlib_cli_output (vm, "No active client bindings");
624 /* Print app related info */
625 if (!do_server && !do_client)
627 vlib_cli_output (vm, "%U", format_application, 0, verbose);
628 pool_foreach (app, app_pool, (
630 vlib_cli_output (vm, "%U",
631 format_application, app,
641 VLIB_CLI_COMMAND (show_app_command, static) =
644 .short_help = "show app [server|client] [verbose]",
645 .function = show_app_command_fn,
650 * fd.io coding-style-patch-verification: ON
653 * eval: (c-set-style "gnu")