blob: 9cb4cb75615a965fc565fb279b3774b42e5bb7da [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 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 Coras6cf30ad2017-04-04 23:08:23 -0700240 app_evt_queue_size = options[APP_EVT_QUEUE_SIZE] > 0 ?
241 options[APP_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 Coras6cf30ad2017-04-04 23:08:23 -0700250 props->add_segment_size = options[SESSION_OPTIONS_ADD_SEGMENT_SIZE];
251 props->rx_fifo_size = options[SESSION_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 Coras6cf30ad2017-04-04 23:08:23 -0700254 props->tx_fifo_size = options[SESSION_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];
262 props->private_segment_size = options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE];
Dave Barach68b0fb02017-02-28 15:15:56 -0500263
Florin Corasa5464812017-04-19 13:00:05 -0700264 first_seg_size = options[SESSION_OPTIONS_SEGMENT_SIZE];
Florin Corasad0c77f2017-11-09 18:00:15 -0800265 if ((rv = segment_manager_init (sm, app->sm_properties, first_seg_size)))
Florin Coras6cf30ad2017-04-04 23:08:23 -0700266 return rv;
Florin Corasc87c91d2017-08-16 19:55:49 -0700267 sm->first_is_protected = 1;
Dave Barach68b0fb02017-02-28 15:15:56 -0500268
Florin Corascea194d2017-10-02 00:18:51 -0700269 /*
270 * Setup application
271 */
Florin Coras6cf30ad2017-04-04 23:08:23 -0700272 app->first_segment_manager = segment_manager_index (sm);
Dave Barach68b0fb02017-02-28 15:15:56 -0500273 app->api_client_index = api_client_index;
Florin Corasa5464812017-04-19 13:00:05 -0700274 app->flags = options[APP_OPTIONS_FLAGS];
Dave Barach68b0fb02017-02-28 15:15:56 -0500275 app->cb_fns = *cb_fns;
Florin Corascea194d2017-10-02 00:18:51 -0700276 app->ns_index = options[APP_OPTIONS_NAMESPACE];
Florin Coras7999e832017-10-31 01:51:04 -0700277 app->listeners_table = hash_create (0, sizeof (u64));
278 app->proxied_transports = options[APP_OPTIONS_PROXY_TRANSPORT];
Florin Corascea194d2017-10-02 00:18:51 -0700279
280 /* If no scope enabled, default to global */
281 if (!application_has_global_scope (app)
282 && !application_has_local_scope (app))
283 app->flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
Dave Barach68b0fb02017-02-28 15:15:56 -0500284
Florin Corasa5464812017-04-19 13:00:05 -0700285 /* Allocate app event queue in the first shared-memory segment */
286 app->event_queue = segment_manager_alloc_queue (sm, app_evt_queue_size);
287
Florin Corasd79b41e2017-03-04 05:37:52 -0800288 /* Check that the obvious things are properly set up */
Florin Coras6cf30ad2017-04-04 23:08:23 -0700289 application_verify_cb_fns (cb_fns);
Florin Corasd79b41e2017-03-04 05:37:52 -0800290
Dave Barach68b0fb02017-02-28 15:15:56 -0500291 /* Add app to lookup by api_client_index table */
292 application_table_add (app);
293
Florin Coras6cf30ad2017-04-04 23:08:23 -0700294 return 0;
Dave Barach68b0fb02017-02-28 15:15:56 -0500295}
296
297application_t *
298application_get (u32 index)
299{
Florin Corascea194d2017-10-02 00:18:51 -0700300 if (index == APP_INVALID_INDEX)
301 return 0;
Dave Barach68b0fb02017-02-28 15:15:56 -0500302 return pool_elt_at_index (app_pool, index);
303}
304
Florin Corase04c2992017-03-01 08:17:34 -0800305application_t *
306application_get_if_valid (u32 index)
307{
308 if (pool_is_free_index (app_pool, index))
309 return 0;
310
311 return pool_elt_at_index (app_pool, index);
312}
313
Dave Barach68b0fb02017-02-28 15:15:56 -0500314u32
315application_get_index (application_t * app)
316{
317 return app - app_pool;
318}
319
Florin Coras6cf30ad2017-04-04 23:08:23 -0700320static segment_manager_t *
321application_alloc_segment_manager (application_t * app)
Dave Barach68b0fb02017-02-28 15:15:56 -0500322{
Florin Coras6cf30ad2017-04-04 23:08:23 -0700323 segment_manager_t *sm = 0;
Dave Barach68b0fb02017-02-28 15:15:56 -0500324
Florin Corasc87c91d2017-08-16 19:55:49 -0700325 /* If the first segment manager is not in use, don't allocate a new one */
326 if (app->first_segment_manager != APP_INVALID_SEGMENT_MANAGER_INDEX
Florin Coras0e9c33b2017-08-14 22:33:41 -0700327 && app->first_segment_manager_in_use == 0)
Dave Barach68b0fb02017-02-28 15:15:56 -0500328 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700329 sm = segment_manager_get (app->first_segment_manager);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700330 app->first_segment_manager_in_use = 1;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700331 return sm;
Dave Barach68b0fb02017-02-28 15:15:56 -0500332 }
333
Florin Coras6cf30ad2017-04-04 23:08:23 -0700334 sm = segment_manager_new ();
Florin Corasad0c77f2017-11-09 18:00:15 -0800335 sm->properties_index = app->sm_properties;
Florin Coras0e9c33b2017-08-14 22:33:41 -0700336
Florin Coras6cf30ad2017-04-04 23:08:23 -0700337 return sm;
338}
339
340/**
341 * Start listening local transport endpoint for requested transport.
342 *
343 * Creates a 'dummy' stream session with state LISTENING to be used in session
344 * lookups, prior to establishing connection. Requests transport to build
345 * it's own specific listening connection.
346 */
347int
Florin Corascea194d2017-10-02 00:18:51 -0700348application_start_listen (application_t * srv, session_endpoint_t * sep,
349 u64 * res)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700350{
351 segment_manager_t *sm;
352 stream_session_t *s;
353 u64 handle;
Florin Corascea194d2017-10-02 00:18:51 -0700354 session_type_t sst;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700355
Florin Corascea194d2017-10-02 00:18:51 -0700356 sst = session_type_from_proto_and_ip (sep->transport_proto, sep->is_ip4);
357 s = listen_session_new (sst);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700358 s->app_index = srv->index;
359
Florin Corascea194d2017-10-02 00:18:51 -0700360 if (stream_session_listen (s, sep))
Florin Coras6cf30ad2017-04-04 23:08:23 -0700361 goto err;
362
363 /* Allocate segment manager. All sessions derived out of a listen session
364 * have fifos allocated by the same segment manager. */
365 sm = application_alloc_segment_manager (srv);
366 if (sm == 0)
367 goto err;
368
369 /* Add to app's listener table. Useful to find all child listeners
370 * when app goes down, although, just for unbinding this is not needed */
371 handle = listen_session_get_handle (s);
372 hash_set (srv->listeners_table, handle, segment_manager_index (sm));
373
374 *res = handle;
375 return 0;
376
377err:
378 listen_session_del (s);
379 return -1;
380}
381
382/**
383 * Stop listening on session associated to handle
384 */
385int
386application_stop_listen (application_t * srv, u64 handle)
387{
388 stream_session_t *listener;
389 uword *indexp;
390 segment_manager_t *sm;
391
392 if (srv && hash_get (srv->listeners_table, handle) == 0)
393 {
394 clib_warning ("app doesn't own handle %llu!", handle);
395 return -1;
396 }
397
398 listener = listen_session_get_from_handle (handle);
399 stream_session_stop_listen (listener);
400
401 indexp = hash_get (srv->listeners_table, handle);
402 ASSERT (indexp);
403
404 sm = segment_manager_get (*indexp);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700405 if (srv->first_segment_manager == *indexp)
406 {
Florin Corasc87c91d2017-08-16 19:55:49 -0700407 /* Delete sessions but don't remove segment manager */
Florin Coras0e9c33b2017-08-14 22:33:41 -0700408 srv->first_segment_manager_in_use = 0;
Florin Corasc87c91d2017-08-16 19:55:49 -0700409 segment_manager_del_sessions (sm);
410 }
411 else
412 {
413 segment_manager_init_del (sm);
Florin Coras0e9c33b2017-08-14 22:33:41 -0700414 }
Florin Coras6cf30ad2017-04-04 23:08:23 -0700415 hash_unset (srv->listeners_table, handle);
416 listen_session_del (listener);
417
Dave Barach68b0fb02017-02-28 15:15:56 -0500418 return 0;
419}
420
Florin Coras6cf30ad2017-04-04 23:08:23 -0700421int
Florin Corascea194d2017-10-02 00:18:51 -0700422application_open_session (application_t * app, session_endpoint_t * sep,
423 u32 api_context)
Dave Barach68b0fb02017-02-28 15:15:56 -0500424{
Florin Coras6cf30ad2017-04-04 23:08:23 -0700425 segment_manager_t *sm;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700426 int rv;
427
428 /* Make sure we have a segment manager for connects */
Florin Corascea194d2017-10-02 00:18:51 -0700429 if (app->connects_seg_manager == APP_INVALID_SEGMENT_MANAGER_INDEX)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700430 {
431 sm = application_alloc_segment_manager (app);
432 if (sm == 0)
433 return -1;
434 app->connects_seg_manager = segment_manager_index (sm);
435 }
436
Florin Coras3cbc04b2017-10-02 00:18:51 -0700437 if ((rv = session_open (app->index, sep, api_context)))
Florin Coras6cf30ad2017-04-04 23:08:23 -0700438 return rv;
439
Florin Coras6cf30ad2017-04-04 23:08:23 -0700440 return 0;
441}
442
443segment_manager_t *
444application_get_connect_segment_manager (application_t * app)
445{
446 ASSERT (app->connects_seg_manager != (u32) ~ 0);
447 return segment_manager_get (app->connects_seg_manager);
448}
449
450segment_manager_t *
451application_get_listen_segment_manager (application_t * app,
452 stream_session_t * s)
453{
454 uword *smp;
455 smp = hash_get (app->listeners_table, listen_session_get_handle (s));
456 ASSERT (smp != 0);
457 return segment_manager_get (*smp);
458}
459
Dave Barach52851e62017-08-07 09:35:25 -0400460int
461application_is_proxy (application_t * app)
462{
Florin Coras7999e832017-10-31 01:51:04 -0700463 return (app->flags & APP_OPTIONS_FLAGS_IS_PROXY);
464}
465
466int
467application_is_builtin (application_t * app)
468{
469 return (app->flags & APP_OPTIONS_FLAGS_IS_BUILTIN);
470}
471
472int
473application_is_builtin_proxy (application_t * app)
474{
475 return (application_is_proxy (app) && application_is_builtin (app));
Dave Barach52851e62017-08-07 09:35:25 -0400476}
477
Florin Corasc87c91d2017-08-16 19:55:49 -0700478int
479application_add_segment_notify (u32 app_index, u32 fifo_segment_index)
480{
481 application_t *app = application_get (app_index);
482 u32 seg_size = 0;
483 u8 *seg_name;
484
485 /* Send an API message to the external app, to map new segment */
486 ASSERT (app->cb_fns.add_segment_callback);
487
488 segment_manager_get_segment_info (fifo_segment_index, &seg_name, &seg_size);
489 return app->cb_fns.add_segment_callback (app->api_client_index, seg_name,
490 seg_size);
491}
492
Florin Corascea194d2017-10-02 00:18:51 -0700493u8
494application_has_local_scope (application_t * app)
495{
496 return app->flags & APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
497}
498
499u8
500application_has_global_scope (application_t * app)
501{
502 return app->flags & APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
503}
504
Florin Coras1c710452017-10-17 00:03:13 -0700505u32
506application_n_listeners (application_t * app)
507{
508 return hash_elts (app->listeners_table);
509}
510
511stream_session_t *
Florin Coras7999e832017-10-31 01:51:04 -0700512application_first_listener (application_t * app, u8 fib_proto,
513 u8 transport_proto)
Florin Coras1c710452017-10-17 00:03:13 -0700514{
Florin Coras7999e832017-10-31 01:51:04 -0700515 stream_session_t *listener;
Florin Coras1c710452017-10-17 00:03:13 -0700516 u64 handle;
517 u32 sm_index;
Florin Coras7999e832017-10-31 01:51:04 -0700518 u8 sst;
519
520 sst = session_type_from_proto_and_ip (transport_proto,
521 fib_proto == FIB_PROTOCOL_IP4);
Florin Coras1c710452017-10-17 00:03:13 -0700522
523 /* *INDENT-OFF* */
524 hash_foreach (handle, sm_index, app->listeners_table, ({
Florin Coras7999e832017-10-31 01:51:04 -0700525 listener = listen_session_get_from_handle (handle);
526 if (listener->session_type == sst)
527 return listener;
Florin Coras1c710452017-10-17 00:03:13 -0700528 }));
529 /* *INDENT-ON* */
530
531 return 0;
532}
533
Florin Coras7999e832017-10-31 01:51:04 -0700534static clib_error_t *
535application_start_stop_proxy_fib_proto (application_t * app, u8 fib_proto,
536 u8 transport_proto, u8 is_start)
537{
538 session_rule_add_del_args_t args;
539 fib_prefix_t lcl_pref, rmt_pref;
540 app_namespace_t *app_ns = app_namespace_get (app->ns_index);
541 u8 is_ip4 = (fib_proto == FIB_PROTOCOL_IP4);
542 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
543 transport_connection_t *tc;
544 stream_session_t *s;
545 u64 handle;
546
547 if (is_start)
548 {
549 sep.is_ip4 = is_ip4;
550 sep.fib_index = app_namespace_get_fib_index (app_ns, fib_proto);
551 sep.sw_if_index = app_ns->sw_if_index;
552 sep.transport_proto = transport_proto;
553 application_start_listen (app, &sep, &handle);
554 s = listen_session_get_from_handle (handle);
555 }
556 else
557 {
558 s = application_first_listener (app, fib_proto, transport_proto);
559 }
560 tc = listen_session_get_transport (s);
561
562 if (!ip_is_zero (&tc->lcl_ip, 1))
563 {
Florin Corasc97a7392017-11-05 23:07:07 -0800564 memset (&args, 0, sizeof (args));
Florin Coras62333be2017-11-01 18:19:22 -0700565 memset (&lcl_pref, 0, sizeof (lcl_pref));
Florin Coras7999e832017-10-31 01:51:04 -0700566 ip_copy (&lcl_pref.fp_addr, &tc->lcl_ip, is_ip4);
567 lcl_pref.fp_len = is_ip4 ? 32 : 128;
568 lcl_pref.fp_proto = fib_proto;
Florin Coras62333be2017-11-01 18:19:22 -0700569 memset (&rmt_pref, 0, sizeof (rmt_pref));
Florin Coras7999e832017-10-31 01:51:04 -0700570 rmt_pref.fp_len = 0;
571 rmt_pref.fp_proto = fib_proto;
572
573 args.table_args.lcl = lcl_pref;
574 args.table_args.rmt = rmt_pref;
575 args.table_args.lcl_port = 0;
576 args.table_args.rmt_port = 0;
577 args.table_args.action_index = app->index;
578 args.table_args.is_add = is_start;
Florin Corasc97a7392017-11-05 23:07:07 -0800579 args.transport_proto = transport_proto;
Florin Coras7999e832017-10-31 01:51:04 -0700580 args.appns_index = app->ns_index;
581 args.scope = SESSION_RULE_SCOPE_GLOBAL;
582 return vnet_session_rule_add_del (&args);
583 }
584 return 0;
585}
586
587void
588application_start_stop_proxy (application_t * app, u8 transport_proto,
589 u8 is_start)
590{
591 session_rule_add_del_args_t args;
592
593 if (application_has_local_scope (app))
594 {
595 memset (&args, 0, sizeof (args));
596 args.table_args.lcl.fp_proto = FIB_PROTOCOL_IP4;
597 args.table_args.rmt.fp_proto = FIB_PROTOCOL_IP4;
598 args.table_args.lcl_port = 0;
599 args.table_args.rmt_port = 0;
600 args.table_args.action_index = app->index;
601 args.table_args.is_add = is_start;
Florin Corasc97a7392017-11-05 23:07:07 -0800602 args.transport_proto = transport_proto;
Florin Coras7999e832017-10-31 01:51:04 -0700603 args.appns_index = app->ns_index;
604 args.scope = SESSION_RULE_SCOPE_LOCAL;
605 vnet_session_rule_add_del (&args);
606
607 args.table_args.lcl.fp_proto = FIB_PROTOCOL_IP6;
608 args.table_args.rmt.fp_proto = FIB_PROTOCOL_IP6;
609 vnet_session_rule_add_del (&args);
610 }
611
612 if (application_has_global_scope (app))
613 {
614 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP4,
615 transport_proto, is_start);
616 application_start_stop_proxy_fib_proto (app, FIB_PROTOCOL_IP6,
617 transport_proto, is_start);
618 }
619}
620
621void
622application_setup_proxy (application_t * app)
623{
624 u16 transports = app->proxied_transports;
625 ASSERT (application_is_proxy (app));
626 if (application_is_builtin (app))
627 return;
628 if (transports & (1 << TRANSPORT_PROTO_TCP))
629 application_start_stop_proxy (app, TRANSPORT_PROTO_TCP, 1);
630 if (transports & (1 << TRANSPORT_PROTO_UDP))
631 application_start_stop_proxy (app, TRANSPORT_PROTO_UDP, 1);
632}
633
634void
635application_remove_proxy (application_t * app)
636{
637 u16 transports = app->proxied_transports;
638 ASSERT (application_is_proxy (app));
639 if (transports & (1 << TRANSPORT_PROTO_TCP))
640 application_start_stop_proxy (app, TRANSPORT_PROTO_TCP, 0);
641 if (transports & (1 << TRANSPORT_PROTO_UDP))
642 application_start_stop_proxy (app, TRANSPORT_PROTO_UDP, 0);
643}
644
Dave Barach68b0fb02017-02-28 15:15:56 -0500645u8 *
Florin Coras6cf30ad2017-04-04 23:08:23 -0700646format_application_listener (u8 * s, va_list * args)
Dave Barach68b0fb02017-02-28 15:15:56 -0500647{
Florin Coras6cf30ad2017-04-04 23:08:23 -0700648 application_t *app = va_arg (*args, application_t *);
649 u64 handle = va_arg (*args, u64);
650 u32 index = va_arg (*args, u32);
Dave Barach68b0fb02017-02-28 15:15:56 -0500651 int verbose = va_arg (*args, int);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700652 stream_session_t *listener;
653 u8 *app_name, *str;
Dave Barach68b0fb02017-02-28 15:15:56 -0500654
Florin Coras6cf30ad2017-04-04 23:08:23 -0700655 if (app == 0)
Dave Barach68b0fb02017-02-28 15:15:56 -0500656 {
657 if (verbose)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700658 s = format (s, "%-40s%-20s%-15s%-15s%-10s", "Connection", "App",
659 "API Client", "ListenerID", "SegManager");
Dave Barach68b0fb02017-02-28 15:15:56 -0500660 else
Florin Coras6cf30ad2017-04-04 23:08:23 -0700661 s = format (s, "%-40s%-20s", "Connection", "App");
Dave Barach68b0fb02017-02-28 15:15:56 -0500662
663 return s;
664 }
665
Florin Coras6cf30ad2017-04-04 23:08:23 -0700666 app_name = app_get_name_from_reg_index (app);
667 listener = listen_session_get_from_handle (handle);
668 str = format (0, "%U", format_stream_session, listener, verbose);
Dave Barach68b0fb02017-02-28 15:15:56 -0500669
Dave Barach68b0fb02017-02-28 15:15:56 -0500670 if (verbose)
671 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700672 s = format (s, "%-40s%-20s%-15u%-15u%-10u", str, app_name,
673 app->api_client_index, handle, index);
Dave Barach68b0fb02017-02-28 15:15:56 -0500674 }
675 else
Florin Coras6cf30ad2017-04-04 23:08:23 -0700676 s = format (s, "%-40s%-20s", str, app_name);
677
678 vec_free (app_name);
679 return s;
680}
681
682void
683application_format_connects (application_t * app, int verbose)
684{
685 vlib_main_t *vm = vlib_get_main ();
686 segment_manager_t *sm;
687 u8 *app_name, *s = 0;
Dave Barach10d8cc62017-05-30 09:30:07 -0400688 int j;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700689
690 /* Header */
691 if (app == 0)
692 {
693 if (verbose)
694 vlib_cli_output (vm, "%-40s%-20s%-15s%-10s", "Connection", "App",
695 "API Client", "SegManager");
696 else
697 vlib_cli_output (vm, "%-40s%-20s", "Connection", "App");
698 return;
699 }
700
701 /* make sure */
702 if (app->connects_seg_manager == (u32) ~ 0)
703 return;
704
705 app_name = app_get_name_from_reg_index (app);
706
707 /* Across all fifo segments */
708 sm = segment_manager_get (app->connects_seg_manager);
709 for (j = 0; j < vec_len (sm->segment_indices); j++)
710 {
711 svm_fifo_segment_private_t *fifo_segment;
Dave Barach10d8cc62017-05-30 09:30:07 -0400712 svm_fifo_t *fifo;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700713 u8 *str;
714
Florin Corasc87c91d2017-08-16 19:55:49 -0700715 fifo_segment = svm_fifo_segment_get_segment (sm->segment_indices[j]);
Dave Barach10d8cc62017-05-30 09:30:07 -0400716 fifo = svm_fifo_segment_get_fifo_list (fifo_segment);
717 while (fifo)
Florin Coras6cf30ad2017-04-04 23:08:23 -0700718 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700719 u32 session_index, thread_index;
720 stream_session_t *session;
721
Florin Corasa5464812017-04-19 13:00:05 -0700722 session_index = fifo->master_session_index;
723 thread_index = fifo->master_thread_index;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700724
Florin Corascea194d2017-10-02 00:18:51 -0700725 session = session_get (session_index, thread_index);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700726 str = format (0, "%U", format_stream_session, session, verbose);
727
728 if (verbose)
729 s = format (s, "%-40s%-20s%-15u%-10u", str, app_name,
730 app->api_client_index, app->connects_seg_manager);
731 else
732 s = format (s, "%-40s%-20s", str, app_name);
733
734 vlib_cli_output (vm, "%v", s);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700735 vec_reset_length (s);
736 vec_free (str);
Dave Barach10d8cc62017-05-30 09:30:07 -0400737
738 fifo = fifo->next;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700739 }
740 vec_free (s);
741 }
742
743 vec_free (app_name);
744}
745
746u8 *
747format_application (u8 * s, va_list * args)
748{
749 application_t *app = va_arg (*args, application_t *);
750 CLIB_UNUSED (int verbose) = va_arg (*args, int);
Florin Corasad0c77f2017-11-09 18:00:15 -0800751 segment_manager_properties_t *props;
Florin Corascea194d2017-10-02 00:18:51 -0700752 const u8 *app_ns_name;
Florin Coras6cf30ad2017-04-04 23:08:23 -0700753 u8 *app_name;
754
755 if (app == 0)
756 {
757 if (verbose)
Florin Corascea194d2017-10-02 00:18:51 -0700758 s = format (s, "%-10s%-20s%-15s%-15s%-15s%-15s%-15s", "Index", "Name",
759 "Namespace", "API Client", "Add seg size", "Rx fifo size",
Florin Coras6cf30ad2017-04-04 23:08:23 -0700760 "Tx fifo size");
761 else
Florin Corascea194d2017-10-02 00:18:51 -0700762 s =
763 format (s, "%-10s%-20s%-15s%-20s", "Index", "Name", "Namespace",
764 "API Client");
Florin Coras6cf30ad2017-04-04 23:08:23 -0700765 return s;
766 }
767
768 app_name = app_get_name_from_reg_index (app);
Florin Corascea194d2017-10-02 00:18:51 -0700769 app_ns_name = app_namespace_id_from_index (app->ns_index);
Florin Corasad0c77f2017-11-09 18:00:15 -0800770 props = segment_manager_properties_get (app->sm_properties);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700771 if (verbose)
Florin Corascea194d2017-10-02 00:18:51 -0700772 s =
773 format (s, "%-10d%-20s%-15s%-15d%-15d%-15d%-15d", app->index, app_name,
774 app_ns_name, app->api_client_index,
Florin Corasad0c77f2017-11-09 18:00:15 -0800775 props->add_segment_size,
776 props->rx_fifo_size, props->tx_fifo_size);
Florin Coras6cf30ad2017-04-04 23:08:23 -0700777 else
Florin Corascea194d2017-10-02 00:18:51 -0700778 s = format (s, "%-10d%-20s%-15s%-20d", app->index, app_name, app_ns_name,
Florin Coras6cf30ad2017-04-04 23:08:23 -0700779 app->api_client_index);
Dave Barach68b0fb02017-02-28 15:15:56 -0500780 return s;
781}
782
783static clib_error_t *
784show_app_command_fn (vlib_main_t * vm, unformat_input_t * input,
785 vlib_cli_command_t * cmd)
786{
787 application_t *app;
788 int do_server = 0;
789 int do_client = 0;
790 int verbose = 0;
791
Florin Corascea194d2017-10-02 00:18:51 -0700792 session_cli_return_if_not_enabled ();
Florin Corase04c2992017-03-01 08:17:34 -0800793
Dave Barach68b0fb02017-02-28 15:15:56 -0500794 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
795 {
796 if (unformat (input, "server"))
797 do_server = 1;
798 else if (unformat (input, "client"))
799 do_client = 1;
800 else if (unformat (input, "verbose"))
801 verbose = 1;
802 else
803 break;
804 }
805
806 if (do_server)
807 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700808 u64 handle;
809 u32 index;
Dave Barach68b0fb02017-02-28 15:15:56 -0500810 if (pool_elts (app_pool))
811 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700812 vlib_cli_output (vm, "%U", format_application_listener,
813 0 /* header */ , 0, 0,
Dave Barach68b0fb02017-02-28 15:15:56 -0500814 verbose);
Florin Coras1c710452017-10-17 00:03:13 -0700815 /* *INDENT-OFF* */
Dave Barach68b0fb02017-02-28 15:15:56 -0500816 pool_foreach (app, app_pool,
817 ({
Florin Coras6cf30ad2017-04-04 23:08:23 -0700818 /* App's listener sessions */
819 if (hash_elts (app->listeners_table) == 0)
820 continue;
821 hash_foreach (handle, index, app->listeners_table,
822 ({
823 vlib_cli_output (vm, "%U", format_application_listener, app,
824 handle, index, verbose);
825 }));
Dave Barach68b0fb02017-02-28 15:15:56 -0500826 }));
827 /* *INDENT-ON* */
828 }
829 else
830 vlib_cli_output (vm, "No active server bindings");
831 }
832
833 if (do_client)
834 {
835 if (pool_elts (app_pool))
836 {
Florin Coras6cf30ad2017-04-04 23:08:23 -0700837 application_format_connects (0, verbose);
838
Dave Barach68b0fb02017-02-28 15:15:56 -0500839 /* *INDENT-OFF* */
840 pool_foreach (app, app_pool,
841 ({
Florin Coras6cf30ad2017-04-04 23:08:23 -0700842 if (app->connects_seg_manager == (u32)~0)
843 continue;
844 application_format_connects (app, verbose);
Dave Barach68b0fb02017-02-28 15:15:56 -0500845 }));
846 /* *INDENT-ON* */
847 }
848 else
Florin Corase04c2992017-03-01 08:17:34 -0800849 vlib_cli_output (vm, "No active client bindings");
Dave Barach68b0fb02017-02-28 15:15:56 -0500850 }
851
Florin Coras6cf30ad2017-04-04 23:08:23 -0700852 /* Print app related info */
853 if (!do_server && !do_client)
854 {
855 vlib_cli_output (vm, "%U", format_application, 0, verbose);
Florin Corascea194d2017-10-02 00:18:51 -0700856 /* *INDENT-OFF* */
857 pool_foreach (app, app_pool, ({
858 vlib_cli_output (vm, "%U", format_application, app, verbose);
859 }));
860 /* *INDENT-ON* */
Florin Coras6cf30ad2017-04-04 23:08:23 -0700861 }
862
Dave Barach68b0fb02017-02-28 15:15:56 -0500863 return 0;
864}
865
Florin Corase04c2992017-03-01 08:17:34 -0800866/* *INDENT-OFF* */
Dave Barach68b0fb02017-02-28 15:15:56 -0500867VLIB_CLI_COMMAND (show_app_command, static) =
868{
Florin Corase04c2992017-03-01 08:17:34 -0800869 .path = "show app",
870 .short_help = "show app [server|client] [verbose]",
871 .function = show_app_command_fn,
872};
873/* *INDENT-ON* */
Dave Barach68b0fb02017-02-28 15:15:56 -0500874
875/*
876 * fd.io coding-style-patch-verification: ON
877 *
878 * Local Variables:
879 * eval: (c-set-style "gnu")
880 * End:
881 */