2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #include <vnet/session/application_interface.h>
17 #include <vnet/session/session.h>
18 #include <vlibmemory/api.h>
19 #include <vnet/dpo/load_balance.h>
22 VPP's application/session API bind/unbind/connect/disconnect calls
26 session_endpoint_is_local (session_endpoint_t * sep)
28 return (ip_is_zero (&sep->ip, sep->is_ip4)
29 || ip_is_local_host (&sep->ip, sep->is_ip4));
33 session_endpoint_is_zero (session_endpoint_t * sep)
35 return ip_is_zero (&sep->ip, sep->is_ip4);
39 session_endpoint_in_ns (session_endpoint_t * sep)
41 u8 is_zero = ip_is_zero (&sep->ip, sep->is_ip4);
42 if (!is_zero && sep->sw_if_index != ENDPOINT_INVALID_INDEX
43 && !ip_interface_has_address (sep->sw_if_index, &sep->ip, sep->is_ip4))
45 clib_warning ("sw_if_index %u not configured with ip %U",
46 sep->sw_if_index, format_ip46_address, &sep->ip,
50 return (is_zero || ip_is_local (sep->fib_index, &sep->ip, sep->is_ip4));
54 api_parse_session_handle (u64 handle, u32 * session_index, u32 * thread_index)
56 session_manager_main_t *smm = vnet_get_session_manager_main ();
57 stream_session_t *pool;
59 *thread_index = handle & 0xFFFFFFFF;
60 *session_index = handle >> 32;
62 if (*thread_index >= vec_len (smm->sessions))
63 return VNET_API_ERROR_INVALID_VALUE;
65 pool = smm->sessions[*thread_index];
67 if (pool_is_free_index (pool, *session_index))
68 return VNET_API_ERROR_INVALID_VALUE_2;
74 session_endpoint_update_for_app (session_endpoint_t * sep,
77 app_namespace_t *app_ns;
78 app_ns = app_namespace_get (app->ns_index);
81 /* Ask transport and network to bind to/connect using local interface
82 * that "supports" app's namespace. This will fix our local connection
85 sep->sw_if_index = app_ns->sw_if_index;
87 sep->is_ip4 ? app_ns->ip4_fib_index : app_ns->ip6_fib_index;
92 vnet_bind_i (u32 app_index, session_endpoint_t * sep, u64 * handle)
95 u32 table_index, listener_index;
96 int rv, have_local = 0;
98 app = application_get_if_valid (app_index);
101 SESSION_DBG ("app not attached");
102 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
105 session_endpoint_update_for_app (sep, app);
106 if (!session_endpoint_in_ns (sep))
107 return VNET_API_ERROR_INVALID_VALUE_2;
109 table_index = application_session_table (app,
110 session_endpoint_fib_proto (sep));
111 listener_index = session_lookup_session_endpoint (table_index, sep);
112 if (listener_index != SESSION_INVALID_INDEX)
113 return VNET_API_ERROR_ADDRESS_IN_USE;
116 * Add session endpoint to local session table. Only binds to "inaddr_any"
117 * (i.e., zero address) are added to local scope table.
119 if (application_has_local_scope (app) && session_endpoint_is_zero (sep))
121 table_index = application_local_session_table (app);
122 listener_index = session_lookup_session_endpoint (table_index, sep);
123 if (listener_index != SESSION_INVALID_INDEX)
124 return VNET_API_ERROR_ADDRESS_IN_USE;
125 session_lookup_add_session_endpoint (table_index, sep, app->index);
126 *handle = session_lookup_local_listener_make_handle (sep);
130 if (!application_has_global_scope (app))
131 return (have_local - 1);
134 * Add session endpoint to global session table
137 /* Setup listen path down to transport */
138 rv = application_start_listen (app, sep, handle);
139 if (rv && have_local)
140 session_lookup_del_session_endpoint (table_index, sep);
145 vnet_unbind_i (u32 app_index, u64 handle)
147 application_t *app = application_get_if_valid (app_index);
148 stream_session_t *listener = 0;
153 SESSION_DBG ("app (%d) not attached", app_index);
154 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
158 * Clean up local session table. If we have a listener session use it to
159 * find the port and proto. If not, the handle must be a local table handle
163 if (application_has_local_scope (app))
165 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
166 if (!session_lookup_local_is_handle (handle))
167 listener = listen_session_get_from_handle (handle);
170 if (listen_session_get_local_session_endpoint (listener, &sep))
172 clib_warning ("broken listener");
178 if (session_lookup_local_listener_parse_handle (handle, &sep))
180 clib_warning ("can't parse handle");
184 table_index = application_local_session_table (app);
185 session_lookup_del_session_endpoint (table_index, &sep);
189 * Clear the global scope table of the listener
191 if (application_has_global_scope (app))
192 return application_stop_listen (app, handle);
197 app_connect_redirect (application_t * server, void *mp)
199 return server->cb_fns.redirect_connect_callback (server->api_client_index,
204 vnet_connect_i (u32 app_index, u32 api_context, session_endpoint_t * sep,
207 application_t *server, *app;
210 if (session_endpoint_is_zero (sep))
211 return VNET_API_ERROR_INVALID_VALUE;
213 app = application_get (app_index);
214 session_endpoint_update_for_app (sep, app);
217 * First check the the local scope for locally attached destinations.
218 * If we have local scope, we pass *all* connects through it since we may
219 * have special policy rules even for non-local destinations, think proxy.
221 if (application_has_local_scope (app))
223 table_index = application_local_session_table (app);
224 app_index = session_lookup_local_session_endpoint (table_index, sep);
225 server = application_get (app_index);
227 * Server is willing to have a direct fifo connection created
228 * instead of going through the state machine, etc.
230 if (server && (server->flags & APP_OPTIONS_FLAGS_ACCEPT_REDIRECT))
231 return app_connect_redirect (server, mp);
235 * If nothing found, check the global scope for locally attached
236 * destinations. Make sure first that we're allowed to.
238 if (session_endpoint_is_local (sep))
239 return VNET_API_ERROR_SESSION_CONNECT;
241 if (!application_has_global_scope (app))
242 return VNET_API_ERROR_APP_CONNECT_SCOPE;
244 table_index = application_session_table (app,
245 session_endpoint_fib_proto (sep));
246 app_index = session_lookup_session_endpoint (table_index, sep);
247 server = application_get (app_index);
248 if (server && (server->flags & APP_OPTIONS_FLAGS_ACCEPT_REDIRECT))
249 return app_connect_redirect (server, mp);
252 * Not connecting to a local server, propagate to transport
254 if (application_open_session (app, sep, api_context))
255 return VNET_API_ERROR_SESSION_CONNECT;
260 * unformat a vnet URI
263 * tcp://ip46-addr:port
264 * udp://ip46-addr:port
266 * u8 ip46_address[16];
267 * u16 port_in_host_byte_order;
268 * stream_session_type_t sst;
271 * if (unformat (input, "%U", unformat_vnet_uri, &ip46_address,
272 * &sst, &port, &fifo_name))
277 unformat_vnet_uri (unformat_input_t * input, va_list * args)
279 session_endpoint_t *sep = va_arg (*args, session_endpoint_t *);
281 if (unformat (input, "tcp://%U/%d", unformat_ip4_address, &sep->ip.ip4,
284 sep->transport_proto = TRANSPORT_PROTO_TCP;
285 sep->port = clib_host_to_net_u16 (sep->port);
289 if (unformat (input, "udp://%U/%d", unformat_ip4_address, &sep->ip.ip4,
292 sep->transport_proto = TRANSPORT_PROTO_UDP;
293 sep->port = clib_host_to_net_u16 (sep->port);
297 if (unformat (input, "udp://%U/%d", unformat_ip6_address, &sep->ip.ip6,
300 sep->transport_proto = TRANSPORT_PROTO_UDP;
301 sep->port = clib_host_to_net_u16 (sep->port);
305 if (unformat (input, "tcp://%U/%d", unformat_ip6_address, &sep->ip.ip6,
308 sep->transport_proto = TRANSPORT_PROTO_TCP;
309 sep->port = clib_host_to_net_u16 (sep->port);
317 static u8 *cache_uri;
318 static session_endpoint_t *cache_sep;
321 parse_uri (char *uri, session_endpoint_t * sep)
323 unformat_input_t _input, *input = &_input;
325 if (cache_uri && !strncmp (uri, (char *) cache_uri, vec_len (cache_uri)))
332 uri = (char *) format (0, "%s%c", uri, 0);
335 unformat_init_string (input, uri, strlen (uri));
336 if (!unformat (input, "%U", unformat_vnet_uri, sep))
338 unformat_free (input);
339 return VNET_API_ERROR_INVALID_VALUE;
341 unformat_free (input);
343 vec_free (cache_uri);
344 cache_uri = (u8 *) uri;
346 clib_mem_free (cache_sep);
347 cache_sep = clib_mem_alloc (sizeof (*sep));
354 session_validate_namespace (u8 * namespace_id, u64 secret, u32 * app_ns_index)
356 app_namespace_t *app_ns;
357 if (vec_len (namespace_id) == 0)
359 /* Use default namespace */
364 *app_ns_index = app_namespace_index_from_id (namespace_id);
365 if (*app_ns_index == APP_NAMESPACE_INVALID_INDEX)
366 return VNET_API_ERROR_APP_INVALID_NS;
367 app_ns = app_namespace_get (*app_ns_index);
369 return VNET_API_ERROR_APP_INVALID_NS;
370 if (app_ns->ns_secret != secret)
371 return VNET_API_ERROR_APP_WRONG_NS_SECRET;
376 * Attach application to vpp
378 * Allocates a vpp app, i.e., a structure that keeps back pointers
379 * to external app and a segment manager for shared memory fifo based
380 * communication with the external app.
383 vnet_application_attach (vnet_app_attach_args_t * a)
385 application_t *app = 0;
386 segment_manager_t *sm;
389 u32 app_ns_index = 0;
392 app = application_lookup (a->api_client_index);
394 return clib_error_return_code (0, VNET_API_ERROR_APP_ALREADY_ATTACHED,
395 0, "app already attached");
397 secret = a->options[APP_OPTIONS_NAMESPACE_SECRET];
398 if ((rv = session_validate_namespace (a->namespace_id, secret,
400 return clib_error_return_code (0, rv, 0, "namespace validation: %d", rv);
401 a->options[APP_OPTIONS_NAMESPACE] = app_ns_index;
402 app = application_new ();
403 if ((rv = application_init (app, a->api_client_index, a->options,
405 return clib_error_return_code (0, rv, 0, "app init: %d", rv);
407 a->app_event_queue_address = pointer_to_uword (app->event_queue);
408 sm = segment_manager_get (app->first_segment_manager);
409 segment_manager_get_segment_info (sm->segment_indices[0],
410 &seg_name, &a->segment_size);
412 a->segment_name_length = vec_len (seg_name);
413 a->segment_name = seg_name;
414 ASSERT (vec_len (a->segment_name) <= 128);
415 a->app_index = app->index;
420 * Detach application from vpp
423 vnet_application_detach (vnet_app_detach_args_t * a)
426 app = application_get_if_valid (a->app_index);
430 clib_warning ("app not attached");
431 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
434 application_del (app);
439 vnet_bind_uri (vnet_bind_args_t * a)
441 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
444 rv = parse_uri (a->uri, &sep);
448 return vnet_bind_i (a->app_index, &sep, &a->handle);
452 vnet_unbind_uri (vnet_unbind_args_t * a)
454 stream_session_t *listener;
455 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
458 rv = parse_uri (a->uri, &sep);
462 /* NOTE: only default table supported for uri */
463 listener = session_lookup_listener (0, &sep);
465 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
467 return vnet_unbind_i (a->app_index, listen_session_get_handle (listener));
471 vnet_connect_uri (vnet_connect_args_t * a)
473 session_endpoint_t sep = SESSION_ENDPOINT_NULL;
477 rv = parse_uri (a->uri, &sep);
479 return clib_error_return_code (0, rv, 0, "app init: %d", rv);
480 if ((rv = vnet_connect_i (a->app_index, a->api_context, &sep, a->mp)))
481 return clib_error_return_code (0, rv, 0, "connect failed");
486 vnet_disconnect_session (vnet_disconnect_args_t * a)
488 u32 index, thread_index;
491 session_parse_handle (a->handle, &index, &thread_index);
492 s = stream_session_get_if_valid (index, thread_index);
494 if (!s || s->app_index != a->app_index)
495 return VNET_API_ERROR_INVALID_VALUE;
497 /* We're peeking into another's thread pool. Make sure */
498 ASSERT (s->session_index == index);
500 session_send_session_evt_to_thread (a->handle, FIFO_EVENT_DISCONNECT,
506 vnet_bind (vnet_bind_args_t * a)
509 if ((rv = vnet_bind_i (a->app_index, &a->sep, &a->handle)))
510 return clib_error_return_code (0, rv, 0, "bind failed");
515 vnet_unbind (vnet_unbind_args_t * a)
518 if ((rv = vnet_unbind_i (a->app_index, a->handle)))
519 return clib_error_return_code (0, rv, 0, "unbind failed");
524 vnet_connect (vnet_connect_args_t * a)
527 if ((rv = vnet_connect_i (a->app_index, a->api_context, &a->sep, a->mp)))
528 return clib_error_return_code (0, rv, 0, "connect failed");
533 * fd.io coding-style-patch-verification: ON
536 * eval: (c-set-style "gnu")