blob: 8090e75a6dc33dc09e6ebbe5e262cbf31e0e08bd [file] [log] [blame]
Dave Barach68b0fb02017-02-28 15:15:56 -05001/*
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:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
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.
14 */
15
16#include <vnet/session/application.h>
Florin Coras6cf30ad2017-04-04 23:08:23 -070017#include <vnet/session/application_interface.h>
Florin Corascea194d2017-10-02 00:18:51 -070018#include <vnet/session/application_namespace.h>
Dave Barach68b0fb02017-02-28 15:15:56 -050019#include <vnet/session/session.h>
20
Florin Coras6cf30ad2017-04-04 23:08:23 -070021/**
Dave Barach68b0fb02017-02-28 15:15:56 -050022 * Pool from which we allocate all applications
23 */
24static application_t *app_pool;
25
Florin Coras6cf30ad2017-04-04 23:08:23 -070026/**
Dave Barach68b0fb02017-02-28 15:15:56 -050027 * Hash table of apps by api client index
28 */
29static uword *app_by_api_client_index;
30
Florin Coras6cf30ad2017-04-04 23:08:23 -070031/**
32 * Default application event queue size
33 */
34static u32 default_app_evt_queue_size = 128;
35
Florin Corascea194d2017-10-02 00:18:51 -070036static u8 *
37app_get_name_from_reg_index (application_t * app)
38{
39 u8 *app_name;
40
41 vl_api_registration_t *regp;
42 regp = vl_api_client_index_to_registration (app->api_client_index);
43 if (!regp)
44 app_name = format (0, "builtin-%d%c", app->index, 0);
45 else
46 app_name = format (0, "%s%c", regp->name, 0);
47
48 return app_name;
49}
50
51u32
52application_session_table (application_t * app, u8 fib_proto)
53{
54 app_namespace_t *app_ns;
55 app_ns = app_namespace_get (app->ns_index);
56 if (!application_has_global_scope (app))
57 return APP_INVALID_INDEX;
58 if (fib_proto == FIB_PROTOCOL_IP4)
59 return session_lookup_get_index_for_fib (fib_proto,
60 app_ns->ip4_fib_index);
61 else
62 return session_lookup_get_index_for_fib (fib_proto,
63 app_ns->ip6_fib_index);
64}
65
66u32
67application_local_session_table (application_t * app)
68{
69 app_namespace_t *app_ns;
70 if (!application_has_local_scope (app))
71 return APP_INVALID_INDEX;
72 app_ns = app_namespace_get (app->ns_index);
73 return app_ns->local_table_index;
74}
75
Dave Barach68b0fb02017-02-28 15:15:56 -050076int
77application_api_queue_is_full (application_t * app)
78{
Florin Corase86a8ed2018-01-05 03:20:25 -080079 svm_queue_t *q;
Dave Barach68b0fb02017-02-28 15:15:56 -050080
81 /* builtin servers are always OK */
82 if (app->api_client_index == ~0)
83 return 0;
84
85 q = vl_api_client_index_to_input_queue (app->api_client_index);
86 if (!q)
87 return 1;
88
89 if (q->cursize == q->maxsize)
90 return 1;
91 return 0;
92}
93
Florin Corascea194d2017-10-02 00:18:51 -070094/**
95 * Returns app name
96 *
97 * Since the name is not stored per app, we generate it on the fly. It is
98 * the caller's responsibility to free the vector
99 */
100u8 *
101application_name_from_index (u32 app_index)
102{
103 application_t *app = application_get (app_index);
104 if (!app)
105 return 0;
106 return app_get_name_from_reg_index (app);
107}
108
Dave Barach68b0fb02017-02-28 15:15:56 -0500109static void
110application_table_add (application_t * app)
111{
112 hash_set (app_by_api_client_index, app->api_client_index, app->index);
113}
114
115static void
116application_table_del (application_t * app)
117{
118 hash_unset (app_by_api_client_index, app->api_client_index);
119}
120
121application_t *
122application_lookup (u32 api_client_index)
123{
124 uword *p;
125 p = hash_get (app_by_api_client_index, api_client_index);
126 if (p)
127 return application_get (p[0]);
128
129 return 0;
130}
131
Florin Coras6cf30ad2017-04-04 23:08:23 -0700132application_t *
133application_new ()
134{
135 application_t *app;
136 pool_get (app_pool, app);
137 memset (app, 0, sizeof (*app));
138 app->index = application_get_index (app);
Florin Corasc87c91d2017-08-16 19:55:49 -0700139 app->connects_seg_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
140 app->first_segment_manager = APP_INVALID_SEGMENT_MANAGER_INDEX;
Dave Wallace7b749fe2017-07-05 14:30:46 -0400141 if (CLIB_DEBUG > 1)
142 clib_warning ("[%d] New app (%d)", getpid (), app->index);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700143 return app;
144}
145
Dave Barach68b0fb02017-02-28 15:15:56 -0500146void
147application_del (application_t * app)
148{
Florin Corasad0c77f2017-11-09 18:00:15 -0800149 segment_manager_properties_t *props;
150 vnet_unbind_args_t _a, *a = &_a;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700151 segment_manager_t *sm;
Florin Coras7999e832017-10-31 01:51:04 -0700152 u64 handle, *handles = 0;
153 u32 index;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700154 int i;
Dave Barach68b0fb02017-02-28 15:15:56 -0500155
Florin Coras6cf30ad2017-04-04 23:08:23 -0700156 /*
Florin Corasa5464812017-04-19 13:00:05 -0700157 * The app event queue allocated in first segment is cleared with
158 * the segment manager. No need to explicitly free it.
159 */
Dave Wallace7b749fe2017-07-05 14:30:46 -0400160 if (CLIB_DEBUG > 1)
161 clib_warning ("[%d] Delete app (%d)", getpid (), app->index);
Florin Corasa5464812017-04-19 13:00:05 -0700162
Florin Coras7999e832017-10-31 01:51:04 -0700163 if (application_is_proxy (app))
164 application_remove_proxy (app);
165
Florin Corasa5464812017-04-19 13:00:05 -0700166 /*
Florin Corasc87c91d2017-08-16 19:55:49 -0700167 * Listener cleanup
Florin Coras6cf30ad2017-04-04 23:08:23 -0700168 */
Dave Barach68b0fb02017-02-28 15:15:56 -0500169
Florin Coras6cf30ad2017-04-04 23:08:23 -0700170 /* *INDENT-OFF* */
171 hash_foreach (handle, index, app->listeners_table,
172 ({
173 vec_add1 (handles, handle);
Florin Coras9d063042017-09-14 03:08:00 -0400174 sm = segment_manager_get (index);
175 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700176 }));
177 /* *INDENT-ON* */
178
Florin Coras6cf30ad2017-04-04 23:08:23 -0700179 for (i = 0; i < vec_len (handles); i++)
180 {
Florin Corasf03a59a2017-06-09 21:07:32 -0700181 a->app_index = app->index;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700182 a->handle = handles[i];
183 /* seg manager is removed when unbind completes */
184 vnet_unbind (a);
185 }
186
Florin Corasc87c91d2017-08-16 19:55:49 -0700187 /*
188 * Connects segment manager cleanup
189 */
190
191 if (app->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
192 {
193 sm = segment_manager_get (app->connects_seg_manager);
194 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
195 segment_manager_init_del (sm);
196 }
197
Florin Corasc87c91d2017-08-16 19:55:49 -0700198 /* If first segment manager is used by a listener */
199 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
200 && app->first_segment_manager != app->connects_seg_manager)
Dave Wallace7b749fe2017-07-05 14:30:46 -0400201 {
202 sm = segment_manager_get (app->first_segment_manager);
Florin Corasc87c91d2017-08-16 19:55:49 -0700203 /* .. and has no fifos, e.g. it might be used for redirected sessions,
204 * remove it */
205 if (!segment_manager_has_fifos (sm))
206 {
207 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
208 segment_manager_del (sm);
209 }
Dave Wallace7b749fe2017-07-05 14:30:46 -0400210 }
Florin Corasad0c77f2017-11-09 18:00:15 -0800211 props = segment_manager_properties_get (app->sm_properties);
212 segment_manager_properties_free (props);
Dave Barach68b0fb02017-02-28 15:15:56 -0500213 application_table_del (app);
Dave Barach68b0fb02017-02-28 15:15:56 -0500214 pool_put (app_pool, app);
215}
216
Florin Corasd79b41e2017-03-04 05:37:52 -0800217static void
Florin Coras6cf30ad2017-04-04 23:08:23 -0700218application_verify_cb_fns (session_cb_vft_t * cb_fns)
Florin Corasd79b41e2017-03-04 05:37:52 -0800219{
Florin Coras6cf30ad2017-04-04 23:08:23 -0700220 if (cb_fns->session_accept_callback == 0)
Florin Corasd79b41e2017-03-04 05:37:52 -0800221 clib_warning ("No accept callback function provided");
Florin Coras6cf30ad2017-04-04 23:08:23 -0700222 if (cb_fns->session_connected_callback == 0)
Florin Corasd79b41e2017-03-04 05:37:52 -0800223 clib_warning ("No session connected callback function provided");
224 if (cb_fns->session_disconnect_callback == 0)
225 clib_warning ("No session disconnect callback function provided");
226 if (cb_fns->session_reset_callback == 0)
227 clib_warning ("No session reset callback function provided");
228}
229
Florin Coras6cf30ad2017-04-04 23:08:23 -0700230int
231application_init (application_t * app, u32 api_client_index, u64 * options,
232 session_cb_vft_t * cb_fns)
Dave Barach68b0fb02017-02-28 15:15:56 -0500233{
Florin Coras6cf30ad2017-04-04 23:08:23 -0700234 segment_manager_t *sm;
235 segment_manager_properties_t *props;
Florin Corasa5464812017-04-19 13:00:05 -0700236 u32 app_evt_queue_size, first_seg_size;
Florin Corasc87c91d2017-08-16 19:55:49 -0700237 u32 default_rx_fifo_size = 16 << 10, default_tx_fifo_size = 16 << 10;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700238 int rv;
Dave Barach68b0fb02017-02-28 15:15:56 -0500239
Florin Corasff6e7692017-12-11 04:59:01 -0800240 app_evt_queue_size = options[APP_OPTIONS_EVT_QUEUE_SIZE] > 0 ?
241 options[APP_OPTIONS_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
Dave Barach68b0fb02017-02-28 15:15:56 -0500242
Florin Corascea194d2017-10-02 00:18:51 -0700243 /*
244 * Setup segment manager
245 */
Florin Coras6cf30ad2017-04-04 23:08:23 -0700246 sm = segment_manager_new ();
247 sm->app_index = app->index;
Florin Corasad0c77f2017-11-09 18:00:15 -0800248 props = segment_manager_properties_alloc ();
249 app->sm_properties = segment_manager_properties_index (props);
Florin Corasff6e7692017-12-11 04:59:01 -0800250 props->add_segment_size = options[APP_OPTIONS_ADD_SEGMENT_SIZE];
251 props->rx_fifo_size = options[APP_OPTIONS_RX_FIFO_SIZE];
Florin Corasc87c91d2017-08-16 19:55:49 -0700252 props->rx_fifo_size =
253 props->rx_fifo_size ? props->rx_fifo_size : default_rx_fifo_size;
Florin Corasff6e7692017-12-11 04:59:01 -0800254 props->tx_fifo_size = options[APP_OPTIONS_TX_FIFO_SIZE];
Florin Corasc87c91d2017-08-16 19:55:49 -0700255 props->tx_fifo_size =
256 props->tx_fifo_size ? props->tx_fifo_size : default_tx_fifo_size;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700257 props->add_segment = props->add_segment_size != 0;
Dave Barach10d8cc62017-05-30 09:30:07 -0400258 props->preallocated_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
Florin Corasa5464812017-04-19 13:00:05 -0700259 props->use_private_segment = options[APP_OPTIONS_FLAGS]
Florin Coras7999e832017-10-31 01:51:04 -0700260 & APP_OPTIONS_FLAGS_IS_BUILTIN;
Dave Barach2c25a622017-06-26 11:35:07 -0400261 props->private_segment_count = options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT];
Dave Barach68b0fb02017-02-28 15:15:56 -0500262
Florin Corasff6e7692017-12-11 04:59:01 -0800263 first_seg_size = options[APP_OPTIONS_SEGMENT_SIZE];
Florin Corasad0c77f2017-11-09 18:00:15 -0800264 if ((rv = segment_manager_init (sm, app->sm_properties, first_seg_size)))
Florin Coras6cf30ad2017-04-04 23:08:23 -0700265 return rv;
Florin Corasc87c91d2017-08-16 19:55:49 -0700266 sm->first_is_protected = 1;
Dave Barach68b0fb02017-02-28 15:15:56 -0500267
Florin Corascea194d2017-10-02 00:18:51 -0700268 /*
269 * Setup application
270 */
Florin Coras6cf30ad2017-04-04 23:08:23 -0700271 app->first_segment_manager = segment_manager_index (sm);
Dave Barach68b0fb02017-02-28 15:15:56 -0500272 app->api_client_index = api_client_index;
Florin Corasa5464812017-04-19 13:00:05 -0700273 app->flags = options[APP_OPTIONS_FLAGS];
Dave Barach68b0fb02017-02-28 15:15:56 -0500274 app->cb_fns = *cb_fns;
Florin Corascea194d2017-10-02 00:18:51 -0700275 app->ns_index = options[APP_OPTIONS_NAMESPACE];
Florin Coras7999e832017-10-31 01:51:04 -0700276 app->listeners_table = hash_create (0, sizeof (u64));
277 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
Florin Corascea194d2017-10-02 00:18:51 -0700278
279 /* If no scope enabled, default to global */
280 if (!application_has_global_scope (app)
281 && !application_has_local_scope (app))
282 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
Dave Barach68b0fb02017-02-28 15:15:56 -0500283
Florin Corasa5464812017-04-19 13:00:05 -0700284 /* Allocate app event queue in the first shared-memory segment */
285 app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
286
Florin Corasd79b41e2017-03-04 05:37:52 -0800287 /* Check that the obvious things are properly set up */
Florin Coras6cf30ad2017-04-04 23:08:23 -0700288 application_verify_cb_fns (cb_fns);
Florin Corasd79b41e2017-03-04 05:37:52 -0800289
Dave Barach68b0fb02017-02-28 15:15:56 -0500290 /* Add app to lookup by api_client_index table */
291 application_table_add (app);
292
Florin Coras6cf30ad2017-04-04 23:08:23 -0700293 return 0;
Dave Barach68b0fb02017-02-28 15:15:56 -0500294}
295
296application_t *
297application_get (u32 index)
298{
Florin Corascea194d2017-10-02 00:18:51 -0700299 if (index == APP_INVALID_INDEX)
300 return 0;
Dave Barach68b0fb02017-02-28 15:15:56 -0500301 return pool_elt_at_index (app_pool, index);
302}
303
Florin Corase04c2992017-03-01 08:17:34 -0800304application_t *
305application_get_if_valid (u32 index)
306{
307 if (pool_is_free_index (app_pool, index))
308 return 0;
309
310 return pool_elt_at_index (app_pool, index);
311}
312
Dave Barach68b0fb02017-02-28 15:15:56 -0500313u32
314application_get_index (application_t * app)
315{
316 return app - app_pool;
317}
318
Florin Coras6cf30ad2017-04-04 23:08:23 -0700319static segment_manager_t *
320application_alloc_segment_manager (application_t * app)
Dave Barach68b0fb02017-02-28 15:15:56 -0500321{
Florin Coras6cf30ad2017-04-04 23:08:23 -0700322 segment_manager_t *sm = 0;
Dave Barach68b0fb02017-02-28 15:15:56 -0500323
Florin Corasc87c91d2017-08-16 19:55:49 -0700324 /* If the first segment manager is not in use, don't allocate a new one */
325 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
Florin Coras0e9c33b2017-08-14 22:33:41 -0700326 && app->first_segment_manager_in_use == 0)
Dave Barach68b0fb02017-02-28 15:15:56 -0500327 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700328 sm = segment_manager_get (app->first_segment_manager);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700329 app->first_segment_manager_in_use = 1;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700330 return sm;
Dave Barach68b0fb02017-02-28 15:15:56 -0500331 }
332
Florin Coras6cf30ad2017-04-04 23:08:23 -0700333 sm = segment_manager_new ();
Florin Corasad0c77f2017-11-09 18:00:15 -0800334 sm->properties_index = app->sm_properties;
Florin Coras0e9c33b2017-08-14 22:33:41 -0700335
Florin Coras6cf30ad2017-04-04 23:08:23 -0700336 return sm;
337}
338
339/**
340 * Start listening local transport endpoint for requested transport.
341 *
342 * Creates a 'dummy' stream session with state LISTENING to be used in session
343 * lookups, prior to establishing connection. Requests transport to build
344 * it's own specific listening connection.
345 */
346int
Florin Corascea194d2017-10-02 00:18:51 -0700347application_start_listen (application_t * srv, session_endpoint_t * sep,
348 u64 * res)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700349{
350 segment_manager_t *sm;
351 stream_session_t *s;
352 u64 handle;
Florin Corascea194d2017-10-02 00:18:51 -0700353 session_type_t sst;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700354
Florin Corascea194d2017-10-02 00:18:51 -0700355 sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
356 s = listen_session_new (sst);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700357 s->app_index = srv->index;
358
Florin Corascea194d2017-10-02 00:18:51 -0700359 if (stream_session_listen (s, sep))
Florin Coras6cf30ad2017-04-04 23:08:23 -0700360 goto err;
361
362 /* Allocate segment manager. All sessions derived out of a listen session
363 * have fifos allocated by the same segment manager. */
364 sm = application_alloc_segment_manager (srv);
365 if (sm == 0)
366 goto err;
367
368 /* Add to app's listener table. Useful to find all child listeners
369 * when app goes down, although, just for unbinding this is not needed */
370 handle = listen_session_get_handle (s);
371 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
372
373 *res = handle;
374 return 0;
375
376err:
377 listen_session_del (s);
378 return -1;
379}
380
381/**
382 * Stop listening on session associated to handle
383 */
384int
385application_stop_listen (application_t * srv, u64 handle)
386{
387 stream_session_t *listener;
388 uword *indexp;
389 segment_manager_t *sm;
390
391 if (srv && hash_get (srv->listeners_table, handle) == 0)
392 {
393 clib_warning ("app doesn't own handle %llu!", handle);
394 return -1;
395 }
396
397 listener = listen_session_get_from_handle (handle);
398 stream_session_stop_listen (listener);
399
400 indexp = hash_get (srv->listeners_table, handle);
401 ASSERT (indexp);
402
403 sm = segment_manager_get (*indexp);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700404 if (srv->first_segment_manager == *indexp)
405 {
Florin Corasc87c91d2017-08-16 19:55:49 -0700406 /* Delete sessions but don't remove segment manager */
Florin Coras0e9c33b2017-08-14 22:33:41 -0700407 srv->first_segment_manager_in_use = 0;
Florin Corasc87c91d2017-08-16 19:55:49 -0700408 segment_manager_del_sessions (sm);
409 }
410 else
411 {
412 segment_manager_init_del (sm);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700413 }
Florin Coras6cf30ad2017-04-04 23:08:23 -0700414 hash_unset (srv->listeners_table, handle);
415 listen_session_del (listener);
416
Dave Barach68b0fb02017-02-28 15:15:56 -0500417 return 0;
418}
419
Florin Coras6cf30ad2017-04-04 23:08:23 -0700420int
Florin Corascea194d2017-10-02 00:18:51 -0700421application_open_session (application_t * app, session_endpoint_t * sep,
422 u32 api_context)
Dave Barach68b0fb02017-02-28 15:15:56 -0500423{
Florin Coras6cf30ad2017-04-04 23:08:23 -0700424 segment_manager_t *sm;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700425 int rv;
426
427 /* Make sure we have a segment manager for connects */
Florin Corascea194d2017-10-02 00:18:51 -0700428 if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700429 {
430 sm = application_alloc_segment_manager (app);
431 if (sm == 0)
432 return -1;
433 app->connects_seg_manager = segment_manager_index (sm);
434 }
435
Florin Coras3cbc04b2017-10-02 00:18:51 -0700436 if ((rv = session_open (app->index, sep, api_context)))
Florin Coras6cf30ad2017-04-04 23:08:23 -0700437 return rv;
438
Florin Coras6cf30ad2017-04-04 23:08:23 -0700439 return 0;
440}
441
442segment_manager_t *
443application_get_connect_segment_manager (application_t * app)
444{
445 ASSERT (app->connects_seg_manager != (u32) ~ 0);
446 return segment_manager_get (app->connects_seg_manager);
447}
448
449segment_manager_t *
450application_get_listen_segment_manager (application_t * app,
451 stream_session_t * s)
452{
453 uword *smp;
454 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
455 ASSERT (smp != 0);
456 return segment_manager_get (*smp);
457}
458
Dave Barach52851e62017-08-07 09:35:25 -0400459int
460application_is_proxy (application_t * app)
461{
Florin Coras7999e832017-10-31 01:51:04 -0700462 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
463}
464
465int
466application_is_builtin (application_t * app)
467{
468 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
469}
470
471int
472application_is_builtin_proxy (application_t * app)
473{
474 return (application_is_proxy (app) && application_is_builtin (app));
Dave Barach52851e62017-08-07 09:35:25 -0400475}
476
Florin Corasc87c91d2017-08-16 19:55:49 -0700477int
478application_add_segment_notify (u32 app_index, u32 fifo_segment_index)
479{
480 application_t *app = application_get (app_index);
481 u32 seg_size = 0;
482 u8 *seg_name;
483
484 /* Send an API message to the external app, to map new segment */
485 ASSERT (app->cb_fns.add_segment_callback);
486
487 segment_manager_get_segment_info (fifo_segment_index, &seg_name, &seg_size);
488 return app->cb_fns.add_segment_callback (app->api_client_index, seg_name,
489 seg_size);
490}
491
Florin Corascea194d2017-10-02 00:18:51 -0700492u8
493application_has_local_scope (application_t * app)
494{
495 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
496}
497
498u8
499application_has_global_scope (application_t * app)
500{
501 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
502}
503
Florin Coras1c710452017-10-17 00:03:13 -0700504u32
505application_n_listeners (application_t * app)
506{
507 return hash_elts (app->listeners_table);
508}
509
510stream_session_t *
Florin Coras7999e832017-10-31 01:51:04 -0700511application_first_listener (application_t * app, u8 fib_proto,
512 u8 transport_proto)
Florin Coras1c710452017-10-17 00:03:13 -0700513{
Florin Coras7999e832017-10-31 01:51:04 -0700514 stream_session_t *listener;
Florin Coras1c710452017-10-17 00:03:13 -0700515 u64 handle;
516 u32 sm_index;
Florin Coras7999e832017-10-31 01:51:04 -0700517 u8 sst;
518
519 sst = session_type_from_proto_and_ip (transport_proto,
520 fib_proto == FIB_PROTOCOL_IP4);
Florin Coras1c710452017-10-17 00:03:13 -0700521
522 /* *INDENT-OFF* */
523 hash_foreach (handle, sm_index, app->listeners_table, ({
Florin Coras7999e832017-10-31 01:51:04 -0700524 listener = listen_session_get_from_handle (handle);
Florin Corasc3ddea82017-11-27 03:12:00 -0800525 if (listener->session_type == sst
526 && listener->listener_index != SESSION_PROXY_LISTENER_INDEX)
Florin Coras7999e832017-10-31 01:51:04 -0700527 return listener;
Florin Coras1c710452017-10-17 00:03:13 -0700528 }));
529 /* *INDENT-ON* */
530
531 return 0;
532}
533
Florin Coras19b1f6a2017-12-11 03:37:03 -0800534stream_session_t *
535application_proxy_listener (application_t * app, u8 fib_proto,
536 u8 transport_proto)
537{
538 stream_session_t *listener;
539 u64 handle;
540 u32 sm_index;
541 u8 sst;
542
543 sst = session_type_from_proto_and_ip (transport_proto,
544 fib_proto == FIB_PROTOCOL_IP4);
545
546 /* *INDENT-OFF* */
547 hash_foreach (handle, sm_index, app->listeners_table, ({
548 listener = listen_session_get_from_handle (handle);
549 if (listener->session_type == sst
550 && listener->listener_index == SESSION_PROXY_LISTENER_INDEX)
551 return listener;
552 }));
553 /* *INDENT-ON* */
554
555 return 0;
556}
557
Florin Coras7999e832017-10-31 01:51:04 -0700558static clib_error_t *
559application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
560 u8 transport_proto, u8 is_start)
561{
Florin Coras7999e832017-10-31 01:51:04 -0700562 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
563 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
564 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
565 transport_connection_t *tc;
566 stream_session_t *s;
567 u64 handle;
568
569 if (is_start)
570 {
Florin Coras19b1f6a2017-12-11 03:37:03 -0800571 s = application_first_listener (app, fib_proto, transport_proto);
572 if (!s)
573 {
574 sep.is_ip4 = is_ip4;
575 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
576 sep.sw_if_index = app_ns->sw_if_index;
577 sep.transport_proto = transport_proto;
578 application_start_listen (app, &sep, &handle);
579 s = listen_session_get_from_handle (handle);
580 s->listener_index = SESSION_PROXY_LISTENER_INDEX;
581 }
Florin Coras7999e832017-10-31 01:51:04 -0700582 }
583 else
584 {
Florin Coras19b1f6a2017-12-11 03:37:03 -0800585 s = application_proxy_listener (app, fib_proto, transport_proto);
586 ASSERT (s);
Florin Coras7999e832017-10-31 01:51:04 -0700587 }
Florin Coras19b1f6a2017-12-11 03:37:03 -0800588
Florin Coras7999e832017-10-31 01:51:04 -0700589 tc = listen_session_get_transport (s);
590
591 if (!ip_is_zero (&tc->lcl_ip, 1))
592 {
Florin Corasdbd44562017-11-09 19:30:17 -0800593 u32 sti;
594 sep.is_ip4 = is_ip4;
595 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
596 sep.transport_proto = transport_proto;
597 sep.port = 0;
598 sti = session_lookup_get_index_for_fib (fib_proto, sep.fib_index);
Florin Coras19b1f6a2017-12-11 03:37:03 -0800599 if (is_start)
600 session_lookup_add_session_endpoint (sti, &sep, s->session_index);
601 else
602 session_lookup_del_session_endpoint (sti, &sep);
Florin Coras7999e832017-10-31 01:51:04 -0700603 }
Florin Coras19b1f6a2017-12-11 03:37:03 -0800604
Florin Coras7999e832017-10-31 01:51:04 -0700605 return 0;
606}
607
Florin Coras19b1f6a2017-12-11 03:37:03 -0800608static void
609application_start_stop_proxy_local_scope (application_t * app,
610 u8 transport_proto, u8 is_start)
611{
612 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
613 app_namespace_t *app_ns;
614 app_ns = app_namespace_get (app->ns_index);
615 sep.is_ip4 = 1;
616 sep.transport_proto = transport_proto;
617 sep.port = 0;
618
619 if (is_start)
620 {
621 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
622 app->index);
623 sep.is_ip4 = 0;
624 session_lookup_add_session_endpoint (app_ns->local_table_index, &sep,
625 app->index);
626 }
627 else
628 {
629 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
630 sep.is_ip4 = 0;
631 session_lookup_del_session_endpoint (app_ns->local_table_index, &sep);
632 }
633}
634
Florin Coras7999e832017-10-31 01:51:04 -0700635void
Florin Coras561af9b2017-12-09 10:19:43 -0800636application_start_stop_proxy (application_t * app,
637 transport_proto_t transport_proto, u8 is_start)
Florin Coras7999e832017-10-31 01:51:04 -0700638{
Florin Coras7999e832017-10-31 01:51:04 -0700639 if (application_has_local_scope (app))
Florin Coras19b1f6a2017-12-11 03:37:03 -0800640 application_start_stop_proxy_local_scope (app, transport_proto, is_start);
Florin Coras7999e832017-10-31 01:51:04 -0700641
642 if (application_has_global_scope (app))
643 {
644 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
645 transport_proto, is_start);
646 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
647 transport_proto, is_start);
648 }
649}
650
651void
652application_setup_proxy (application_t * app)
653{
654 u16 transports = app->proxied_transports;
Florin Coras561af9b2017-12-09 10:19:43 -0800655 transport_proto_t tp;
656
Florin Coras7999e832017-10-31 01:51:04 -0700657 ASSERT (application_is_proxy (app));
658 if (application_is_builtin (app))
659 return;
Florin Coras561af9b2017-12-09 10:19:43 -0800660
661 /* *INDENT-OFF* */
662 transport_proto_foreach (tp, ({
663 if (transports & (1 << tp))
664 application_start_stop_proxy (app, tp, 1);
665 }));
666 /* *INDENT-ON* */
Florin Coras7999e832017-10-31 01:51:04 -0700667}
668
669void
670application_remove_proxy (application_t * app)
671{
672 u16 transports = app->proxied_transports;
Florin Coras561af9b2017-12-09 10:19:43 -0800673 transport_proto_t tp;
674
Florin Coras7999e832017-10-31 01:51:04 -0700675 ASSERT (application_is_proxy (app));
Florin Coras561af9b2017-12-09 10:19:43 -0800676
677 /* *INDENT-OFF* */
678 transport_proto_foreach (tp, ({
679 if (transports & (1 << tp))
680 application_start_stop_proxy (app, tp, 0);
681 }));
682 /* *INDENT-ON* */
Florin Coras7999e832017-10-31 01:51:04 -0700683}
684
Dave Barach68b0fb02017-02-28 15:15:56 -0500685u8 *
Florin Coras6cf30ad2017-04-04 23:08:23 -0700686format_application_listener (u8 * s, va_list * args)
Dave Barach68b0fb02017-02-28 15:15:56 -0500687{
Florin Coras6cf30ad2017-04-04 23:08:23 -0700688 application_t *app = va_arg (*args, application_t *);
689 u64 handle = va_arg (*args, u64);
690 u32 index = va_arg (*args, u32);
Dave Barach68b0fb02017-02-28 15:15:56 -0500691 int verbose = va_arg (*args, int);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700692 stream_session_t *listener;
693 u8 *app_name, *str;
Dave Barach68b0fb02017-02-28 15:15:56 -0500694
Florin Coras6cf30ad2017-04-04 23:08:23 -0700695 if (app == 0)
Dave Barach68b0fb02017-02-28 15:15:56 -0500696 {
697 if (verbose)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700698 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
699 "API Client", "ListenerID", "SegManager");
Dave Barach68b0fb02017-02-28 15:15:56 -0500700 else
Florin Coras6cf30ad2017-04-04 23:08:23 -0700701 s = format (s, "%-40s%-20s", "Connection", "App");
Dave Barach68b0fb02017-02-28 15:15:56 -0500702
703 return s;
704 }
705
Florin Coras6cf30ad2017-04-04 23:08:23 -0700706 app_name = app_get_name_from_reg_index (app);
707 listener = listen_session_get_from_handle (handle);
708 str = format (0, "%U", format_stream_session, listener, verbose);
Dave Barach68b0fb02017-02-28 15:15:56 -0500709
Dave Barach68b0fb02017-02-28 15:15:56 -0500710 if (verbose)
711 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700712 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
713 app->api_client_index, handle, index);
Dave Barach68b0fb02017-02-28 15:15:56 -0500714 }
715 else
Florin Coras6cf30ad2017-04-04 23:08:23 -0700716 s = format (s, "%-40s%-20s", str, app_name);
717
718 vec_free (app_name);
719 return s;
720}
721
722void
723application_format_connects (application_t * app, int verbose)
724{
725 vlib_main_t *vm = vlib_get_main ();
726 segment_manager_t *sm;
727 u8 *app_name, *s = 0;
Dave Barach10d8cc62017-05-30 09:30:07 -0400728 int j;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700729
730 /* Header */
731 if (app == 0)
732 {
733 if (verbose)
734 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
735 "API Client", "SegManager");
736 else
737 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
738 return;
739 }
740
741 /* make sure */
742 if (app->connects_seg_manager == (u32) ~ 0)
743 return;
744
745 app_name = app_get_name_from_reg_index (app);
746
747 /* Across all fifo segments */
748 sm = segment_manager_get (app->connects_seg_manager);
749 for (j = 0; j < vec_len (sm->segment_indices); j++)
750 {
751 svm_fifo_segment_private_t *fifo_segment;
Dave Barach10d8cc62017-05-30 09:30:07 -0400752 svm_fifo_t *fifo;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700753 u8 *str;
754
Florin Corasc87c91d2017-08-16 19:55:49 -0700755 fifo_segment = svm_fifo_segment_get_segment (sm->segment_indices[j]);
Dave Barach10d8cc62017-05-30 09:30:07 -0400756 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
757 while (fifo)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700758 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700759 u32 session_index, thread_index;
760 stream_session_t *session;
761
Florin Corasa5464812017-04-19 13:00:05 -0700762 session_index = fifo->master_session_index;
763 thread_index = fifo->master_thread_index;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700764
Florin Corascea194d2017-10-02 00:18:51 -0700765 session = session_get (session_index, thread_index);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700766 str = format (0, "%U", format_stream_session, session, verbose);
767
768 if (verbose)
769 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
770 app->api_client_index, app->connects_seg_manager);
771 else
772 s = format (s, "%-40s%-20s", str, app_name);
773
774 vlib_cli_output (vm, "%v", s);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700775 vec_reset_length (s);
776 vec_free (str);
Dave Barach10d8cc62017-05-30 09:30:07 -0400777
778 fifo = fifo->next;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700779 }
780 vec_free (s);
781 }
782
783 vec_free (app_name);
784}
785
786u8 *
787format_application (u8 * s, va_list * args)
788{
789 application_t *app = va_arg (*args, application_t *);
790 CLIB_UNUSED (int verbose) = va_arg (*args, int);
Florin Corasad0c77f2017-11-09 18:00:15 -0800791 segment_manager_properties_t *props;
Florin Corascea194d2017-10-02 00:18:51 -0700792 const u8 *app_ns_name;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700793 u8 *app_name;
794
795 if (app == 0)
796 {
797 if (verbose)
Florin Corascea194d2017-10-02 00:18:51 -0700798 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
Florin Coras8f107b32017-11-21 22:13:03 -0800799 "API Client", "Namespace", "Add seg size", "Rx fifo size",
Florin Coras6cf30ad2017-04-04 23:08:23 -0700800 "Tx fifo size");
801 else
Florin Corascea194d2017-10-02 00:18:51 -0700802 s =
Florin Coras8f107b32017-11-21 22:13:03 -0800803 format (s, "%-10s%-20s%-15s%-40s", "Index", "Name", "API Client",
804 "Namespace");
Florin Coras6cf30ad2017-04-04 23:08:23 -0700805 return s;
806 }
807
808 app_name = app_get_name_from_reg_index (app);
Florin Corascea194d2017-10-02 00:18:51 -0700809 app_ns_name = app_namespace_id_from_index (app->ns_index);
Florin Corasad0c77f2017-11-09 18:00:15 -0800810 props = segment_manager_properties_get (app->sm_properties);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700811 if (verbose)
Florin Corascea194d2017-10-02 00:18:51 -0700812 s =
Florin Coras8f107b32017-11-21 22:13:03 -0800813 format (s, "%-10d%-20s%-15d%-15d%-15d%-15d%-15d", app->index, app_name,
814 app->api_client_index, app->ns_index,
Florin Corasad0c77f2017-11-09 18:00:15 -0800815 props->add_segment_size,
816 props->rx_fifo_size, props->tx_fifo_size);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700817 else
Florin Coras8f107b32017-11-21 22:13:03 -0800818 s = format (s, "%-10d%-20s%-15d%-40s", app->index, app_name,
819 app->api_client_index, app_ns_name);
Dave Barach68b0fb02017-02-28 15:15:56 -0500820 return s;
821}
822
823static clib_error_t *
824show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
825 vlib_cli_command_t * cmd)
826{
827 application_t *app;
828 int do_server = 0;
829 int do_client = 0;
830 int verbose = 0;
831
Florin Corascea194d2017-10-02 00:18:51 -0700832 session_cli_return_if_not_enabled ();
Florin Corase04c2992017-03-01 08:17:34 -0800833
Dave Barach68b0fb02017-02-28 15:15:56 -0500834 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
835 {
836 if (unformat (input, "server"))
837 do_server = 1;
838 else if (unformat (input, "client"))
839 do_client = 1;
840 else if (unformat (input, "verbose"))
841 verbose = 1;
842 else
843 break;
844 }
845
846 if (do_server)
847 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700848 u64 handle;
849 u32 index;
Dave Barach68b0fb02017-02-28 15:15:56 -0500850 if (pool_elts (app_pool))
851 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700852 vlib_cli_output (vm, "%U", format_application_listener,
853 0 /* header */ , 0, 0,
Dave Barach68b0fb02017-02-28 15:15:56 -0500854 verbose);
Florin Coras1c710452017-10-17 00:03:13 -0700855 /* *INDENT-OFF* */
Dave Barach68b0fb02017-02-28 15:15:56 -0500856 pool_foreach (app, app_pool,
857 ({
Florin Coras6cf30ad2017-04-04 23:08:23 -0700858 /* App's listener sessions */
859 if (hash_elts (app->listeners_table) == 0)
860 continue;
861 hash_foreach (handle, index, app->listeners_table,
862 ({
863 vlib_cli_output (vm, "%U", format_application_listener, app,
864 handle, index, verbose);
865 }));
Dave Barach68b0fb02017-02-28 15:15:56 -0500866 }));
867 /* *INDENT-ON* */
868 }
869 else
870 vlib_cli_output (vm, "No active server bindings");
871 }
872
873 if (do_client)
874 {
875 if (pool_elts (app_pool))
876 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700877 application_format_connects (0, verbose);
878
Dave Barach68b0fb02017-02-28 15:15:56 -0500879 /* *INDENT-OFF* */
880 pool_foreach (app, app_pool,
881 ({
Florin Coras6cf30ad2017-04-04 23:08:23 -0700882 if (app->connects_seg_manager == (u32)~0)
883 continue;
884 application_format_connects (app, verbose);
Dave Barach68b0fb02017-02-28 15:15:56 -0500885 }));
886 /* *INDENT-ON* */
887 }
888 else
Florin Corase04c2992017-03-01 08:17:34 -0800889 vlib_cli_output (vm, "No active client bindings");
Dave Barach68b0fb02017-02-28 15:15:56 -0500890 }
891
Florin Coras6cf30ad2017-04-04 23:08:23 -0700892 /* Print app related info */
893 if (!do_server && !do_client)
894 {
895 vlib_cli_output (vm, "%U", format_application, 0, verbose);
Florin Corascea194d2017-10-02 00:18:51 -0700896 /* *INDENT-OFF* */
897 pool_foreach (app, app_pool, ({
898 vlib_cli_output (vm, "%U", format_application, app, verbose);
899 }));
900 /* *INDENT-ON* */
Florin Coras6cf30ad2017-04-04 23:08:23 -0700901 }
902
Dave Barach68b0fb02017-02-28 15:15:56 -0500903 return 0;
904}
905
Florin Corase04c2992017-03-01 08:17:34 -0800906/* *INDENT-OFF* */
Dave Barach68b0fb02017-02-28 15:15:56 -0500907VLIB_CLI_COMMAND (show_app_command, static) =
908{
Florin Corase04c2992017-03-01 08:17:34 -0800909 .path = "show app",
910 .short_help = "show app [server|client] [verbose]",
911 .function = show_app_command_fn,
912};
913/* *INDENT-ON* */
Dave Barach68b0fb02017-02-28 15:15:56 -0500914
915/*
916 * fd.io coding-style-patch-verification: ON
917 *
918 * Local Variables:
919 * eval: (c-set-style "gnu")
920 * End:
921 */