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, tep->port, sst);
97 return VNET_API_ERROR_ADDRESS_IN_USE;
99 if (!ip_is_zero (&tep->ip, tep->is_ip4)
100 && !ip_is_local (&tep->ip, tep->is_ip4))
101 return VNET_API_ERROR_INVALID_VALUE_2;
103 /* Setup listen path down to transport */
104 return application_start_listen (app, sst, tep, handle);
108 vnet_unbind_i (u32 app_index, u64 handle)
110 application_t *app = application_get_if_valid (app_index);
114 clib_warning ("app (%d) not attached", app_index);
115 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
118 /* Clear the listener */
119 return application_stop_listen (app, handle);
123 vnet_connect_i (u32 app_index, u32 api_context, session_type_t sst,
124 transport_endpoint_t * tep, void *mp)
126 stream_session_t *listener;
127 application_t *server, *app;
130 * Figure out if connecting to a local server
132 listener = stream_session_lookup_listener (&tep->ip, tep->port, sst);
135 server = application_get (listener->app_index);
138 * Server is willing to have a direct fifo connection created
139 * instead of going through the state machine, etc.
141 if (server->flags & APP_OPTIONS_FLAGS_USE_FIFO)
142 return server->cb_fns.
143 redirect_connect_callback (server->api_client_index, mp);
147 * Not connecting to a local server. Create regular session
149 app = application_get (app_index);
150 return application_open_session (app, sst, tep, api_context);
154 * unformat a vnet URI
157 * tcp://ip46-addr:port
158 * udp://ip46-addr:port
160 * u8 ip46_address[16];
161 * u16 port_in_host_byte_order;
162 * stream_session_type_t sst;
165 * if (unformat (input, "%U", unformat_vnet_uri, &ip46_address,
166 * &sst, &port, &fifo_name))
171 unformat_vnet_uri (unformat_input_t * input, va_list * args)
173 session_type_t *sst = va_arg (*args, session_type_t *);
174 transport_endpoint_t *tep = va_arg (*args, transport_endpoint_t *);
176 if (unformat (input, "tcp://%U/%d", unformat_ip4_address, &tep->ip.ip4,
179 *sst = SESSION_TYPE_IP4_TCP;
180 tep->port = clib_host_to_net_u16 (tep->port);
184 if (unformat (input, "udp://%U/%d", unformat_ip4_address, &tep->ip.ip4,
187 *sst = SESSION_TYPE_IP4_UDP;
188 tep->port = clib_host_to_net_u16 (tep->port);
192 if (unformat (input, "udp://%U/%d", unformat_ip6_address, &tep->ip.ip6,
195 *sst = SESSION_TYPE_IP6_UDP;
196 tep->port = clib_host_to_net_u16 (tep->port);
199 if (unformat (input, "tcp://%U/%d", unformat_ip6_address, &tep->ip.ip6,
202 *sst = SESSION_TYPE_IP6_TCP;
203 tep->port = clib_host_to_net_u16 (tep->port);
210 static u8 *cache_uri;
211 static session_type_t cache_sst;
212 static transport_endpoint_t *cache_tep;
215 parse_uri (char *uri, session_type_t * sst, transport_endpoint_t * tep)
217 unformat_input_t _input, *input = &_input;
219 if (cache_uri && !strncmp (uri, (char *) cache_uri, vec_len (cache_uri)))
227 uri = (char *) format (0, "%s%c", uri, 0);
230 unformat_init_string (input, uri, strlen (uri));
231 if (!unformat (input, "%U", unformat_vnet_uri, sst, tep))
233 unformat_free (input);
234 return VNET_API_ERROR_INVALID_VALUE;
236 unformat_free (input);
238 vec_free (cache_uri);
239 cache_uri = (u8 *) uri;
242 clib_mem_free (cache_tep);
243 cache_tep = clib_mem_alloc (sizeof (*tep));
250 * Attaches application.
252 * Allocates a vpp app, i.e., a structure that keeps back pointers
253 * to external app and a segment manager for shared memory fifo based
254 * communication with the external app.
257 vnet_application_attach (vnet_app_attach_args_t * a)
259 application_t *app = 0;
260 segment_manager_t *sm;
264 app = application_new ();
265 if ((rv = application_init (app, a->api_client_index, a->options,
269 a->app_event_queue_address = pointer_to_uword (app->event_queue);
270 sm = segment_manager_get (app->first_segment_manager);
271 segment_manager_get_segment_info (sm->segment_indices[0],
272 &seg_name, &a->segment_size);
274 a->segment_name_length = vec_len (seg_name);
275 a->segment_name = seg_name;
276 ASSERT (vec_len (a->segment_name) <= 128);
277 a->app_index = app->index;
282 vnet_application_detach (vnet_app_detach_args_t * a)
285 app = application_get_if_valid (a->app_index);
289 clib_warning ("app not attached");
290 return VNET_API_ERROR_APPLICATION_NOT_ATTACHED;
293 application_del (app);
298 vnet_bind_uri (vnet_bind_args_t * a)
300 session_type_t sst = SESSION_N_TYPES;
301 transport_endpoint_t tep;
304 memset (&tep, 0, sizeof (tep));
305 rv = parse_uri (a->uri, &sst, &tep);
309 if ((rv = vnet_bind_i (a->app_index, sst, &tep, &a->handle)))
316 vnet_unbind_uri (vnet_unbind_args_t * a)
318 session_type_t sst = SESSION_N_TYPES;
319 stream_session_t *listener;
320 transport_endpoint_t tep;
323 rv = parse_uri (a->uri, &sst, &tep);
327 listener = stream_session_lookup_listener (&tep.ip,
328 clib_host_to_net_u16 (tep.port),
331 return VNET_API_ERROR_ADDRESS_NOT_IN_USE;
333 return vnet_unbind_i (a->app_index, listen_session_get_handle (listener));
337 vnet_connect_uri (vnet_connect_args_t * a)
339 transport_endpoint_t tep;
344 memset (&tep, 0, sizeof (tep));
345 rv = parse_uri (a->uri, &sst, &tep);
349 return vnet_connect_i (a->app_index, a->api_context, sst, &tep, a->mp);
353 vnet_disconnect_session (vnet_disconnect_args_t * a)
355 u32 index, thread_index;
358 stream_session_parse_handle (a->handle, &index, &thread_index);
359 s = stream_session_get_if_valid (index, thread_index);
361 if (!s || s->app_index != a->app_index)
362 return VNET_API_ERROR_INVALID_VALUE;
364 /* We're peeking into another's thread pool. Make sure */
365 ASSERT (s->session_index == index);
367 session_send_session_evt_to_thread (a->handle, FIFO_EVENT_DISCONNECT,
373 vnet_bind (vnet_bind_args_t * a)
375 session_type_t sst = SESSION_N_TYPES;
378 sst = session_type_from_proto_and_ip (a->proto, a->tep.is_ip4);
379 if ((rv = vnet_bind_i (a->app_index, sst, &a->tep, &a->handle)))
386 vnet_unbind (vnet_unbind_args_t * a)
388 return vnet_unbind_i (a->app_index, a->handle);
392 vnet_connect (vnet_connect_args_t * a)
396 sst = session_type_from_proto_and_ip (a->proto, a->tep.is_ip4);
397 return vnet_connect_i (a->app_index, a->api_context, sst, &a->tep, a->mp);
401 * fd.io coding-style-patch-verification: ON
404 * eval: (c-set-style "gnu")