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/tcp/builtin_proxy.h>
22 builtin_proxy_main_t builtin_proxy_main;
25 delete_proxy_session (stream_session_t * s, int is_active_open)
27 builtin_proxy_main_t *bpm = &builtin_proxy_main;
28 proxy_session_t *ps = 0;
29 vnet_disconnect_args_t _a, *a = &_a;
30 stream_session_t *active_open_session = 0;
31 stream_session_t *server_session = 0;
35 handle = session_handle (s);
37 clib_spinlock_lock_if_init (&bpm->sessions_lock);
40 active_open_session = s;
42 p = hash_get (bpm->proxy_session_by_active_open_handle, handle);
45 clib_warning ("proxy session for %s handle %lld (%llx) AWOL",
46 is_active_open ? "active open" : "server",
51 ps = pool_elt_at_index (bpm->sessions, p[0]);
52 if (ps->vpp_server_handle != ~0)
53 server_session = session_get_from_handle (ps->vpp_server_handle);
62 p = hash_get (bpm->proxy_session_by_server_handle, handle);
65 clib_warning ("proxy session for %s handle %lld (%llx) AWOL",
66 is_active_open ? "active open" : "server",
71 ps = pool_elt_at_index (bpm->sessions, p[0]);
72 if (ps->vpp_server_handle != ~0)
73 active_open_session = session_get_from_handle
74 (ps->vpp_server_handle);
76 active_open_session = 0;
83 memset (ps, 0xFE, sizeof (*ps));
84 pool_put (bpm->sessions, ps);
87 clib_spinlock_unlock_if_init (&bpm->sessions_lock);
89 if (active_open_session)
91 a->handle = session_handle (active_open_session);
92 a->app_index = bpm->active_open_app_index;
93 hash_unset (bpm->proxy_session_by_active_open_handle,
94 session_handle (active_open_session));
95 vnet_disconnect_session (a);
100 a->handle = session_handle (server_session);
101 a->app_index = bpm->server_app_index;
102 hash_unset (bpm->proxy_session_by_server_handle,
103 session_handle (server_session));
104 vnet_disconnect_session (a);
109 server_accept_callback (stream_session_t * s)
111 builtin_proxy_main_t *bpm = &builtin_proxy_main;
113 s->session_state = SESSION_STATE_READY;
115 clib_spinlock_lock_if_init (&bpm->sessions_lock);
121 server_disconnect_callback (stream_session_t * s)
123 delete_proxy_session (s, 0 /* is_active_open */ );
127 server_reset_callback (stream_session_t * s)
129 clib_warning ("Reset session %U", format_stream_session, s, 2);
130 delete_proxy_session (s, 0 /* is_active_open */ );
134 server_connected_callback (u32 app_index, u32 api_context,
135 stream_session_t * s, u8 is_fail)
137 clib_warning ("called...");
142 server_add_segment_callback (u32 client_index,
143 const u8 * seg_name, u32 seg_size)
145 clib_warning ("called...");
150 server_redirect_connect_callback (u32 client_index, void *mp)
152 clib_warning ("called...");
157 server_rx_callback (stream_session_t * s)
160 int actual_transfer __attribute__ ((unused));
161 svm_fifo_t *tx_fifo, *rx_fifo;
162 builtin_proxy_main_t *bpm = &builtin_proxy_main;
163 u32 thread_index = vlib_get_thread_index ();
164 vnet_connect_args_t _a, *a = &_a;
168 svm_fifo_t *active_open_tx_fifo;
169 session_fifo_event_t evt;
171 ASSERT (s->thread_index == thread_index);
173 clib_spinlock_lock_if_init (&bpm->sessions_lock);
174 p = hash_get (bpm->proxy_session_by_server_handle, session_handle (s));
176 if (PREDICT_TRUE (p != 0))
178 clib_spinlock_unlock_if_init (&bpm->sessions_lock);
179 active_open_tx_fifo = s->server_rx_fifo;
182 * Send event for active open tx fifo
184 if (svm_fifo_set_event (active_open_tx_fifo))
186 evt.fifo = active_open_tx_fifo;
187 evt.event_type = FIFO_EVENT_APP_TX;
188 if (unix_shared_memory_queue_add
189 (bpm->active_open_event_queue[thread_index], (u8 *) & evt,
190 0 /* do wait for mutex */ ))
191 clib_warning ("failed to enqueue tx evt");
196 rx_fifo = s->server_rx_fifo;
197 tx_fifo = s->server_tx_fifo;
199 ASSERT (rx_fifo->master_thread_index == thread_index);
200 ASSERT (tx_fifo->master_thread_index == thread_index);
202 max_dequeue = svm_fifo_max_dequeue (s->server_rx_fifo);
204 if (PREDICT_FALSE (max_dequeue == 0))
207 actual_transfer = svm_fifo_peek (rx_fifo, 0 /* relative_offset */ ,
209 bpm->rx_buf[thread_index]);
211 /* $$$ your message in this space: parse url, etc. */
213 memset (a, 0, sizeof (*a));
215 clib_spinlock_lock_if_init (&bpm->sessions_lock);
216 pool_get (bpm->sessions, ps);
217 memset (ps, 0, sizeof (*ps));
218 ps->server_rx_fifo = rx_fifo;
219 ps->server_tx_fifo = tx_fifo;
220 ps->vpp_server_handle = session_handle (s);
222 proxy_index = ps - bpm->sessions;
224 hash_set (bpm->proxy_session_by_server_handle, ps->vpp_server_handle,
227 clib_spinlock_unlock_if_init (&bpm->sessions_lock);
229 a->uri = "tcp://6.0.2.2/23";
230 a->api_context = proxy_index;
231 a->app_index = bpm->active_open_app_index;
233 vnet_connect_uri (a);
239 static session_cb_vft_t builtin_session_cb_vft = {
240 .session_accept_callback = server_accept_callback,
241 .session_disconnect_callback = server_disconnect_callback,
242 .session_connected_callback = server_connected_callback,
243 .add_segment_callback = server_add_segment_callback,
244 .redirect_connect_callback = server_redirect_connect_callback,
245 .builtin_server_rx_callback = server_rx_callback,
246 .session_reset_callback = server_reset_callback
250 active_open_connected_callback (u32 app_index, u32 opaque,
251 stream_session_t * s, u8 is_fail)
253 builtin_proxy_main_t *bpm = &builtin_proxy_main;
255 u8 thread_index = vlib_get_thread_index ();
256 session_fifo_event_t evt;
260 clib_warning ("connection %d failed!", opaque);
265 * Setup proxy session handle.
267 clib_spinlock_lock_if_init (&bpm->sessions_lock);
269 ps = pool_elt_at_index (bpm->sessions, opaque);
270 ps->vpp_active_open_handle = session_handle (s);
272 s->server_tx_fifo = ps->server_rx_fifo;
273 s->server_rx_fifo = ps->server_tx_fifo;
276 * Reset the active-open tx-fifo master indices so the active-open session
277 * will receive data, etc.
279 s->server_tx_fifo->master_session_index = s->session_index;
280 s->server_tx_fifo->master_thread_index = s->thread_index;
283 * Account for the active-open session's use of the fifos
284 * so they won't disappear until the last session which uses
287 s->server_tx_fifo->refcnt++;
288 s->server_rx_fifo->refcnt++;
290 hash_set (bpm->proxy_session_by_active_open_handle,
291 ps->vpp_active_open_handle, opaque);
293 clib_spinlock_unlock_if_init (&bpm->sessions_lock);
296 * Send event for active open tx fifo
298 if (svm_fifo_set_event (s->server_tx_fifo))
300 evt.fifo = s->server_tx_fifo;
301 evt.event_type = FIFO_EVENT_APP_TX;
302 if (unix_shared_memory_queue_add
303 (bpm->active_open_event_queue[thread_index], (u8 *) & evt,
304 0 /* do wait for mutex */ ))
305 clib_warning ("failed to enqueue tx evt");
312 active_open_reset_callback (stream_session_t * s)
314 delete_proxy_session (s, 1 /* is_active_open */ );
318 active_open_create_callback (stream_session_t * s)
324 active_open_disconnect_callback (stream_session_t * s)
326 delete_proxy_session (s, 1 /* is_active_open */ );
330 active_open_rx_callback (stream_session_t * s)
332 builtin_proxy_main_t *bpm = &builtin_proxy_main;
333 session_fifo_event_t evt;
334 svm_fifo_t *server_rx_fifo;
335 u32 thread_index = vlib_get_thread_index ();
337 server_rx_fifo = s->server_rx_fifo;
340 * Send event for server tx fifo
342 if (svm_fifo_set_event (server_rx_fifo))
344 evt.fifo = server_rx_fifo;
345 evt.event_type = FIFO_EVENT_APP_TX;
346 if (unix_shared_memory_queue_add
347 (bpm->server_event_queue[thread_index], (u8 *) & evt,
348 0 /* do wait for mutex */ ))
349 clib_warning ("failed to enqueue server rx evt");
356 static session_cb_vft_t builtin_clients = {
357 .session_reset_callback = active_open_reset_callback,
358 .session_connected_callback = active_open_connected_callback,
359 .session_accept_callback = active_open_create_callback,
360 .session_disconnect_callback = active_open_disconnect_callback,
361 .builtin_server_rx_callback = active_open_rx_callback
367 create_api_loopbacks (vlib_main_t * vm)
369 builtin_proxy_main_t *bpm = &builtin_proxy_main;
370 api_main_t *am = &api_main;
371 vl_shmem_hdr_t *shmem_hdr;
373 shmem_hdr = am->shmem_hdr;
374 bpm->vl_input_queue = shmem_hdr->vl_input_queue;
375 bpm->server_client_index =
376 vl_api_memclnt_create_internal ("proxy_server", bpm->vl_input_queue);
377 bpm->active_open_client_index =
378 vl_api_memclnt_create_internal ("proxy_active_open", bpm->vl_input_queue);
384 builtin_proxy_main_t *bpm = &builtin_proxy_main;
385 u8 segment_name[128];
386 u64 options[SESSION_OPTIONS_N_OPTIONS];
387 vnet_app_attach_args_t _a, *a = &_a;
389 memset (a, 0, sizeof (*a));
390 memset (options, 0, sizeof (options));
392 a->api_client_index = bpm->server_client_index;
393 a->session_cb_vft = &builtin_session_cb_vft;
394 a->options = options;
395 a->options[SESSION_OPTIONS_SEGMENT_SIZE] = 512 << 20;
396 a->options[SESSION_OPTIONS_RX_FIFO_SIZE] = bpm->fifo_size;
397 a->options[SESSION_OPTIONS_TX_FIFO_SIZE] = bpm->fifo_size;
398 a->options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = bpm->private_segment_count;
399 a->options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE] = bpm->private_segment_size;
400 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
401 bpm->prealloc_fifos ? bpm->prealloc_fifos : 1;
403 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
405 a->segment_name = segment_name;
406 a->segment_name_length = ARRAY_LEN (segment_name);
408 if (vnet_application_attach (a))
410 clib_warning ("failed to attach server");
413 bpm->server_app_index = a->app_index;
419 active_open_attach (void)
421 builtin_proxy_main_t *bpm = &builtin_proxy_main;
422 vnet_app_attach_args_t _a, *a = &_a;
423 u8 segment_name[128];
424 u32 segment_name_length;
427 segment_name_length = ARRAY_LEN (segment_name);
429 memset (a, 0, sizeof (*a));
430 memset (options, 0, sizeof (options));
432 a->api_client_index = bpm->active_open_client_index;
433 a->segment_name = segment_name;
434 a->segment_name_length = segment_name_length;
435 a->session_cb_vft = &builtin_clients;
437 options[SESSION_OPTIONS_ACCEPT_COOKIE] = 0x12345678;
438 options[SESSION_OPTIONS_SEGMENT_SIZE] = 512 << 20;
439 options[SESSION_OPTIONS_RX_FIFO_SIZE] = bpm->fifo_size;
440 options[SESSION_OPTIONS_TX_FIFO_SIZE] = bpm->fifo_size;
441 options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = bpm->private_segment_count;
442 options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE] = bpm->private_segment_size;
443 options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
444 bpm->prealloc_fifos ? bpm->prealloc_fifos : 1;
446 options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN
447 | APP_OPTIONS_FLAGS_IS_PROXY;
449 a->options = options;
451 if (vnet_application_attach (a))
454 bpm->active_open_app_index = a->app_index;
462 builtin_proxy_main_t *bpm = &builtin_proxy_main;
463 vnet_bind_args_t _a, *a = &_a;
464 memset (a, 0, sizeof (*a));
465 a->app_index = bpm->server_app_index;
466 a->uri = "tcp://0.0.0.0/23";
467 return vnet_bind_uri (a);
471 server_create (vlib_main_t * vm)
473 builtin_proxy_main_t *bpm = &builtin_proxy_main;
474 vlib_thread_main_t *vtm = vlib_get_thread_main ();
478 if (bpm->server_client_index == (u32) ~ 0)
479 create_api_loopbacks (vm);
481 num_threads = 1 /* main thread */ + vtm->n_threads;
482 vec_validate (builtin_proxy_main.server_event_queue, num_threads - 1);
483 vec_validate (builtin_proxy_main.active_open_event_queue, num_threads - 1);
484 vec_validate (bpm->rx_buf, num_threads - 1);
486 for (i = 0; i < num_threads; i++)
487 vec_validate (bpm->rx_buf[i], bpm->rcv_buffer_size);
489 if (server_attach ())
491 clib_warning ("failed to attach server app");
494 if (server_listen ())
496 clib_warning ("failed to start listening");
499 if (active_open_attach ())
501 clib_warning ("failed to attach active open app");
505 for (i = 0; i < num_threads; i++)
507 bpm->active_open_event_queue[i] =
508 session_manager_get_vpp_event_queue (i);
510 ASSERT (bpm->active_open_event_queue[i]);
512 bpm->server_event_queue[i] = session_manager_get_vpp_event_queue (i);
518 static clib_error_t *
519 proxy_server_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
520 vlib_cli_command_t * cmd)
522 builtin_proxy_main_t *bpm = &builtin_proxy_main;
526 bpm->fifo_size = 64 << 10;
527 bpm->rcv_buffer_size = 1024;
528 bpm->prealloc_fifos = 0;
529 bpm->private_segment_count = 0;
530 bpm->private_segment_size = 0;
532 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
534 if (unformat (input, "fifo-size %d", &bpm->fifo_size))
535 bpm->fifo_size <<= 10;
536 else if (unformat (input, "rcv-buf-size %d", &bpm->rcv_buffer_size))
538 else if (unformat (input, "prealloc-fifos %d", &bpm->prealloc_fifos))
540 else if (unformat (input, "private-segment-count %d",
541 &bpm->private_segment_count))
543 else if (unformat (input, "private-segment-size %U",
544 unformat_memory_size, &tmp))
546 if (tmp >= 0x100000000ULL)
547 return clib_error_return
548 (0, "private segment size %lld (%llu) too large", tmp, tmp);
549 bpm->private_segment_size = tmp;
552 return clib_error_return (0, "unknown input `%U'",
553 format_unformat_error, input);
556 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
558 rv = server_create (vm);
564 return clib_error_return (0, "server_create returned %d", rv);
571 VLIB_CLI_COMMAND (server_create_command, static) =
573 .path = "test proxy server",
574 .short_help = "test proxy server",
575 .function = proxy_server_create_command_fn,
580 builtin_tcp_proxy_main_init (vlib_main_t * vm)
582 builtin_proxy_main_t *bpm = &builtin_proxy_main;
583 bpm->server_client_index = ~0;
584 bpm->active_open_client_index = ~0;
585 bpm->proxy_session_by_active_open_handle = hash_create (0, sizeof (uword));
586 bpm->proxy_session_by_server_handle = hash_create (0, sizeof (uword));
591 VLIB_INIT_FUNCTION (builtin_tcp_proxy_main_init);
594 * fd.io coding-style-patch-verification: ON
597 * eval: (c-set-style "gnu")