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>
20 #include <vnet/fib/ip4_fib.h>
23 VPP's application/session API bind/unbind/connect/disconnect calls
27 ip_is_zero (ip46_address_t * ip46_address, u8 is_ip4)
30 return (ip46_address->ip4.as_u32 == 0);
32 return (ip46_address->as_u64[0] == 0 && ip46_address->as_u64[1] == 0);
36 ip_is_local (ip46_address_t * ip46_address, u8 is_ip4)
39 fib_entry_flag_t flags;
42 /* Check if requester is local */
46 prefix.fp_proto = FIB_PROTOCOL_IP4;
51 prefix.fp_proto = FIB_PROTOCOL_IP6;
54 clib_memcpy (&prefix.fp_addr, ip46_address, sizeof (ip46_address_t));
55 fei = fib_table_lookup (0, &prefix);
56 flags = fib_entry_get_flags (fei);
58 return (flags & FIB_ENTRY_FLAG_LOCAL);
62 api_parse_session_handle (u64 handle, u32 * session_index, u32 * thread_index)
64 session_manager_main_t *smm = vnet_get_session_manager_main ();
65 stream_session_t *pool;
67 *thread_index = handle & 0xFFFFFFFF;
68 *session_index = handle >> 32;
70 if (*thread_index >= vec_len (smm->sessions))
71 return VNET_API_ERROR_INVALID_VALUE;
73 pool = smm->sessions[*thread_index];
75 if (pool_is_free_index (pool, *session_index))
76 return VNET_API_ERROR_INVALID_VALUE_2;
82 vnet_bind_i (u32 app_index, session_type_t sst,
83 transport_endpoint_t * tep, u64 * handle)
86 stream_session_t *listener;
88 app = application_get_if_valid (app_index);
91 clib_warning ("app not attached");
92 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
95 listener = stream_session_lookup_listener (&tep->ip,
96 clib_host_to_net_u16 (tep->port),
99 return VNET_API_ERROR_ADDRESS_IN_USE;
101 if (!ip_is_zero (&tep->ip, tep->is_ip4)
102 && !ip_is_local (&tep->ip, tep->is_ip4))
103 return VNET_API_ERROR_INVALID_VALUE_2;
105 /* Setup listen path down to transport */
106 return application_start_listen (app, sst, tep, handle);
110 vnet_unbind_i (u32 app_index, u64 handle)
112 application_t *app = application_get_if_valid (app_index);
116 clib_warning ("app not attached");
117 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
120 /* Clear the listener */
121 return application_stop_listen (app, handle);
125 vnet_connect_i (u32 app_index, u32 api_context, session_type_t sst,
126 transport_endpoint_t * tep, void *mp)
128 stream_session_t *listener;
129 application_t *server, *app;
132 * Figure out if connecting to a local server
134 listener = stream_session_lookup_listener (&tep->ip,
135 clib_host_to_net_u16 (tep->port),
139 server = application_get (listener->app_index);
142 * Server is willing to have a direct fifo connection created
143 * instead of going through the state machine, etc.
145 if (server->flags & APP_OPTIONS_FLAGS_USE_FIFO)
146 return server->cb_fns.
147 redirect_connect_callback (server->api_client_index, mp);
151 * Not connecting to a local server. Create regular session
153 app = application_get (app_index);
154 return application_open_session (app, sst, tep, api_context);
158 * unformat a vnet URI
161 * tcp://ip46-addr:port
162 * udp://ip46-addr:port
164 * u8 ip46_address[16];
165 * u16 port_in_host_byte_order;
166 * stream_session_type_t sst;
169 * if (unformat (input, "%U", unformat_vnet_uri, &ip46_address,
170 * &sst, &port, &fifo_name))
175 unformat_vnet_uri (unformat_input_t * input, va_list * args)
177 session_type_t *sst = va_arg (*args, session_type_t *);
178 transport_endpoint_t *tep = va_arg (*args, transport_endpoint_t *);
180 if (unformat (input, "tcp://%U/%d", unformat_ip4_address, &tep->ip.ip4,
183 *sst = SESSION_TYPE_IP4_TCP;
187 if (unformat (input, "udp://%U/%d", unformat_ip4_address, &tep->ip.ip4,
190 *sst = SESSION_TYPE_IP4_UDP;
194 if (unformat (input, "udp://%U/%d", unformat_ip6_address, &tep->ip.ip6,
197 *sst = SESSION_TYPE_IP6_UDP;
200 if (unformat (input, "tcp://%U/%d", unformat_ip6_address, &tep->ip.ip6,
203 *sst = SESSION_TYPE_IP6_TCP;
211 parse_uri (char *uri, session_type_t * sst, transport_endpoint_t * tep)
213 unformat_input_t _input, *input = &_input;
216 uri = (char *) format (0, "%s%c", uri, 0);
219 unformat_init_string (input, uri, strlen (uri));
220 if (!unformat (input, "%U", unformat_vnet_uri, sst, tep))
222 unformat_free (input);
223 return VNET_API_ERROR_INVALID_VALUE;
225 unformat_free (input);
231 * Attaches application.
233 * Allocates a vpp app, i.e., a structure that keeps back pointers
234 * to external app and a segment manager for shared memory fifo based
235 * communication with the external app.
238 vnet_application_attach (vnet_app_attach_args_t * a)
240 application_t *app = 0;
241 segment_manager_t *sm;
245 app = application_new ();
246 if ((rv = application_init (app, a->api_client_index, a->options,
250 a->app_event_queue_address = (u64) app->event_queue;
251 sm = segment_manager_get (app->first_segment_manager);
252 segment_manager_get_segment_info (sm->segment_indices[0],
253 &seg_name, &a->segment_size);
255 a->segment_name_length = vec_len (seg_name);
256 a->segment_name = seg_name;
257 ASSERT (vec_len (a->segment_name) <= 128);
258 a->app_index = app->index;
263 vnet_application_detach (vnet_app_detach_args_t * a)
266 app = application_get_if_valid (a->app_index);
270 clib_warning ("app not attached");
271 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
274 application_del (app);
279 session_type_from_proto_and_ip (session_api_proto_t proto, u8 is_ip4)
281 if (proto == SESSION_PROTO_TCP)
284 return SESSION_TYPE_IP4_TCP;
286 return SESSION_TYPE_IP6_TCP;
291 return SESSION_TYPE_IP4_UDP;
293 return SESSION_TYPE_IP6_UDP;
296 return SESSION_N_TYPES;
300 vnet_bind_uri (vnet_bind_args_t * a)
302 session_type_t sst = SESSION_N_TYPES;
303 transport_endpoint_t tep;
306 memset (&tep, 0, sizeof (tep));
307 rv = parse_uri (a->uri, &sst, &tep);
311 if ((rv = vnet_bind_i (a->app_index, sst, &tep, &a->handle)))
318 vnet_unbind_uri (vnet_unbind_args_t * a)
320 session_type_t sst = SESSION_N_TYPES;
321 stream_session_t *listener;
322 transport_endpoint_t tep;
325 rv = parse_uri (a->uri, &sst, &tep);
329 listener = stream_session_lookup_listener (&tep.ip,
330 clib_host_to_net_u16 (tep.port),
333 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
335 return vnet_unbind_i (a->app_index, listen_session_get_handle (listener));
339 vnet_connect_uri (vnet_connect_args_t * a)
341 transport_endpoint_t tep;
346 memset (&tep, 0, sizeof (tep));
347 rv = parse_uri (a->uri, &sst, &tep);
351 return vnet_connect_i (a->app_index, a->api_context, sst, &tep, a->mp);
355 vnet_disconnect_session (vnet_disconnect_args_t * a)
357 u32 index, thread_index;
360 stream_session_parse_handle (a->handle, &index, &thread_index);
361 s = stream_session_get_if_valid (index, thread_index);
363 if (!s || s->app_index != a->app_index)
364 return VNET_API_ERROR_INVALID_VALUE;
366 /* We're peeking into another's thread pool. Make sure */
367 ASSERT (s->session_index == index);
369 session_send_session_evt_to_thread (a->handle, FIFO_EVENT_DISCONNECT,
375 vnet_bind (vnet_bind_args_t * a)
377 session_type_t sst = SESSION_N_TYPES;
380 sst = session_type_from_proto_and_ip (a->proto, a->tep.is_ip4);
381 if ((rv = vnet_bind_i (a->app_index, sst, &a->tep, &a->handle)))
388 vnet_unbind (vnet_unbind_args_t * a)
390 return vnet_unbind_i (a->app_index, a->handle);
394 vnet_connect (vnet_connect_args_t * a)
398 sst = session_type_from_proto_and_ip (a->proto, a->tep.is_ip4);
399 return vnet_connect_i (a->app_index, a->api_context, sst, &a->tep, a->mp);
403 * fd.io coding-style-patch-verification: ON
406 * eval: (c-set-style "gnu")