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>
24 * Server app parameters
26 svm_queue_t **vpp_queue;
27 svm_queue_t *vl_input_queue; /**< Sever's event queue */
29 u32 app_index; /**< Server app index */
30 u32 my_client_index; /**< API client handle */
31 u32 node_index; /**< process node index for evnt scheduling */
36 u8 no_echo; /**< Don't echo traffic */
37 u32 fifo_size; /**< Fifo size */
38 u32 rcv_buffer_size; /**< Rcv buffer size */
39 u32 prealloc_fifos; /**< Preallocate fifos */
40 u32 private_segment_count; /**< Number of private segments */
41 u32 private_segment_size; /**< Size of private segments */
42 char *server_uri; /**< Server URI */
43 u32 tls_engine; /**< TLS engine: mbedtls/openssl */
47 u8 **rx_buf; /**< Per-thread RX buffer */
51 vlib_main_t *vlib_main;
54 echo_server_main_t echo_server_main;
57 echo_server_session_accept_callback (stream_session_t * s)
59 echo_server_main_t *esm = &echo_server_main;
61 esm->vpp_queue[s->thread_index] =
62 session_manager_get_vpp_event_queue (s->thread_index);
63 s->session_state = SESSION_STATE_READY;
65 vec_validate (esm->rx_retries[s->thread_index], s->session_index);
66 esm->rx_retries[s->thread_index][s->session_index] = 0;
71 echo_server_session_disconnect_callback (stream_session_t * s)
73 echo_server_main_t *esm = &echo_server_main;
74 vnet_disconnect_args_t _a, *a = &_a;
76 a->handle = session_handle (s);
77 a->app_index = esm->app_index;
78 vnet_disconnect_session (a);
82 echo_server_session_reset_callback (stream_session_t * s)
84 clib_warning ("Reset session %U", format_stream_session, s, 2);
85 stream_session_cleanup (s);
89 echo_server_session_connected_callback (u32 app_index, u32 api_context,
90 stream_session_t * s, u8 is_fail)
92 clib_warning ("called...");
97 echo_server_add_segment_callback (u32 client_index, const ssvm_private_t * sp)
99 /* New heaps may be added */
104 echo_server_redirect_connect_callback (u32 client_index, void *mp)
106 clib_warning ("called...");
111 test_bytes (echo_server_main_t * esm, int actual_transfer)
114 u32 my_thread_id = vlib_get_thread_index ();
116 for (i = 0; i < actual_transfer; i++)
118 if (esm->rx_buf[my_thread_id][i] != ((esm->byte_index + i) & 0xff))
120 clib_warning ("at %lld expected %d got %d", esm->byte_index + i,
121 (esm->byte_index + i) & 0xff,
122 esm->rx_buf[my_thread_id][i]);
125 esm->byte_index += actual_transfer;
129 * If no-echo, just read the data and be done with it
132 echo_server_builtin_server_rx_callback_no_echo (stream_session_t * s)
134 echo_server_main_t *esm = &echo_server_main;
135 u32 my_thread_id = vlib_get_thread_index ();
139 rx_fifo = s->server_rx_fifo;
144 svm_fifo_dequeue_nowait (rx_fifo, esm->rcv_buffer_size,
145 esm->rx_buf[my_thread_id]);
147 while (actual_transfer > 0);
152 echo_server_rx_callback (stream_session_t * s)
154 u32 n_written, max_dequeue, max_enqueue, max_transfer;
156 svm_fifo_t *tx_fifo, *rx_fifo;
157 echo_server_main_t *esm = &echo_server_main;
158 session_fifo_event_t evt;
159 u32 thread_index = vlib_get_thread_index ();
161 ASSERT (s->thread_index == thread_index);
163 rx_fifo = s->server_rx_fifo;
164 tx_fifo = s->server_tx_fifo;
166 ASSERT (rx_fifo->master_thread_index == thread_index);
167 ASSERT (tx_fifo->master_thread_index == thread_index);
169 max_dequeue = svm_fifo_max_dequeue (s->server_rx_fifo);
170 max_enqueue = svm_fifo_max_enqueue (s->server_tx_fifo);
172 if (PREDICT_FALSE (max_dequeue == 0))
175 /* Number of bytes we're going to copy */
176 max_transfer = (max_dequeue < max_enqueue) ? max_dequeue : max_enqueue;
178 /* No space in tx fifo */
179 if (PREDICT_FALSE (max_transfer == 0))
181 /* XXX timeout for session that are stuck */
184 /* Program self-tap to retry */
185 if (svm_fifo_set_event (rx_fifo))
189 evt.event_type = FIFO_EVENT_BUILTIN_RX;
191 q = esm->vpp_queue[thread_index];
192 if (PREDICT_FALSE (q->cursize == q->maxsize))
193 clib_warning ("out of event queue space");
194 else if (svm_queue_add (q, (u8 *) & evt, 0))
195 clib_warning ("failed to enqueue self-tap");
197 if (esm->rx_retries[thread_index][s->session_index] == 500000)
199 clib_warning ("session stuck: %U", format_stream_session, s, 2);
201 if (esm->rx_retries[thread_index][s->session_index] < 500001)
202 esm->rx_retries[thread_index][s->session_index]++;
208 _vec_len (esm->rx_buf[thread_index]) = max_transfer;
210 actual_transfer = svm_fifo_dequeue_nowait (rx_fifo, max_transfer,
211 esm->rx_buf[thread_index]);
212 ASSERT (actual_transfer == max_transfer);
214 // test_bytes (esm, actual_transfer);
220 n_written = svm_fifo_enqueue_nowait (tx_fifo, actual_transfer,
221 esm->rx_buf[thread_index]);
223 if (n_written != max_transfer)
224 clib_warning ("short trout!");
226 if (svm_fifo_set_event (tx_fifo))
228 /* Fabricate TX event, send to vpp */
230 evt.event_type = FIFO_EVENT_APP_TX;
232 if (svm_queue_add (esm->vpp_queue[s->thread_index],
233 (u8 *) & evt, 0 /* do wait for mutex */ ))
234 clib_warning ("failed to enqueue tx evt");
237 if (PREDICT_FALSE (n_written < max_dequeue))
243 static session_cb_vft_t echo_server_session_cb_vft = {
244 .session_accept_callback = echo_server_session_accept_callback,
245 .session_disconnect_callback = echo_server_session_disconnect_callback,
246 .session_connected_callback = echo_server_session_connected_callback,
247 .add_segment_callback = echo_server_add_segment_callback,
248 .builtin_app_rx_callback = echo_server_rx_callback,
249 .session_reset_callback = echo_server_session_reset_callback
252 /* Abuse VPP's input queue */
254 create_api_loopback (vlib_main_t * vm)
256 echo_server_main_t *esm = &echo_server_main;
257 api_main_t *am = &api_main;
258 vl_shmem_hdr_t *shmem_hdr;
260 shmem_hdr = am->shmem_hdr;
261 esm->vl_input_queue = shmem_hdr->vl_input_queue;
262 esm->my_client_index = vl_api_memclnt_create_internal ("echo_server",
263 esm->vl_input_queue);
268 echo_server_attach (u8 * appns_id, u64 appns_flags, u64 appns_secret)
270 vnet_app_add_tls_cert_args_t _a_cert, *a_cert = &_a_cert;
271 vnet_app_add_tls_key_args_t _a_key, *a_key = &_a_key;
272 echo_server_main_t *esm = &echo_server_main;
273 vnet_app_attach_args_t _a, *a = &_a;
274 u64 options[APP_OPTIONS_N_OPTIONS];
275 u32 segment_size = 512 << 20;
277 memset (a, 0, sizeof (*a));
278 memset (options, 0, sizeof (options));
281 echo_server_session_cb_vft.builtin_app_rx_callback =
282 echo_server_builtin_server_rx_callback_no_echo;
284 echo_server_session_cb_vft.builtin_app_rx_callback =
285 echo_server_rx_callback;
287 if (esm->private_segment_size)
288 segment_size = esm->private_segment_size;
290 a->api_client_index = esm->my_client_index;
291 a->session_cb_vft = &echo_server_session_cb_vft;
292 a->options = options;
293 a->options[APP_OPTIONS_SEGMENT_SIZE] = segment_size;
294 a->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = segment_size;
295 a->options[APP_OPTIONS_RX_FIFO_SIZE] = esm->fifo_size;
296 a->options[APP_OPTIONS_TX_FIFO_SIZE] = esm->fifo_size;
297 a->options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = esm->private_segment_count;
298 a->options[APP_OPTIONS_TLS_ENGINE] = esm->tls_engine;
299 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
300 esm->prealloc_fifos ? esm->prealloc_fifos : 1;
302 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
305 a->namespace_id = appns_id;
306 a->options[APP_OPTIONS_FLAGS] |= appns_flags;
307 a->options[APP_OPTIONS_NAMESPACE_SECRET] = appns_secret;
310 if (vnet_application_attach (a))
312 clib_warning ("failed to attach server");
315 esm->app_index = a->app_index;
317 memset (a_cert, 0, sizeof (*a_cert));
318 a_cert->app_index = a->app_index;
319 vec_validate (a_cert->cert, test_srv_crt_rsa_len);
320 clib_memcpy (a_cert->cert, test_srv_crt_rsa, test_srv_crt_rsa_len);
321 vnet_app_add_tls_cert (a_cert);
323 memset (a_key, 0, sizeof (*a_key));
324 a_key->app_index = a->app_index;
325 vec_validate (a_key->key, test_srv_key_rsa_len);
326 clib_memcpy (a_key->key, test_srv_key_rsa, test_srv_key_rsa_len);
327 vnet_app_add_tls_key (a_key);
332 echo_server_detach (void)
334 echo_server_main_t *esm = &echo_server_main;
335 vnet_app_detach_args_t _da, *da = &_da;
338 da->app_index = esm->app_index;
339 rv = vnet_application_detach (da);
345 echo_server_listen ()
347 echo_server_main_t *esm = &echo_server_main;
348 vnet_bind_args_t _a, *a = &_a;
349 memset (a, 0, sizeof (*a));
350 a->app_index = esm->app_index;
351 a->uri = esm->server_uri;
352 return vnet_bind_uri (a);
356 echo_server_create (vlib_main_t * vm, u8 * appns_id, u64 appns_flags,
359 echo_server_main_t *esm = &echo_server_main;
360 vlib_thread_main_t *vtm = vlib_get_thread_main ();
364 if (esm->my_client_index == (u32) ~ 0)
366 if (create_api_loopback (vm))
368 clib_warning ("failed to create api loopback");
373 num_threads = 1 /* main thread */ + vtm->n_threads;
374 vec_validate (echo_server_main.vpp_queue, num_threads - 1);
375 vec_validate (esm->rx_buf, num_threads - 1);
376 vec_validate (esm->rx_retries, num_threads - 1);
378 for (i = 0; i < num_threads; i++)
379 vec_validate (esm->rx_buf[i], esm->rcv_buffer_size);
381 if (echo_server_attach (appns_id, appns_flags, appns_secret))
383 clib_warning ("failed to attach server");
386 if (echo_server_listen ())
388 clib_warning ("failed to start listening");
389 if (echo_server_detach ())
390 clib_warning ("failed to detach");
396 static clib_error_t *
397 echo_server_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
398 vlib_cli_command_t * cmd)
400 echo_server_main_t *esm = &echo_server_main;
401 u8 server_uri_set = 0, *appns_id = 0;
402 u64 tmp, appns_flags = 0, appns_secret = 0;
403 char *default_uri = "tcp://0.0.0.0/1234";
407 esm->fifo_size = 64 << 10;
408 esm->rcv_buffer_size = 128 << 10;
409 esm->prealloc_fifos = 0;
410 esm->private_segment_count = 0;
411 esm->private_segment_size = 0;
412 esm->tls_engine = TLS_ENGINE_OPENSSL;
413 vec_free (esm->server_uri);
415 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
417 if (unformat (input, "uri %s", &esm->server_uri))
419 else if (unformat (input, "no-echo"))
421 else if (unformat (input, "fifo-size %d", &esm->fifo_size))
422 esm->fifo_size <<= 10;
423 else if (unformat (input, "rcv-buf-size %d", &esm->rcv_buffer_size))
425 else if (unformat (input, "prealloc-fifos %d", &esm->prealloc_fifos))
427 else if (unformat (input, "private-segment-count %d",
428 &esm->private_segment_count))
430 else if (unformat (input, "private-segment-size %U",
431 unformat_memory_size, &tmp))
433 if (tmp >= 0x100000000ULL)
434 return clib_error_return
435 (0, "private segment size %lld (%llu) too large", tmp, tmp);
436 esm->private_segment_size = tmp;
438 else if (unformat (input, "appns %_%v%_", &appns_id))
440 else if (unformat (input, "all-scope"))
441 appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
442 | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
443 else if (unformat (input, "local-scope"))
444 appns_flags |= APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
445 else if (unformat (input, "global-scope"))
446 appns_flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
447 else if (unformat (input, "secret %lu", &appns_secret))
449 else if (unformat (input, "stop"))
451 else if (unformat (input, "tls-engine %d", &esm->tls_engine))
454 return clib_error_return (0, "failed: unknown input `%U'",
455 format_unformat_error, input);
460 if (esm->app_index == (u32) ~ 0)
462 clib_warning ("server not running");
463 return clib_error_return (0, "failed: server not running");
465 rv = echo_server_detach ();
468 clib_warning ("failed: detach");
469 return clib_error_return (0, "failed: server detach %d", rv);
474 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
478 clib_warning ("No uri provided! Using default: %s", default_uri);
479 esm->server_uri = (char *) format (0, "%s%c", default_uri, 0);
482 rv = echo_server_create (vm, appns_id, appns_flags, appns_secret);
486 vec_free (esm->server_uri);
487 return clib_error_return (0, "failed: server_create returned %d", rv);
494 VLIB_CLI_COMMAND (echo_server_create_command, static) =
496 .path = "test echo server",
497 .short_help = "test echo server proto <proto> [no echo][fifo-size <mbytes>]"
498 "[rcv-buf-size <bytes>][prealloc-fifos <count>]"
499 "[private-segment-count <count>][private-segment-size <bytes[m|g]>]"
500 "[uri <tcp://ip/port>]",
501 .function = echo_server_create_command_fn,
506 echo_server_main_init (vlib_main_t * vm)
508 echo_server_main_t *esm = &echo_server_main;
509 esm->my_client_index = ~0;
513 VLIB_INIT_FUNCTION (echo_server_main_init);
516 * fd.io coding-style-patch-verification: ON
519 * eval: (c-set-style "gnu")