2 * Copyright (c) 2015-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:
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.
16 #include <vnet/vnet.h>
17 #include <vlibmemory/api.h>
18 #include <vnet/session/application.h>
19 #include <vnet/session/application_interface.h>
20 #include <vnet/session-apps/proxy.h>
22 proxy_main_t proxy_main;
29 } proxy_connect_args_t;
32 proxy_cb_fn (void *data, u32 data_len)
34 proxy_connect_args_t *pa = (proxy_connect_args_t *) data;
35 vnet_connect_args_t a;
37 a.api_context = pa->api_context;
38 a.app_index = pa->app_index;
40 vnet_connect_uri (&a);
44 proxy_call_main_thread (vnet_connect_args_t * a)
46 if (vlib_get_thread_index () == 0)
52 proxy_connect_args_t args;
53 args.api_context = a->api_context;
54 args.app_index = a->app_index;
55 clib_memcpy (args.uri, a->uri, vec_len (a->uri));
56 vl_api_rpc_call_main_thread (proxy_cb_fn, (u8 *) & args, sizeof (args));
61 delete_proxy_session (stream_session_t * s, int is_active_open)
63 proxy_main_t *pm = &proxy_main;
64 proxy_session_t *ps = 0;
65 vnet_disconnect_args_t _a, *a = &_a;
66 stream_session_t *active_open_session = 0;
67 stream_session_t *server_session = 0;
71 handle = session_handle (s);
73 clib_spinlock_lock_if_init (&pm->sessions_lock);
76 active_open_session = s;
78 p = hash_get (pm->proxy_session_by_active_open_handle, handle);
81 clib_warning ("proxy session for %s handle %lld (%llx) AWOL",
82 is_active_open ? "active open" : "server",
85 else if (!pool_is_free_index (pm->sessions, p[0]))
87 ps = pool_elt_at_index (pm->sessions, p[0]);
88 if (ps->vpp_server_handle != ~0)
89 server_session = session_get_from_handle (ps->vpp_server_handle);
98 p = hash_get (pm->proxy_session_by_server_handle, handle);
101 clib_warning ("proxy session for %s handle %lld (%llx) AWOL",
102 is_active_open ? "active open" : "server",
105 else if (!pool_is_free_index (pm->sessions, p[0]))
107 ps = pool_elt_at_index (pm->sessions, p[0]);
108 if (ps->vpp_active_open_handle != ~0)
109 active_open_session = session_get_from_handle
110 (ps->vpp_active_open_handle);
112 active_open_session = 0;
119 memset (ps, 0xFE, sizeof (*ps));
120 pool_put (pm->sessions, ps);
123 clib_spinlock_unlock_if_init (&pm->sessions_lock);
125 if (active_open_session)
127 a->handle = session_handle (active_open_session);
128 a->app_index = pm->active_open_app_index;
129 hash_unset (pm->proxy_session_by_active_open_handle,
130 session_handle (active_open_session));
131 vnet_disconnect_session (a);
136 a->handle = session_handle (server_session);
137 a->app_index = pm->server_app_index;
138 hash_unset (pm->proxy_session_by_server_handle,
139 session_handle (server_session));
140 vnet_disconnect_session (a);
145 proxy_accept_callback (stream_session_t * s)
147 proxy_main_t *pm = &proxy_main;
149 s->session_state = SESSION_STATE_READY;
151 clib_spinlock_lock_if_init (&pm->sessions_lock);
157 proxy_disconnect_callback (stream_session_t * s)
159 delete_proxy_session (s, 0 /* is_active_open */ );
163 proxy_reset_callback (stream_session_t * s)
165 clib_warning ("Reset session %U", format_stream_session, s, 2);
166 delete_proxy_session (s, 0 /* is_active_open */ );
170 proxy_connected_callback (u32 app_index, u32 api_context,
171 stream_session_t * s, u8 is_fail)
173 clib_warning ("called...");
178 proxy_add_segment_callback (u32 client_index, const ssvm_private_t * sp)
180 clib_warning ("called...");
185 proxy_rx_callback (stream_session_t * s)
188 int actual_transfer __attribute__ ((unused));
189 svm_fifo_t *tx_fifo, *rx_fifo;
190 proxy_main_t *pm = &proxy_main;
191 u32 thread_index = vlib_get_thread_index ();
192 vnet_connect_args_t _a, *a = &_a;
196 svm_fifo_t *active_open_tx_fifo;
197 session_fifo_event_t evt;
199 ASSERT (s->thread_index == thread_index);
201 clib_spinlock_lock_if_init (&pm->sessions_lock);
202 p = hash_get (pm->proxy_session_by_server_handle, session_handle (s));
204 if (PREDICT_TRUE (p != 0))
206 clib_spinlock_unlock_if_init (&pm->sessions_lock);
207 active_open_tx_fifo = s->server_rx_fifo;
210 * Send event for active open tx fifo
212 if (svm_fifo_set_event (active_open_tx_fifo))
214 u32 ao_thread_index = active_open_tx_fifo->master_thread_index;
215 evt.fifo = active_open_tx_fifo;
216 evt.event_type = FIFO_EVENT_APP_TX;
217 if (svm_queue_add (pm->active_open_event_queue[ao_thread_index],
218 (u8 *) & evt, 0 /* do wait for mutex */ ))
219 clib_warning ("failed to enqueue tx evt");
224 rx_fifo = s->server_rx_fifo;
225 tx_fifo = s->server_tx_fifo;
227 ASSERT (rx_fifo->master_thread_index == thread_index);
228 ASSERT (tx_fifo->master_thread_index == thread_index);
230 max_dequeue = svm_fifo_max_dequeue (s->server_rx_fifo);
232 if (PREDICT_FALSE (max_dequeue == 0))
235 actual_transfer = svm_fifo_peek (rx_fifo, 0 /* relative_offset */ ,
236 max_dequeue, pm->rx_buf[thread_index]);
238 /* $$$ your message in this space: parse url, etc. */
240 memset (a, 0, sizeof (*a));
242 clib_spinlock_lock_if_init (&pm->sessions_lock);
243 pool_get (pm->sessions, ps);
244 memset (ps, 0, sizeof (*ps));
245 ps->server_rx_fifo = rx_fifo;
246 ps->server_tx_fifo = tx_fifo;
247 ps->vpp_server_handle = session_handle (s);
249 proxy_index = ps - pm->sessions;
251 hash_set (pm->proxy_session_by_server_handle, ps->vpp_server_handle,
254 clib_spinlock_unlock_if_init (&pm->sessions_lock);
256 a->uri = (char *) pm->client_uri;
257 a->api_context = proxy_index;
258 a->app_index = pm->active_open_app_index;
259 proxy_call_main_thread (a);
265 static session_cb_vft_t proxy_session_cb_vft = {
266 .session_accept_callback = proxy_accept_callback,
267 .session_disconnect_callback = proxy_disconnect_callback,
268 .session_connected_callback = proxy_connected_callback,
269 .add_segment_callback = proxy_add_segment_callback,
270 .builtin_app_rx_callback = proxy_rx_callback,
271 .session_reset_callback = proxy_reset_callback
275 active_open_connected_callback (u32 app_index, u32 opaque,
276 stream_session_t * s, u8 is_fail)
278 proxy_main_t *pm = &proxy_main;
280 u8 thread_index = vlib_get_thread_index ();
281 session_fifo_event_t evt;
285 clib_warning ("connection %d failed!", opaque);
290 * Setup proxy session handle.
292 clib_spinlock_lock_if_init (&pm->sessions_lock);
294 ps = pool_elt_at_index (pm->sessions, opaque);
295 ps->vpp_active_open_handle = session_handle (s);
297 s->server_tx_fifo = ps->server_rx_fifo;
298 s->server_rx_fifo = ps->server_tx_fifo;
301 * Reset the active-open tx-fifo master indices so the active-open session
302 * will receive data, etc.
304 s->server_tx_fifo->master_session_index = s->session_index;
305 s->server_tx_fifo->master_thread_index = s->thread_index;
308 * Account for the active-open session's use of the fifos
309 * so they won't disappear until the last session which uses
312 s->server_tx_fifo->refcnt++;
313 s->server_rx_fifo->refcnt++;
315 hash_set (pm->proxy_session_by_active_open_handle,
316 ps->vpp_active_open_handle, opaque);
318 clib_spinlock_unlock_if_init (&pm->sessions_lock);
321 * Send event for active open tx fifo
323 if (svm_fifo_set_event (s->server_tx_fifo))
325 evt.fifo = s->server_tx_fifo;
326 evt.event_type = FIFO_EVENT_APP_TX;
328 (pm->active_open_event_queue[thread_index], (u8 *) & evt,
329 0 /* do wait for mutex */ ))
330 clib_warning ("failed to enqueue tx evt");
337 active_open_reset_callback (stream_session_t * s)
339 delete_proxy_session (s, 1 /* is_active_open */ );
343 active_open_create_callback (stream_session_t * s)
349 active_open_disconnect_callback (stream_session_t * s)
351 delete_proxy_session (s, 1 /* is_active_open */ );
355 active_open_rx_callback (stream_session_t * s)
357 proxy_main_t *pm = &proxy_main;
358 session_fifo_event_t evt;
359 svm_fifo_t *proxy_tx_fifo;
361 proxy_tx_fifo = s->server_rx_fifo;
364 * Send event for server tx fifo
366 if (svm_fifo_set_event (proxy_tx_fifo))
368 u32 p_thread_index = proxy_tx_fifo->master_thread_index;
369 evt.fifo = proxy_tx_fifo;
370 evt.event_type = FIFO_EVENT_APP_TX;
371 if (svm_queue_add (pm->server_event_queue[p_thread_index], (u8 *) & evt,
372 0 /* do wait for mutex */ ))
373 clib_warning ("failed to enqueue server rx evt");
380 static session_cb_vft_t active_open_clients = {
381 .session_reset_callback = active_open_reset_callback,
382 .session_connected_callback = active_open_connected_callback,
383 .session_accept_callback = active_open_create_callback,
384 .session_disconnect_callback = active_open_disconnect_callback,
385 .builtin_app_rx_callback = active_open_rx_callback
391 create_api_loopbacks (vlib_main_t * vm)
393 proxy_main_t *pm = &proxy_main;
394 api_main_t *am = &api_main;
395 vl_shmem_hdr_t *shmem_hdr;
397 shmem_hdr = am->shmem_hdr;
398 pm->vl_input_queue = shmem_hdr->vl_input_queue;
399 pm->server_client_index =
400 vl_api_memclnt_create_internal ("proxy_server", pm->vl_input_queue);
401 pm->active_open_client_index =
402 vl_api_memclnt_create_internal ("proxy_active_open", pm->vl_input_queue);
406 proxy_server_attach ()
408 proxy_main_t *pm = &proxy_main;
409 u64 options[APP_OPTIONS_N_OPTIONS];
410 vnet_app_attach_args_t _a, *a = &_a;
411 u32 segment_size = 512 << 20;
413 memset (a, 0, sizeof (*a));
414 memset (options, 0, sizeof (options));
416 if (pm->private_segment_size)
417 segment_size = pm->private_segment_size;
418 a->api_client_index = pm->server_client_index;
419 a->session_cb_vft = &proxy_session_cb_vft;
420 a->options = options;
421 a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
422 a->options[APP_OPTIONS_RX_FIFO_SIZE] = pm->fifo_size;
423 a->options[APP_OPTIONS_TX_FIFO_SIZE] = pm->fifo_size;
424 a->options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = pm->private_segment_count;
425 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
426 pm->prealloc_fifos ? pm->prealloc_fifos : 0;
428 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
430 if (vnet_application_attach (a))
432 clib_warning ("failed to attach server");
435 pm->server_app_index = a->app_index;
441 active_open_attach (void)
443 proxy_main_t *pm = &proxy_main;
444 vnet_app_attach_args_t _a, *a = &_a;
447 memset (a, 0, sizeof (*a));
448 memset (options, 0, sizeof (options));
450 a->api_client_index = pm->active_open_client_index;
451 a->session_cb_vft = &active_open_clients;
453 options[APP_OPTIONS_ACCEPT_COOKIE] = 0x12345678;
454 options[APP_OPTIONS_SEGMENT_SIZE] = 512 << 20;
455 options[APP_OPTIONS_RX_FIFO_SIZE] = pm->fifo_size;
456 options[APP_OPTIONS_TX_FIFO_SIZE] = pm->fifo_size;
457 options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = pm->private_segment_count;
458 options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
459 pm->prealloc_fifos ? pm->prealloc_fifos : 0;
461 options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN
462 | APP_OPTIONS_FLAGS_IS_PROXY;
464 a->options = options;
466 if (vnet_application_attach (a))
469 pm->active_open_app_index = a->app_index;
475 proxy_server_listen ()
477 proxy_main_t *pm = &proxy_main;
478 vnet_bind_args_t _a, *a = &_a;
479 memset (a, 0, sizeof (*a));
480 a->app_index = pm->server_app_index;
481 a->uri = (char *) pm->server_uri;
482 return vnet_bind_uri (a);
486 proxy_server_create (vlib_main_t * vm)
488 proxy_main_t *pm = &proxy_main;
489 vlib_thread_main_t *vtm = vlib_get_thread_main ();
493 if (pm->server_client_index == (u32) ~ 0)
494 create_api_loopbacks (vm);
496 num_threads = 1 /* main thread */ + vtm->n_threads;
497 vec_validate (proxy_main.server_event_queue, num_threads - 1);
498 vec_validate (proxy_main.active_open_event_queue, num_threads - 1);
499 vec_validate (pm->rx_buf, num_threads - 1);
501 for (i = 0; i < num_threads; i++)
502 vec_validate (pm->rx_buf[i], pm->rcv_buffer_size);
504 if (proxy_server_attach ())
506 clib_warning ("failed to attach server app");
509 if (proxy_server_listen ())
511 clib_warning ("failed to start listening");
514 if (active_open_attach ())
516 clib_warning ("failed to attach active open app");
520 for (i = 0; i < num_threads; i++)
522 pm->active_open_event_queue[i] =
523 session_manager_get_vpp_event_queue (i);
525 ASSERT (pm->active_open_event_queue[i]);
527 pm->server_event_queue[i] = session_manager_get_vpp_event_queue (i);
533 static clib_error_t *
534 proxy_server_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
535 vlib_cli_command_t * cmd)
537 proxy_main_t *pm = &proxy_main;
538 char *default_server_uri = "tcp://0.0.0.0/23";
539 char *default_client_uri = "tcp://6.0.2.2/23";
543 pm->fifo_size = 64 << 10;
544 pm->rcv_buffer_size = 1024;
545 pm->prealloc_fifos = 0;
546 pm->private_segment_count = 0;
547 pm->private_segment_size = 0;
550 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
552 if (unformat (input, "fifo-size %d", &pm->fifo_size))
553 pm->fifo_size <<= 10;
554 else if (unformat (input, "rcv-buf-size %d", &pm->rcv_buffer_size))
556 else if (unformat (input, "prealloc-fifos %d", &pm->prealloc_fifos))
558 else if (unformat (input, "private-segment-count %d",
559 &pm->private_segment_count))
561 else if (unformat (input, "private-segment-size %U",
562 unformat_memory_size, &tmp))
564 if (tmp >= 0x100000000ULL)
565 return clib_error_return
566 (0, "private segment size %lld (%llu) too large", tmp, tmp);
567 pm->private_segment_size = tmp;
569 else if (unformat (input, "server-uri %s", &pm->server_uri))
571 else if (unformat (input, "client-uri %s", &pm->client_uri))
572 pm->client_uri = format (0, "%s%c", pm->client_uri, 0);
574 return clib_error_return (0, "unknown input `%U'",
575 format_unformat_error, input);
580 clib_warning ("No server-uri provided, Using default: %s",
582 pm->server_uri = format (0, "%s%c", default_server_uri, 0);
586 clib_warning ("No client-uri provided, Using default: %s",
588 pm->client_uri = format (0, "%s%c", default_client_uri, 0);
591 vnet_session_enable_disable (vm, 1 /* turn on session and transport */ );
593 rv = proxy_server_create (vm);
599 return clib_error_return (0, "server_create returned %d", rv);
606 VLIB_CLI_COMMAND (proxy_create_command, static) =
608 .path = "test proxy server",
609 .short_help = "test proxy server [server-uri <tcp://ip/port>]"
610 "[client-uri <tcp://ip/port>][fifo-size <nn>][rcv-buf-size <nn>]"
611 "[prealloc-fifos <nn>][private-segment-size <mem>]"
612 "[private-segment-count <nn>]",
613 .function = proxy_server_create_command_fn,
618 proxy_main_init (vlib_main_t * vm)
620 proxy_main_t *pm = &proxy_main;
621 pm->server_client_index = ~0;
622 pm->active_open_client_index = ~0;
623 pm->proxy_session_by_active_open_handle = hash_create (0, sizeof (uword));
624 pm->proxy_session_by_server_handle = hash_create (0, sizeof (uword));
629 VLIB_INIT_FUNCTION (proxy_main_init);
632 * fd.io coding-style-patch-verification: ON
635 * eval: (c-set-style "gnu")