2 * Copyright (c) 2017-2019 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/session.h>
22 #define ECHO_SERVER_DBG (0)
23 #define DBG(_fmt, _args...) \
24 if (ECHO_SERVER_DBG) \
25 clib_warning (_fmt, ##_args)
30 * Server app parameters
32 svm_msg_q_t **vpp_queue;
33 svm_queue_t *vl_input_queue; /**< Sever's event queue */
35 u32 app_index; /**< Server app index */
36 u32 my_client_index; /**< API client handle */
37 u32 node_index; /**< process node index for event scheduling */
42 u8 no_echo; /**< Don't echo traffic */
43 u32 fifo_size; /**< Fifo size */
44 u32 rcv_buffer_size; /**< Rcv buffer size */
45 u32 prealloc_fifos; /**< Preallocate fifos */
46 u32 private_segment_count; /**< Number of private segments */
47 u32 private_segment_size; /**< Size of private segments */
48 char *server_uri; /**< Server URI */
49 u32 tls_engine; /**< TLS engine: mbedtls/openssl */
50 u8 is_dgram; /**< set if transport is dgram */
54 u8 **rx_buf; /**< Per-thread RX buffer */
58 u64 listener_handle; /**< Session handle of the root listener */
60 vlib_main_t *vlib_main;
63 echo_server_main_t echo_server_main;
66 quic_echo_server_qsession_accept_callback (session_t * s)
68 DBG ("QSession %u accept w/opaque %d", s->session_index, s->opaque);
73 quic_echo_server_session_accept_callback (session_t * s)
75 echo_server_main_t *esm = &echo_server_main;
76 if (s->listener_handle == esm->listener_handle)
77 return quic_echo_server_qsession_accept_callback (s);
78 DBG ("SSESSION %u accept w/opaque %d", s->session_index, s->opaque);
80 esm->vpp_queue[s->thread_index] =
81 session_main_get_vpp_event_queue (s->thread_index);
82 s->session_state = SESSION_STATE_READY;
84 ASSERT (vec_len (esm->rx_retries) > s->thread_index);
85 vec_validate (esm->rx_retries[s->thread_index], s->session_index);
86 esm->rx_retries[s->thread_index][s->session_index] = 0;
91 echo_server_session_accept_callback (session_t * s)
93 echo_server_main_t *esm = &echo_server_main;
94 esm->vpp_queue[s->thread_index] =
95 session_main_get_vpp_event_queue (s->thread_index);
96 s->session_state = SESSION_STATE_READY;
98 ASSERT (vec_len (esm->rx_retries) > s->thread_index);
99 vec_validate (esm->rx_retries[s->thread_index], s->session_index);
100 esm->rx_retries[s->thread_index][s->session_index] = 0;
105 echo_server_session_disconnect_callback (session_t * s)
107 echo_server_main_t *esm = &echo_server_main;
108 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
110 a->handle = session_handle (s);
111 a->app_index = esm->app_index;
112 vnet_disconnect_session (a);
116 echo_server_session_reset_callback (session_t * s)
118 echo_server_main_t *esm = &echo_server_main;
119 vnet_disconnect_args_t _a = { 0 }, *a = &_a;
120 clib_warning ("Reset session %U", format_session, s, 2);
121 a->handle = session_handle (s);
122 a->app_index = esm->app_index;
123 vnet_disconnect_session (a);
127 echo_server_session_connected_callback (u32 app_index, u32 api_context,
128 session_t * s, u8 is_fail)
130 clib_warning ("called...");
135 echo_server_add_segment_callback (u32 client_index, u64 segment_handle)
137 /* New heaps may be added */
142 echo_server_redirect_connect_callback (u32 client_index, void *mp)
144 clib_warning ("called...");
149 test_bytes (echo_server_main_t * esm, int actual_transfer)
152 u32 my_thread_id = vlib_get_thread_index ();
154 for (i = 0; i < actual_transfer; i++)
156 if (esm->rx_buf[my_thread_id][i] != ((esm->byte_index + i) & 0xff))
158 clib_warning ("at %lld expected %d got %d", esm->byte_index + i,
159 (esm->byte_index + i) & 0xff,
160 esm->rx_buf[my_thread_id][i]);
163 esm->byte_index += actual_transfer;
167 * If no-echo, just drop the data and be done with it.
170 echo_server_builtin_server_rx_callback_no_echo (session_t * s)
172 svm_fifo_t *rx_fifo = s->rx_fifo;
173 svm_fifo_dequeue_drop (rx_fifo, svm_fifo_max_dequeue_cons (rx_fifo));
178 echo_server_rx_callback (session_t * s)
180 u32 n_written, max_dequeue, max_enqueue, max_transfer;
182 svm_fifo_t *tx_fifo, *rx_fifo;
183 echo_server_main_t *esm = &echo_server_main;
184 u32 thread_index = vlib_get_thread_index ();
185 app_session_transport_t at;
187 ASSERT (s->thread_index == thread_index);
189 rx_fifo = s->rx_fifo;
190 tx_fifo = s->tx_fifo;
192 ASSERT (rx_fifo->master_thread_index == thread_index);
193 ASSERT (tx_fifo->master_thread_index == thread_index);
195 max_enqueue = svm_fifo_max_enqueue_prod (tx_fifo);
198 max_dequeue = svm_fifo_max_dequeue_cons (rx_fifo);
202 session_dgram_pre_hdr_t ph;
203 svm_fifo_peek (rx_fifo, 0, sizeof (ph), (u8 *) & ph);
204 max_dequeue = ph.data_length - ph.data_offset;
205 if (!esm->vpp_queue[s->thread_index])
208 mq = session_main_get_vpp_event_queue (s->thread_index);
209 esm->vpp_queue[s->thread_index] = mq;
211 max_enqueue -= sizeof (session_dgram_hdr_t);
214 if (PREDICT_FALSE (max_dequeue == 0))
217 /* Number of bytes we're going to copy */
218 max_transfer = clib_min (max_dequeue, max_enqueue);
220 /* No space in tx fifo */
221 if (PREDICT_FALSE (max_transfer == 0))
223 /* XXX timeout for session that are stuck */
226 /* Program self-tap to retry */
227 if (svm_fifo_set_event (rx_fifo))
229 if (session_send_io_evt_to_thread (rx_fifo,
230 SESSION_IO_EVT_BUILTIN_RX))
231 clib_warning ("failed to enqueue self-tap");
233 vec_validate (esm->rx_retries[s->thread_index], s->session_index);
234 if (esm->rx_retries[thread_index][s->session_index] == 500000)
236 clib_warning ("session stuck: %U", format_session, s, 2);
238 if (esm->rx_retries[thread_index][s->session_index] < 500001)
239 esm->rx_retries[thread_index][s->session_index]++;
245 vec_validate (esm->rx_buf[thread_index], max_transfer);
248 actual_transfer = app_recv_stream_raw (rx_fifo,
249 esm->rx_buf[thread_index],
251 0 /* don't clear event */ ,
256 actual_transfer = app_recv_dgram_raw (rx_fifo,
257 esm->rx_buf[thread_index],
259 0 /* don't clear event */ ,
262 ASSERT (actual_transfer == max_transfer);
263 /* test_bytes (esm, actual_transfer); */
271 n_written = app_send_stream_raw (tx_fifo,
272 esm->vpp_queue[thread_index],
273 esm->rx_buf[thread_index],
274 actual_transfer, SESSION_IO_EVT_TX,
279 n_written = app_send_dgram_raw (tx_fifo, &at,
280 esm->vpp_queue[s->thread_index],
281 esm->rx_buf[thread_index],
282 actual_transfer, SESSION_IO_EVT_TX,
286 if (n_written != max_transfer)
287 clib_warning ("short trout! written %u read %u", n_written, max_transfer);
289 if (PREDICT_FALSE (svm_fifo_max_dequeue_cons (rx_fifo)))
295 static session_cb_vft_t echo_server_session_cb_vft = {
296 .session_accept_callback = echo_server_session_accept_callback,
297 .session_disconnect_callback = echo_server_session_disconnect_callback,
298 .session_connected_callback = echo_server_session_connected_callback,
299 .add_segment_callback = echo_server_add_segment_callback,
300 .builtin_app_rx_callback = echo_server_rx_callback,
301 .session_reset_callback = echo_server_session_reset_callback
304 /* Abuse VPP's input queue */
306 create_api_loopback (vlib_main_t * vm)
308 echo_server_main_t *esm = &echo_server_main;
309 api_main_t *am = vlibapi_get_main ();
310 vl_shmem_hdr_t *shmem_hdr;
312 shmem_hdr = am->shmem_hdr;
313 esm->vl_input_queue = shmem_hdr->vl_input_queue;
314 esm->my_client_index = vl_api_memclnt_create_internal ("echo_server",
315 esm->vl_input_queue);
320 echo_server_attach (u8 * appns_id, u64 appns_flags, u64 appns_secret)
322 vnet_app_add_tls_cert_args_t _a_cert, *a_cert = &_a_cert;
323 vnet_app_add_tls_key_args_t _a_key, *a_key = &_a_key;
324 echo_server_main_t *esm = &echo_server_main;
325 vnet_app_attach_args_t _a, *a = &_a;
326 u64 options[APP_OPTIONS_N_OPTIONS];
327 u32 segment_size = 512 << 20;
329 clib_memset (a, 0, sizeof (*a));
330 clib_memset (options, 0, sizeof (options));
333 echo_server_session_cb_vft.builtin_app_rx_callback =
334 echo_server_builtin_server_rx_callback_no_echo;
336 echo_server_session_cb_vft.builtin_app_rx_callback =
337 echo_server_rx_callback;
338 if (esm->transport_proto == TRANSPORT_PROTO_QUIC)
339 echo_server_session_cb_vft.session_accept_callback =
340 quic_echo_server_session_accept_callback;
342 if (esm->private_segment_size)
343 segment_size = esm->private_segment_size;
345 a->api_client_index = esm->my_client_index;
346 a->session_cb_vft = &echo_server_session_cb_vft;
347 a->options = options;
348 a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
349 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = segment_size;
350 a->options[APP_OPTIONS_RX_FIFO_SIZE] = esm->fifo_size;
351 a->options[APP_OPTIONS_TX_FIFO_SIZE] = esm->fifo_size;
352 a->options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = esm->private_segment_count;
353 a->options[APP_OPTIONS_TLS_ENGINE] = esm->tls_engine;
354 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
355 esm->prealloc_fifos ? esm->prealloc_fifos : 1;
357 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
360 a->namespace_id = appns_id;
361 a->options[APP_OPTIONS_FLAGS] |= appns_flags;
362 a->options[APP_OPTIONS_NAMESPACE_SECRET] = appns_secret;
365 if (vnet_application_attach (a))
367 clib_warning ("failed to attach server");
370 esm->app_index = a->app_index;
372 clib_memset (a_cert, 0, sizeof (*a_cert));
373 a_cert->app_index = a->app_index;
374 vec_validate (a_cert->cert, test_srv_crt_rsa_len);
375 clib_memcpy_fast (a_cert->cert, test_srv_crt_rsa, test_srv_crt_rsa_len);
376 vnet_app_add_tls_cert (a_cert);
378 clib_memset (a_key, 0, sizeof (*a_key));
379 a_key->app_index = a->app_index;
380 vec_validate (a_key->key, test_srv_key_rsa_len);
381 clib_memcpy_fast (a_key->key, test_srv_key_rsa, test_srv_key_rsa_len);
382 vnet_app_add_tls_key (a_key);
387 echo_server_detach (void)
389 echo_server_main_t *esm = &echo_server_main;
390 vnet_app_detach_args_t _da, *da = &_da;
393 da->app_index = esm->app_index;
394 rv = vnet_application_detach (da);
400 echo_server_listen ()
403 echo_server_main_t *esm = &echo_server_main;
404 vnet_listen_args_t _a, *a = &_a;
405 clib_memset (a, 0, sizeof (*a));
406 a->app_index = esm->app_index;
407 a->uri = esm->server_uri;
408 rv = vnet_bind_uri (a);
409 esm->listener_handle = a->handle;
414 echo_server_create (vlib_main_t * vm, u8 * appns_id, u64 appns_flags,
417 echo_server_main_t *esm = &echo_server_main;
418 vlib_thread_main_t *vtm = vlib_get_thread_main ();
422 if (esm->my_client_index == (u32) ~ 0)
424 if (create_api_loopback (vm))
426 clib_warning ("failed to create api loopback");
431 num_threads = 1 /* main thread */ + vtm->n_threads;
432 vec_validate (echo_server_main.vpp_queue, num_threads - 1);
433 vec_validate (esm->rx_buf, num_threads - 1);
434 vec_validate (esm->rx_retries, num_threads - 1);
435 for (i = 0; i < vec_len (esm->rx_retries); i++)
436 vec_validate (esm->rx_retries[i],
437 pool_elts (session_main.wrk[i].sessions));
438 esm->rcv_buffer_size = clib_max (esm->rcv_buffer_size, esm->fifo_size);
439 for (i = 0; i < num_threads; i++)
440 vec_validate (esm->rx_buf[i], esm->rcv_buffer_size);
442 if (echo_server_attach (appns_id, appns_flags, appns_secret))
444 clib_warning ("failed to attach server");
447 if (echo_server_listen ())
449 clib_warning ("failed to start listening");
450 if (echo_server_detach ())
451 clib_warning ("failed to detach");
457 static clib_error_t *
458 echo_server_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
459 vlib_cli_command_t * cmd)
461 echo_server_main_t *esm = &echo_server_main;
462 u8 server_uri_set = 0, *appns_id = 0;
463 u64 tmp, appns_flags = 0, appns_secret = 0;
464 char *default_uri = "tcp://0.0.0.0/1234";
466 session_endpoint_cfg_t sep = SESSION_ENDPOINT_CFG_NULL;
469 esm->fifo_size = 64 << 10;
470 esm->rcv_buffer_size = 128 << 10;
471 esm->prealloc_fifos = 0;
472 esm->private_segment_count = 0;
473 esm->private_segment_size = 0;
474 esm->tls_engine = CRYPTO_ENGINE_OPENSSL;
475 vec_free (esm->server_uri);
477 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
479 if (unformat (input, "uri %s", &esm->server_uri))
481 else if (unformat (input, "no-echo"))
483 else if (unformat (input, "fifo-size %d", &esm->fifo_size))
484 esm->fifo_size <<= 10;
485 else if (unformat (input, "rcv-buf-size %d", &esm->rcv_buffer_size))
487 else if (unformat (input, "prealloc-fifos %d", &esm->prealloc_fifos))
489 else if (unformat (input, "private-segment-count %d",
490 &esm->private_segment_count))
492 else if (unformat (input, "private-segment-size %U",
493 unformat_memory_size, &tmp))
495 if (tmp >= 0x100000000ULL)
496 return clib_error_return
497 (0, "private segment size %lld (%llu) too large", tmp, tmp);
498 esm->private_segment_size = tmp;
500 else if (unformat (input, "appns %_%v%_", &appns_id))
502 else if (unformat (input, "all-scope"))
503 appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
504 | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
505 else if (unformat (input, "local-scope"))
506 appns_flags |= APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
507 else if (unformat (input, "global-scope"))
508 appns_flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
509 else if (unformat (input, "secret %lu", &appns_secret))
511 else if (unformat (input, "stop"))
513 else if (unformat (input, "tls-engine %d", &esm->tls_engine))
516 return clib_error_return (0, "failed: unknown input `%U'",
517 format_unformat_error, input);
522 if (esm->app_index == (u32) ~ 0)
524 clib_warning ("server not running");
525 return clib_error_return (0, "failed: server not running");
527 rv = echo_server_detach ();
530 clib_warning ("failed: detach");
531 return clib_error_return (0, "failed: server detach %d", rv);
536 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
540 clib_warning ("No uri provided! Using default: %s", default_uri);
541 esm->server_uri = (char *) format (0, "%s%c", default_uri, 0);
544 if ((rv = parse_uri ((char *) esm->server_uri, &sep)))
545 return clib_error_return (0, "Uri parse error: %d", rv);
546 esm->transport_proto = sep.transport_proto;
547 esm->is_dgram = (sep.transport_proto == TRANSPORT_PROTO_UDP);
549 rv = echo_server_create (vm, appns_id, appns_flags, appns_secret);
553 vec_free (esm->server_uri);
554 return clib_error_return (0, "failed: server_create returned %d", rv);
561 VLIB_CLI_COMMAND (echo_server_create_command, static) =
563 .path = "test echo server",
564 .short_help = "test echo server proto <proto> [no echo][fifo-size <mbytes>]"
565 "[rcv-buf-size <bytes>][prealloc-fifos <count>]"
566 "[private-segment-count <count>][private-segment-size <bytes[m|g]>]"
567 "[uri <tcp://ip/port>]",
568 .function = echo_server_create_command_fn,
573 echo_server_main_init (vlib_main_t * vm)
575 echo_server_main_t *esm = &echo_server_main;
576 esm->my_client_index = ~0;
580 VLIB_INIT_FUNCTION (echo_server_main_init);
583 * fd.io coding-style-patch-verification: ON
586 * eval: (c-set-style "gnu")