blob: c16b4dab0577aaa4d378ebd6d483a38196e0ade9 [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{
79 unix_shared_memory_queue_t *q;
80
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 Coras6cf30ad2017-04-04 23:08:23 -0700149 segment_manager_t *sm;
Florin Coras7999e832017-10-31 01:51:04 -0700150 u64 handle, *handles = 0;
151 u32 index;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700152 int i;
153 vnet_unbind_args_t _a, *a = &_a;
Dave Barach68b0fb02017-02-28 15:15:56 -0500154
Florin Coras6cf30ad2017-04-04 23:08:23 -0700155 /*
Florin Corasa5464812017-04-19 13:00:05 -0700156 * The app event queue allocated in first segment is cleared with
157 * the segment manager. No need to explicitly free it.
158 */
Dave Wallace7b749fe2017-07-05 14:30:46 -0400159 if (CLIB_DEBUG > 1)
160 clib_warning ("[%d] Delete app (%d)", getpid (), app->index);
Florin Corasa5464812017-04-19 13:00:05 -0700161
Florin Coras7999e832017-10-31 01:51:04 -0700162 if (application_is_proxy (app))
163 application_remove_proxy (app);
164
Florin Corasa5464812017-04-19 13:00:05 -0700165 /*
Florin Corasc87c91d2017-08-16 19:55:49 -0700166 * Listener cleanup
Florin Coras6cf30ad2017-04-04 23:08:23 -0700167 */
Dave Barach68b0fb02017-02-28 15:15:56 -0500168
Florin Coras6cf30ad2017-04-04 23:08:23 -0700169 /* *INDENT-OFF* */
170 hash_foreach (handle, index, app->listeners_table,
171 ({
172 vec_add1 (handles, handle);
Florin Coras9d063042017-09-14 03:08:00 -0400173 sm = segment_manager_get (index);
174 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700175 }));
176 /* *INDENT-ON* */
177
Florin Coras6cf30ad2017-04-04 23:08:23 -0700178 for (i = 0; i < vec_len (handles); i++)
179 {
Florin Corasf03a59a2017-06-09 21:07:32 -0700180 a->app_index = app->index;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700181 a->handle = handles[i];
182 /* seg manager is removed when unbind completes */
183 vnet_unbind (a);
184 }
185
Florin Corasc87c91d2017-08-16 19:55:49 -0700186 /*
187 * Connects segment manager cleanup
188 */
189
190 if (app->connects_seg_manager != APP_INVALID_SEGMENT_MANAGER_INDEX)
191 {
192 sm = segment_manager_get (app->connects_seg_manager);
193 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
194 segment_manager_init_del (sm);
195 }
196
Florin Corasc87c91d2017-08-16 19:55:49 -0700197 /* If first segment manager is used by a listener */
198 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
199 && app->first_segment_manager != app->connects_seg_manager)
Dave Wallace7b749fe2017-07-05 14:30:46 -0400200 {
201 sm = segment_manager_get (app->first_segment_manager);
Florin Corasc87c91d2017-08-16 19:55:49 -0700202 /* .. and has no fifos, e.g. it might be used for redirected sessions,
203 * remove it */
204 if (!segment_manager_has_fifos (sm))
205 {
206 sm->app_index = SEGMENT_MANAGER_INVALID_APP_INDEX;
207 segment_manager_del (sm);
208 }
Dave Wallace7b749fe2017-07-05 14:30:46 -0400209 }
210
Dave Barach68b0fb02017-02-28 15:15:56 -0500211 application_table_del (app);
Dave Barach68b0fb02017-02-28 15:15:56 -0500212 pool_put (app_pool, app);
213}
214
Florin Corasd79b41e2017-03-04 05:37:52 -0800215static void
Florin Coras6cf30ad2017-04-04 23:08:23 -0700216application_verify_cb_fns (session_cb_vft_t * cb_fns)
Florin Corasd79b41e2017-03-04 05:37:52 -0800217{
Florin Coras6cf30ad2017-04-04 23:08:23 -0700218 if (cb_fns->session_accept_callback == 0)
Florin Corasd79b41e2017-03-04 05:37:52 -0800219 clib_warning ("No accept callback function provided");
Florin Coras6cf30ad2017-04-04 23:08:23 -0700220 if (cb_fns->session_connected_callback == 0)
Florin Corasd79b41e2017-03-04 05:37:52 -0800221 clib_warning ("No session connected callback function provided");
222 if (cb_fns->session_disconnect_callback == 0)
223 clib_warning ("No session disconnect callback function provided");
224 if (cb_fns->session_reset_callback == 0)
225 clib_warning ("No session reset callback function provided");
226}
227
Florin Coras6cf30ad2017-04-04 23:08:23 -0700228int
229application_init (application_t * app, u32 api_client_index, u64 * options,
230 session_cb_vft_t * cb_fns)
Dave Barach68b0fb02017-02-28 15:15:56 -0500231{
Florin Coras6cf30ad2017-04-04 23:08:23 -0700232 segment_manager_t *sm;
233 segment_manager_properties_t *props;
Florin Corasa5464812017-04-19 13:00:05 -0700234 u32 app_evt_queue_size, first_seg_size;
Florin Corasc87c91d2017-08-16 19:55:49 -0700235 u32 default_rx_fifo_size = 16 << 10, default_tx_fifo_size = 16 << 10;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700236 int rv;
Dave Barach68b0fb02017-02-28 15:15:56 -0500237
Florin Coras6cf30ad2017-04-04 23:08:23 -0700238 app_evt_queue_size = options[APP_EVT_QUEUE_SIZE] > 0 ?
239 options[APP_EVT_QUEUE_SIZE] : default_app_evt_queue_size;
Dave Barach68b0fb02017-02-28 15:15:56 -0500240
Florin Corascea194d2017-10-02 00:18:51 -0700241 /*
242 * Setup segment manager
243 */
Florin Coras6cf30ad2017-04-04 23:08:23 -0700244 sm = segment_manager_new ();
245 sm->app_index = app->index;
246 props = &app->sm_properties;
247 props->add_segment_size = options[SESSION_OPTIONS_ADD_SEGMENT_SIZE];
248 props->rx_fifo_size = options[SESSION_OPTIONS_RX_FIFO_SIZE];
Florin Corasc87c91d2017-08-16 19:55:49 -0700249 props->rx_fifo_size =
250 props->rx_fifo_size ? props->rx_fifo_size : default_rx_fifo_size;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700251 props->tx_fifo_size = options[SESSION_OPTIONS_TX_FIFO_SIZE];
Florin Corasc87c91d2017-08-16 19:55:49 -0700252 props->tx_fifo_size =
253 props->tx_fifo_size ? props->tx_fifo_size : default_tx_fifo_size;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700254 props->add_segment = props->add_segment_size != 0;
Dave Barach10d8cc62017-05-30 09:30:07 -0400255 props->preallocated_fifo_pairs = options[APP_OPTIONS_PREALLOC_FIFO_PAIRS];
Florin Corasa5464812017-04-19 13:00:05 -0700256 props->use_private_segment = options[APP_OPTIONS_FLAGS]
Florin Coras7999e832017-10-31 01:51:04 -0700257 & APP_OPTIONS_FLAGS_IS_BUILTIN;
Dave Barach2c25a622017-06-26 11:35:07 -0400258 props->private_segment_count = options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT];
259 props->private_segment_size = options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE];
Dave Barach68b0fb02017-02-28 15:15:56 -0500260
Florin Corasa5464812017-04-19 13:00:05 -0700261 first_seg_size = options[SESSION_OPTIONS_SEGMENT_SIZE];
262 if ((rv = segment_manager_init (sm, props, first_seg_size)))
Florin Coras6cf30ad2017-04-04 23:08:23 -0700263 return rv;
Florin Corasc87c91d2017-08-16 19:55:49 -0700264 sm->first_is_protected = 1;
Dave Barach68b0fb02017-02-28 15:15:56 -0500265
Florin Corascea194d2017-10-02 00:18:51 -0700266 /*
267 * Setup application
268 */
Florin Coras6cf30ad2017-04-04 23:08:23 -0700269 app->first_segment_manager = segment_manager_index (sm);
Dave Barach68b0fb02017-02-28 15:15:56 -0500270 app->api_client_index = api_client_index;
Florin Corasa5464812017-04-19 13:00:05 -0700271 app->flags = options[APP_OPTIONS_FLAGS];
Dave Barach68b0fb02017-02-28 15:15:56 -0500272 app->cb_fns = *cb_fns;
Florin Corascea194d2017-10-02 00:18:51 -0700273 app->ns_index = options[APP_OPTIONS_NAMESPACE];
Florin Coras7999e832017-10-31 01:51:04 -0700274 app->listeners_table = hash_create (0, sizeof (u64));
275 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
Florin Corascea194d2017-10-02 00:18:51 -0700276
277 /* If no scope enabled, default to global */
278 if (!application_has_global_scope (app)
279 && !application_has_local_scope (app))
280 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
Dave Barach68b0fb02017-02-28 15:15:56 -0500281
Florin Corasa5464812017-04-19 13:00:05 -0700282 /* Allocate app event queue in the first shared-memory segment */
283 app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
284
Florin Corasd79b41e2017-03-04 05:37:52 -0800285 /* Check that the obvious things are properly set up */
Florin Coras6cf30ad2017-04-04 23:08:23 -0700286 application_verify_cb_fns (cb_fns);
Florin Corasd79b41e2017-03-04 05:37:52 -0800287
Dave Barach68b0fb02017-02-28 15:15:56 -0500288 /* Add app to lookup by api_client_index table */
289 application_table_add (app);
290
Florin Coras6cf30ad2017-04-04 23:08:23 -0700291 return 0;
Dave Barach68b0fb02017-02-28 15:15:56 -0500292}
293
294application_t *
295application_get (u32 index)
296{
Florin Corascea194d2017-10-02 00:18:51 -0700297 if (index == APP_INVALID_INDEX)
298 return 0;
Dave Barach68b0fb02017-02-28 15:15:56 -0500299 return pool_elt_at_index (app_pool, index);
300}
301
Florin Corase04c2992017-03-01 08:17:34 -0800302application_t *
303application_get_if_valid (u32 index)
304{
305 if (pool_is_free_index (app_pool, index))
306 return 0;
307
308 return pool_elt_at_index (app_pool, index);
309}
310
Dave Barach68b0fb02017-02-28 15:15:56 -0500311u32
312application_get_index (application_t * app)
313{
314 return app - app_pool;
315}
316
Florin Coras6cf30ad2017-04-04 23:08:23 -0700317static segment_manager_t *
318application_alloc_segment_manager (application_t * app)
Dave Barach68b0fb02017-02-28 15:15:56 -0500319{
Florin Coras6cf30ad2017-04-04 23:08:23 -0700320 segment_manager_t *sm = 0;
Dave Barach68b0fb02017-02-28 15:15:56 -0500321
Florin Corasc87c91d2017-08-16 19:55:49 -0700322 /* If the first segment manager is not in use, don't allocate a new one */
323 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
Florin Coras0e9c33b2017-08-14 22:33:41 -0700324 && app->first_segment_manager_in_use == 0)
Dave Barach68b0fb02017-02-28 15:15:56 -0500325 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700326 sm = segment_manager_get (app->first_segment_manager);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700327 app->first_segment_manager_in_use = 1;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700328 return sm;
Dave Barach68b0fb02017-02-28 15:15:56 -0500329 }
330
Florin Coras6cf30ad2017-04-04 23:08:23 -0700331 sm = segment_manager_new ();
Florin Coras0e9c33b2017-08-14 22:33:41 -0700332 sm->properties = &app->sm_properties;
333
Florin Coras6cf30ad2017-04-04 23:08:23 -0700334 return sm;
335}
336
337/**
338 * Start listening local transport endpoint for requested transport.
339 *
340 * Creates a 'dummy' stream session with state LISTENING to be used in session
341 * lookups, prior to establishing connection. Requests transport to build
342 * it's own specific listening connection.
343 */
344int
Florin Corascea194d2017-10-02 00:18:51 -0700345application_start_listen (application_t * srv, session_endpoint_t * sep,
346 u64 * res)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700347{
348 segment_manager_t *sm;
349 stream_session_t *s;
350 u64 handle;
Florin Corascea194d2017-10-02 00:18:51 -0700351 session_type_t sst;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700352
Florin Corascea194d2017-10-02 00:18:51 -0700353 sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
354 s = listen_session_new (sst);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700355 s->app_index = srv->index;
356
Florin Corascea194d2017-10-02 00:18:51 -0700357 if (stream_session_listen (s, sep))
Florin Coras6cf30ad2017-04-04 23:08:23 -0700358 goto err;
359
360 /* Allocate segment manager. All sessions derived out of a listen session
361 * have fifos allocated by the same segment manager. */
362 sm = application_alloc_segment_manager (srv);
363 if (sm == 0)
364 goto err;
365
366 /* Add to app's listener table. Useful to find all child listeners
367 * when app goes down, although, just for unbinding this is not needed */
368 handle = listen_session_get_handle (s);
369 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
370
371 *res = handle;
372 return 0;
373
374err:
375 listen_session_del (s);
376 return -1;
377}
378
379/**
380 * Stop listening on session associated to handle
381 */
382int
383application_stop_listen (application_t * srv, u64 handle)
384{
385 stream_session_t *listener;
386 uword *indexp;
387 segment_manager_t *sm;
388
389 if (srv && hash_get (srv->listeners_table, handle) == 0)
390 {
391 clib_warning ("app doesn't own handle %llu!", handle);
392 return -1;
393 }
394
395 listener = listen_session_get_from_handle (handle);
396 stream_session_stop_listen (listener);
397
398 indexp = hash_get (srv->listeners_table, handle);
399 ASSERT (indexp);
400
401 sm = segment_manager_get (*indexp);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700402 if (srv->first_segment_manager == *indexp)
403 {
Florin Corasc87c91d2017-08-16 19:55:49 -0700404 /* Delete sessions but don't remove segment manager */
Florin Coras0e9c33b2017-08-14 22:33:41 -0700405 srv->first_segment_manager_in_use = 0;
Florin Corasc87c91d2017-08-16 19:55:49 -0700406 segment_manager_del_sessions (sm);
407 }
408 else
409 {
410 segment_manager_init_del (sm);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700411 }
Florin Coras6cf30ad2017-04-04 23:08:23 -0700412 hash_unset (srv->listeners_table, handle);
413 listen_session_del (listener);
414
Dave Barach68b0fb02017-02-28 15:15:56 -0500415 return 0;
416}
417
Florin Coras6cf30ad2017-04-04 23:08:23 -0700418int
Florin Corascea194d2017-10-02 00:18:51 -0700419application_open_session (application_t * app, session_endpoint_t * sep,
420 u32 api_context)
Dave Barach68b0fb02017-02-28 15:15:56 -0500421{
Florin Coras6cf30ad2017-04-04 23:08:23 -0700422 segment_manager_t *sm;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700423 int rv;
424
425 /* Make sure we have a segment manager for connects */
Florin Corascea194d2017-10-02 00:18:51 -0700426 if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700427 {
428 sm = application_alloc_segment_manager (app);
429 if (sm == 0)
430 return -1;
431 app->connects_seg_manager = segment_manager_index (sm);
432 }
433
Florin Coras3cbc04b2017-10-02 00:18:51 -0700434 if ((rv = session_open (app->index, sep, api_context)))
Florin Coras6cf30ad2017-04-04 23:08:23 -0700435 return rv;
436
Florin Coras6cf30ad2017-04-04 23:08:23 -0700437 return 0;
438}
439
440segment_manager_t *
441application_get_connect_segment_manager (application_t * app)
442{
443 ASSERT (app->connects_seg_manager != (u32) ~ 0);
444 return segment_manager_get (app->connects_seg_manager);
445}
446
447segment_manager_t *
448application_get_listen_segment_manager (application_t * app,
449 stream_session_t * s)
450{
451 uword *smp;
452 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
453 ASSERT (smp != 0);
454 return segment_manager_get (*smp);
455}
456
Dave Barach52851e62017-08-07 09:35:25 -0400457int
458application_is_proxy (application_t * app)
459{
Florin Coras7999e832017-10-31 01:51:04 -0700460 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
461}
462
463int
464application_is_builtin (application_t * app)
465{
466 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
467}
468
469int
470application_is_builtin_proxy (application_t * app)
471{
472 return (application_is_proxy (app) && application_is_builtin (app));
Dave Barach52851e62017-08-07 09:35:25 -0400473}
474
Florin Corasc87c91d2017-08-16 19:55:49 -0700475int
476application_add_segment_notify (u32 app_index, u32 fifo_segment_index)
477{
478 application_t *app = application_get (app_index);
479 u32 seg_size = 0;
480 u8 *seg_name;
481
482 /* Send an API message to the external app, to map new segment */
483 ASSERT (app->cb_fns.add_segment_callback);
484
485 segment_manager_get_segment_info (fifo_segment_index, &seg_name, &seg_size);
486 return app->cb_fns.add_segment_callback (app->api_client_index, seg_name,
487 seg_size);
488}
489
Florin Corascea194d2017-10-02 00:18:51 -0700490u8
491application_has_local_scope (application_t * app)
492{
493 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
494}
495
496u8
497application_has_global_scope (application_t * app)
498{
499 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
500}
501
Florin Coras1c710452017-10-17 00:03:13 -0700502u32
503application_n_listeners (application_t * app)
504{
505 return hash_elts (app->listeners_table);
506}
507
508stream_session_t *
Florin Coras7999e832017-10-31 01:51:04 -0700509application_first_listener (application_t * app, u8 fib_proto,
510 u8 transport_proto)
Florin Coras1c710452017-10-17 00:03:13 -0700511{
Florin Coras7999e832017-10-31 01:51:04 -0700512 stream_session_t *listener;
Florin Coras1c710452017-10-17 00:03:13 -0700513 u64 handle;
514 u32 sm_index;
Florin Coras7999e832017-10-31 01:51:04 -0700515 u8 sst;
516
517 sst = session_type_from_proto_and_ip (transport_proto,
518 fib_proto == FIB_PROTOCOL_IP4);
Florin Coras1c710452017-10-17 00:03:13 -0700519
520 /* *INDENT-OFF* */
521 hash_foreach (handle, sm_index, app->listeners_table, ({
Florin Coras7999e832017-10-31 01:51:04 -0700522 listener = listen_session_get_from_handle (handle);
523 if (listener->session_type == sst)
524 return listener;
Florin Coras1c710452017-10-17 00:03:13 -0700525 }));
526 /* *INDENT-ON* */
527
528 return 0;
529}
530
Florin Coras7999e832017-10-31 01:51:04 -0700531static clib_error_t *
532application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
533 u8 transport_proto, u8 is_start)
534{
535 session_rule_add_del_args_t args;
536 fib_prefix_t lcl_pref, rmt_pref;
537 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
538 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
539 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
540 transport_connection_t *tc;
541 stream_session_t *s;
542 u64 handle;
543
544 if (is_start)
545 {
546 sep.is_ip4 = is_ip4;
547 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
548 sep.sw_if_index = app_ns->sw_if_index;
549 sep.transport_proto = transport_proto;
550 application_start_listen (app, &sep, &handle);
551 s = listen_session_get_from_handle (handle);
552 }
553 else
554 {
555 s = application_first_listener (app, fib_proto, transport_proto);
556 }
557 tc = listen_session_get_transport (s);
558
559 if (!ip_is_zero (&tc->lcl_ip, 1))
560 {
Florin Coras62333be2017-11-01 18:19:22 -0700561 memset (&lcl_pref, 0, sizeof (lcl_pref));
Florin Coras7999e832017-10-31 01:51:04 -0700562 ip_copy (&lcl_pref.fp_addr, &tc->lcl_ip, is_ip4);
563 lcl_pref.fp_len = is_ip4 ? 32 : 128;
564 lcl_pref.fp_proto = fib_proto;
Florin Coras62333be2017-11-01 18:19:22 -0700565 memset (&rmt_pref, 0, sizeof (rmt_pref));
Florin Coras7999e832017-10-31 01:51:04 -0700566 rmt_pref.fp_len = 0;
567 rmt_pref.fp_proto = fib_proto;
568
569 args.table_args.lcl = lcl_pref;
570 args.table_args.rmt = rmt_pref;
571 args.table_args.lcl_port = 0;
572 args.table_args.rmt_port = 0;
573 args.table_args.action_index = app->index;
574 args.table_args.is_add = is_start;
575 args.table_args.transport_proto = transport_proto;
576 args.appns_index = app->ns_index;
577 args.scope = SESSION_RULE_SCOPE_GLOBAL;
578 return vnet_session_rule_add_del (&args);
579 }
580 return 0;
581}
582
583void
584application_start_stop_proxy (application_t * app, u8 transport_proto,
585 u8 is_start)
586{
587 session_rule_add_del_args_t args;
588
589 if (application_has_local_scope (app))
590 {
591 memset (&args, 0, sizeof (args));
592 args.table_args.lcl.fp_proto = FIB_PROTOCOL_IP4;
593 args.table_args.rmt.fp_proto = FIB_PROTOCOL_IP4;
594 args.table_args.lcl_port = 0;
595 args.table_args.rmt_port = 0;
596 args.table_args.action_index = app->index;
597 args.table_args.is_add = is_start;
598 args.table_args.transport_proto = transport_proto;
599 args.appns_index = app->ns_index;
600 args.scope = SESSION_RULE_SCOPE_LOCAL;
601 vnet_session_rule_add_del (&args);
602
603 args.table_args.lcl.fp_proto = FIB_PROTOCOL_IP6;
604 args.table_args.rmt.fp_proto = FIB_PROTOCOL_IP6;
605 vnet_session_rule_add_del (&args);
606 }
607
608 if (application_has_global_scope (app))
609 {
610 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
611 transport_proto, is_start);
612 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
613 transport_proto, is_start);
614 }
615}
616
617void
618application_setup_proxy (application_t * app)
619{
620 u16 transports = app->proxied_transports;
621 ASSERT (application_is_proxy (app));
622 if (application_is_builtin (app))
623 return;
624 if (transports & (1 << TRANSPORT_PROTO_TCP))
625 application_start_stop_proxy (app, TRANSPORT_PROTO_TCP, 1);
626 if (transports & (1 << TRANSPORT_PROTO_UDP))
627 application_start_stop_proxy (app, TRANSPORT_PROTO_UDP, 1);
628}
629
630void
631application_remove_proxy (application_t * app)
632{
633 u16 transports = app->proxied_transports;
634 ASSERT (application_is_proxy (app));
635 if (transports & (1 << TRANSPORT_PROTO_TCP))
636 application_start_stop_proxy (app, TRANSPORT_PROTO_TCP, 0);
637 if (transports & (1 << TRANSPORT_PROTO_UDP))
638 application_start_stop_proxy (app, TRANSPORT_PROTO_UDP, 0);
639}
640
Dave Barach68b0fb02017-02-28 15:15:56 -0500641u8 *
Florin Coras6cf30ad2017-04-04 23:08:23 -0700642format_application_listener (u8 * s, va_list * args)
Dave Barach68b0fb02017-02-28 15:15:56 -0500643{
Florin Coras6cf30ad2017-04-04 23:08:23 -0700644 application_t *app = va_arg (*args, application_t *);
645 u64 handle = va_arg (*args, u64);
646 u32 index = va_arg (*args, u32);
Dave Barach68b0fb02017-02-28 15:15:56 -0500647 int verbose = va_arg (*args, int);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700648 stream_session_t *listener;
649 u8 *app_name, *str;
Dave Barach68b0fb02017-02-28 15:15:56 -0500650
Florin Coras6cf30ad2017-04-04 23:08:23 -0700651 if (app == 0)
Dave Barach68b0fb02017-02-28 15:15:56 -0500652 {
653 if (verbose)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700654 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
655 "API Client", "ListenerID", "SegManager");
Dave Barach68b0fb02017-02-28 15:15:56 -0500656 else
Florin Coras6cf30ad2017-04-04 23:08:23 -0700657 s = format (s, "%-40s%-20s", "Connection", "App");
Dave Barach68b0fb02017-02-28 15:15:56 -0500658
659 return s;
660 }
661
Florin Coras6cf30ad2017-04-04 23:08:23 -0700662 app_name = app_get_name_from_reg_index (app);
663 listener = listen_session_get_from_handle (handle);
664 str = format (0, "%U", format_stream_session, listener, verbose);
Dave Barach68b0fb02017-02-28 15:15:56 -0500665
Dave Barach68b0fb02017-02-28 15:15:56 -0500666 if (verbose)
667 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700668 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
669 app->api_client_index, handle, index);
Dave Barach68b0fb02017-02-28 15:15:56 -0500670 }
671 else
Florin Coras6cf30ad2017-04-04 23:08:23 -0700672 s = format (s, "%-40s%-20s", str, app_name);
673
674 vec_free (app_name);
675 return s;
676}
677
678void
679application_format_connects (application_t * app, int verbose)
680{
681 vlib_main_t *vm = vlib_get_main ();
682 segment_manager_t *sm;
683 u8 *app_name, *s = 0;
Dave Barach10d8cc62017-05-30 09:30:07 -0400684 int j;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700685
686 /* Header */
687 if (app == 0)
688 {
689 if (verbose)
690 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
691 "API Client", "SegManager");
692 else
693 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
694 return;
695 }
696
697 /* make sure */
698 if (app->connects_seg_manager == (u32) ~ 0)
699 return;
700
701 app_name = app_get_name_from_reg_index (app);
702
703 /* Across all fifo segments */
704 sm = segment_manager_get (app->connects_seg_manager);
705 for (j = 0; j < vec_len (sm->segment_indices); j++)
706 {
707 svm_fifo_segment_private_t *fifo_segment;
Dave Barach10d8cc62017-05-30 09:30:07 -0400708 svm_fifo_t *fifo;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700709 u8 *str;
710
Florin Corasc87c91d2017-08-16 19:55:49 -0700711 fifo_segment = svm_fifo_segment_get_segment (sm->segment_indices[j]);
Dave Barach10d8cc62017-05-30 09:30:07 -0400712 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
713 while (fifo)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700714 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700715 u32 session_index, thread_index;
716 stream_session_t *session;
717
Florin Corasa5464812017-04-19 13:00:05 -0700718 session_index = fifo->master_session_index;
719 thread_index = fifo->master_thread_index;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700720
Florin Corascea194d2017-10-02 00:18:51 -0700721 session = session_get (session_index, thread_index);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700722 str = format (0, "%U", format_stream_session, session, verbose);
723
724 if (verbose)
725 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
726 app->api_client_index, app->connects_seg_manager);
727 else
728 s = format (s, "%-40s%-20s", str, app_name);
729
730 vlib_cli_output (vm, "%v", s);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700731 vec_reset_length (s);
732 vec_free (str);
Dave Barach10d8cc62017-05-30 09:30:07 -0400733
734 fifo = fifo->next;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700735 }
736 vec_free (s);
737 }
738
739 vec_free (app_name);
740}
741
742u8 *
743format_application (u8 * s, va_list * args)
744{
745 application_t *app = va_arg (*args, application_t *);
746 CLIB_UNUSED (int verbose) = va_arg (*args, int);
Florin Corascea194d2017-10-02 00:18:51 -0700747 const u8 *app_ns_name;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700748 u8 *app_name;
749
750 if (app == 0)
751 {
752 if (verbose)
Florin Corascea194d2017-10-02 00:18:51 -0700753 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
754 "Namespace", "API Client", "Add seg size", "Rx fifo size",
Florin Coras6cf30ad2017-04-04 23:08:23 -0700755 "Tx fifo size");
756 else
Florin Corascea194d2017-10-02 00:18:51 -0700757 s =
758 format (s, "%-10s%-20s%-15s%-20s", "Index", "Name", "Namespace",
759 "API Client");
Florin Coras6cf30ad2017-04-04 23:08:23 -0700760 return s;
761 }
762
763 app_name = app_get_name_from_reg_index (app);
Florin Corascea194d2017-10-02 00:18:51 -0700764 app_ns_name = app_namespace_id_from_index (app->ns_index);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700765 if (verbose)
Florin Corascea194d2017-10-02 00:18:51 -0700766 s =
767 format (s, "%-10d%-20s%-15s%-15d%-15d%-15d%-15d", app->index, app_name,
768 app_ns_name, app->api_client_index,
769 app->sm_properties.add_segment_size,
770 app->sm_properties.rx_fifo_size,
771 app->sm_properties.tx_fifo_size);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700772 else
Florin Corascea194d2017-10-02 00:18:51 -0700773 s = format (s, "%-10d%-20s%-15s%-20d", app->index, app_name, app_ns_name,
Florin Coras6cf30ad2017-04-04 23:08:23 -0700774 app->api_client_index);
Dave Barach68b0fb02017-02-28 15:15:56 -0500775 return s;
776}
777
778static clib_error_t *
779show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
780 vlib_cli_command_t * cmd)
781{
782 application_t *app;
783 int do_server = 0;
784 int do_client = 0;
785 int verbose = 0;
786
Florin Corascea194d2017-10-02 00:18:51 -0700787 session_cli_return_if_not_enabled ();
Florin Corase04c2992017-03-01 08:17:34 -0800788
Dave Barach68b0fb02017-02-28 15:15:56 -0500789 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
790 {
791 if (unformat (input, "server"))
792 do_server = 1;
793 else if (unformat (input, "client"))
794 do_client = 1;
795 else if (unformat (input, "verbose"))
796 verbose = 1;
797 else
798 break;
799 }
800
801 if (do_server)
802 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700803 u64 handle;
804 u32 index;
Dave Barach68b0fb02017-02-28 15:15:56 -0500805 if (pool_elts (app_pool))
806 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700807 vlib_cli_output (vm, "%U", format_application_listener,
808 0 /* header */ , 0, 0,
Dave Barach68b0fb02017-02-28 15:15:56 -0500809 verbose);
Florin Coras1c710452017-10-17 00:03:13 -0700810 /* *INDENT-OFF* */
Dave Barach68b0fb02017-02-28 15:15:56 -0500811 pool_foreach (app, app_pool,
812 ({
Florin Coras6cf30ad2017-04-04 23:08:23 -0700813 /* App's listener sessions */
814 if (hash_elts (app->listeners_table) == 0)
815 continue;
816 hash_foreach (handle, index, app->listeners_table,
817 ({
818 vlib_cli_output (vm, "%U", format_application_listener, app,
819 handle, index, verbose);
820 }));
Dave Barach68b0fb02017-02-28 15:15:56 -0500821 }));
822 /* *INDENT-ON* */
823 }
824 else
825 vlib_cli_output (vm, "No active server bindings");
826 }
827
828 if (do_client)
829 {
830 if (pool_elts (app_pool))
831 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700832 application_format_connects (0, verbose);
833
Dave Barach68b0fb02017-02-28 15:15:56 -0500834 /* *INDENT-OFF* */
835 pool_foreach (app, app_pool,
836 ({
Florin Coras6cf30ad2017-04-04 23:08:23 -0700837 if (app->connects_seg_manager == (u32)~0)
838 continue;
839 application_format_connects (app, verbose);
Dave Barach68b0fb02017-02-28 15:15:56 -0500840 }));
841 /* *INDENT-ON* */
842 }
843 else
Florin Corase04c2992017-03-01 08:17:34 -0800844 vlib_cli_output (vm, "No active client bindings");
Dave Barach68b0fb02017-02-28 15:15:56 -0500845 }
846
Florin Coras6cf30ad2017-04-04 23:08:23 -0700847 /* Print app related info */
848 if (!do_server && !do_client)
849 {
850 vlib_cli_output (vm, "%U", format_application, 0, verbose);
Florin Corascea194d2017-10-02 00:18:51 -0700851 /* *INDENT-OFF* */
852 pool_foreach (app, app_pool, ({
853 vlib_cli_output (vm, "%U", format_application, app, verbose);
854 }));
855 /* *INDENT-ON* */
Florin Coras6cf30ad2017-04-04 23:08:23 -0700856 }
857
Dave Barach68b0fb02017-02-28 15:15:56 -0500858 return 0;
859}
860
Florin Corase04c2992017-03-01 08:17:34 -0800861/* *INDENT-OFF* */
Dave Barach68b0fb02017-02-28 15:15:56 -0500862VLIB_CLI_COMMAND (show_app_command, static) =
863{
Florin Corase04c2992017-03-01 08:17:34 -0800864 .path = "show app",
865 .short_help = "show app [server|client] [verbose]",
866 .function = show_app_command_fn,
867};
868/* *INDENT-ON* */
Dave Barach68b0fb02017-02-28 15:15:56 -0500869
870/*
871 * fd.io coding-style-patch-verification: ON
872 *
873 * Local Variables:
874 * eval: (c-set-style "gnu")
875 * End:
876 */