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 unix_shared_memory_queue_t **vpp_queue;
27 unix_shared_memory_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 */
47 u8 **rx_buf; /**< Per-thread RX buffer */
51 vlib_main_t *vlib_main;
52 } builtin_server_main_t;
54 builtin_server_main_t builtin_server_main;
57 builtin_session_accept_callback (stream_session_t * s)
59 builtin_server_main_t *bsm = &builtin_server_main;
61 bsm->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 (bsm->rx_retries[s->thread_index], s->session_index);
66 bsm->rx_retries[s->thread_index][s->session_index] = 0;
71 builtin_session_disconnect_callback (stream_session_t * s)
73 builtin_server_main_t *bsm = &builtin_server_main;
74 vnet_disconnect_args_t _a, *a = &_a;
76 a->handle = session_handle (s);
77 a->app_index = bsm->app_index;
78 vnet_disconnect_session (a);
82 builtin_session_reset_callback (stream_session_t * s)
84 clib_warning ("Reset session %U", format_stream_session, s, 2);
85 stream_session_cleanup (s);
90 builtin_session_connected_callback (u32 app_index, u32 api_context,
91 stream_session_t * s, u8 is_fail)
93 clib_warning ("called...");
98 builtin_add_segment_callback (u32 client_index,
99 const u8 * seg_name, u32 seg_size)
101 clib_warning ("called...");
106 builtin_redirect_connect_callback (u32 client_index, void *mp)
108 clib_warning ("called...");
113 test_bytes (builtin_server_main_t * bsm, int actual_transfer)
116 u32 my_thread_id = vlib_get_thread_index ();
118 for (i = 0; i < actual_transfer; i++)
120 if (bsm->rx_buf[my_thread_id][i] != ((bsm->byte_index + i) & 0xff))
122 clib_warning ("at %lld expected %d got %d", bsm->byte_index + i,
123 (bsm->byte_index + i) & 0xff,
124 bsm->rx_buf[my_thread_id][i]);
127 bsm->byte_index += actual_transfer;
131 * If no-echo, just read the data and be done with it
134 builtin_server_rx_callback_no_echo (stream_session_t * s)
136 builtin_server_main_t *bsm = &builtin_server_main;
137 u32 my_thread_id = vlib_get_thread_index ();
141 rx_fifo = s->server_rx_fifo;
146 svm_fifo_dequeue_nowait (rx_fifo, bsm->rcv_buffer_size,
147 bsm->rx_buf[my_thread_id]);
149 while (actual_transfer > 0);
154 builtin_server_rx_callback (stream_session_t * s)
156 u32 n_written, max_dequeue, max_enqueue, max_transfer;
158 svm_fifo_t *tx_fifo, *rx_fifo;
159 builtin_server_main_t *bsm = &builtin_server_main;
160 session_fifo_event_t evt;
161 u32 thread_index = vlib_get_thread_index ();
163 ASSERT (s->thread_index == thread_index);
165 rx_fifo = s->server_rx_fifo;
166 tx_fifo = s->server_tx_fifo;
168 ASSERT (rx_fifo->master_thread_index == thread_index);
169 ASSERT (tx_fifo->master_thread_index == thread_index);
171 max_dequeue = svm_fifo_max_dequeue (s->server_rx_fifo);
172 max_enqueue = svm_fifo_max_enqueue (s->server_tx_fifo);
174 if (PREDICT_FALSE (max_dequeue == 0))
177 /* Number of bytes we're going to copy */
178 max_transfer = (max_dequeue < max_enqueue) ? max_dequeue : max_enqueue;
180 /* No space in tx fifo */
181 if (PREDICT_FALSE (max_transfer == 0))
183 /* XXX timeout for session that are stuck */
186 /* Program self-tap to retry */
187 if (svm_fifo_set_event (rx_fifo))
189 unix_shared_memory_queue_t *q;
191 evt.event_type = FIFO_EVENT_BUILTIN_RX;
193 q = bsm->vpp_queue[thread_index];
194 if (PREDICT_FALSE (q->cursize == q->maxsize))
195 clib_warning ("out of event queue space");
196 else if (unix_shared_memory_queue_add (q, (u8 *) & evt, 0))
197 clib_warning ("failed to enqueue self-tap");
199 if (bsm->rx_retries[thread_index][s->session_index] == 500000)
201 clib_warning ("session stuck: %U", format_stream_session, s, 2);
203 if (bsm->rx_retries[thread_index][s->session_index] < 500001)
204 bsm->rx_retries[thread_index][s->session_index]++;
210 _vec_len (bsm->rx_buf[thread_index]) = max_transfer;
212 actual_transfer = svm_fifo_dequeue_nowait (rx_fifo, max_transfer,
213 bsm->rx_buf[thread_index]);
214 ASSERT (actual_transfer == max_transfer);
216 // test_bytes (bsm, actual_transfer);
222 n_written = svm_fifo_enqueue_nowait (tx_fifo, actual_transfer,
223 bsm->rx_buf[thread_index]);
225 if (n_written != max_transfer)
226 clib_warning ("short trout!");
228 if (svm_fifo_set_event (tx_fifo))
230 /* Fabricate TX event, send to vpp */
232 evt.event_type = FIFO_EVENT_APP_TX;
234 if (unix_shared_memory_queue_add (bsm->vpp_queue[s->thread_index],
236 0 /* do wait for mutex */ ))
237 clib_warning ("failed to enqueue tx evt");
240 if (PREDICT_FALSE (n_written < max_dequeue))
246 static session_cb_vft_t builtin_session_cb_vft = {
247 .session_accept_callback = builtin_session_accept_callback,
248 .session_disconnect_callback = builtin_session_disconnect_callback,
249 .session_connected_callback = builtin_session_connected_callback,
250 .add_segment_callback = builtin_add_segment_callback,
251 .redirect_connect_callback = builtin_redirect_connect_callback,
252 .builtin_server_rx_callback = builtin_server_rx_callback,
253 .session_reset_callback = builtin_session_reset_callback
256 /* Abuse VPP's input queue */
258 create_api_loopback (vlib_main_t * vm)
260 builtin_server_main_t *bsm = &builtin_server_main;
261 api_main_t *am = &api_main;
262 vl_shmem_hdr_t *shmem_hdr;
264 shmem_hdr = am->shmem_hdr;
265 bsm->vl_input_queue = shmem_hdr->vl_input_queue;
266 bsm->my_client_index =
267 vl_api_memclnt_create_internal ("tcp_test_server", bsm->vl_input_queue);
272 server_attach (u8 * appns_id, u64 appns_flags, u64 appns_secret)
274 builtin_server_main_t *bsm = &builtin_server_main;
275 u8 segment_name[128];
276 u64 options[SESSION_OPTIONS_N_OPTIONS];
277 vnet_app_attach_args_t _a, *a = &_a;
279 memset (a, 0, sizeof (*a));
280 memset (options, 0, sizeof (options));
283 builtin_session_cb_vft.builtin_server_rx_callback =
284 builtin_server_rx_callback_no_echo;
286 builtin_session_cb_vft.builtin_server_rx_callback =
287 builtin_server_rx_callback;
288 a->api_client_index = bsm->my_client_index;
289 a->session_cb_vft = &builtin_session_cb_vft;
290 a->options = options;
291 a->options[SESSION_OPTIONS_SEGMENT_SIZE] = 512 << 20;
292 a->options[SESSION_OPTIONS_RX_FIFO_SIZE] = bsm->fifo_size;
293 a->options[SESSION_OPTIONS_TX_FIFO_SIZE] = bsm->fifo_size;
294 a->options[APP_OPTIONS_PRIVATE_SEGMENT_COUNT] = bsm->private_segment_count;
295 a->options[APP_OPTIONS_PRIVATE_SEGMENT_SIZE] = bsm->private_segment_size;
296 a->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
297 bsm->prealloc_fifos ? bsm->prealloc_fifos : 1;
299 a->options[APP_OPTIONS_FLAGS] = APP_OPTIONS_FLAGS_IS_BUILTIN;
302 a->namespace_id = appns_id;
303 a->options[APP_OPTIONS_FLAGS] |= appns_flags;
304 a->options[APP_OPTIONS_NAMESPACE_SECRET] = appns_secret;
306 a->segment_name = segment_name;
307 a->segment_name_length = ARRAY_LEN (segment_name);
309 if (vnet_application_attach (a))
311 clib_warning ("failed to attach server");
314 bsm->app_index = a->app_index;
321 builtin_server_main_t *bsm = &builtin_server_main;
322 vnet_bind_args_t _a, *a = &_a;
323 memset (a, 0, sizeof (*a));
324 a->app_index = bsm->app_index;
325 a->uri = bsm->server_uri;
326 return vnet_bind_uri (a);
330 server_create (vlib_main_t * vm, u8 * appns_id, u64 appns_flags,
333 builtin_server_main_t *bsm = &builtin_server_main;
334 vlib_thread_main_t *vtm = vlib_get_thread_main ();
338 if (bsm->my_client_index == (u32) ~ 0)
340 if (create_api_loopback (vm))
342 clib_warning ("failed to create api loopback");
347 num_threads = 1 /* main thread */ + vtm->n_threads;
348 vec_validate (builtin_server_main.vpp_queue, num_threads - 1);
349 vec_validate (bsm->rx_buf, num_threads - 1);
350 vec_validate (bsm->rx_retries, num_threads - 1);
352 for (i = 0; i < num_threads; i++)
353 vec_validate (bsm->rx_buf[i], bsm->rcv_buffer_size);
355 if (server_attach (appns_id, appns_flags, appns_secret))
357 clib_warning ("failed to attach server");
360 if (server_listen ())
362 clib_warning ("failed to start listening");
368 static clib_error_t *
369 server_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
370 vlib_cli_command_t * cmd)
372 builtin_server_main_t *bsm = &builtin_server_main;
373 u8 server_uri_set = 0, *appns_id = 0;
374 u64 tmp, appns_flags = 0, appns_secret = 0;
378 bsm->fifo_size = 64 << 10;
379 bsm->rcv_buffer_size = 128 << 10;
380 bsm->prealloc_fifos = 0;
381 bsm->private_segment_count = 0;
382 bsm->private_segment_size = 0;
383 vec_free (bsm->server_uri);
385 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
387 if (unformat (input, "no-echo"))
389 else if (unformat (input, "fifo-size %d", &bsm->fifo_size))
390 bsm->fifo_size <<= 10;
391 else if (unformat (input, "rcv-buf-size %d", &bsm->rcv_buffer_size))
393 else if (unformat (input, "prealloc-fifos %d", &bsm->prealloc_fifos))
395 else if (unformat (input, "private-segment-count %d",
396 &bsm->private_segment_count))
398 else if (unformat (input, "private-segment-size %U",
399 unformat_memory_size, &tmp))
401 if (tmp >= 0x100000000ULL)
402 return clib_error_return
403 (0, "private segment size %lld (%llu) too large", tmp, tmp);
404 bsm->private_segment_size = tmp;
406 else if (unformat (input, "uri %s", &bsm->server_uri))
408 else if (unformat (input, "appns %_%v%_", &appns_id))
410 else if (unformat (input, "all-scope"))
411 appns_flags |= (APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE
412 | APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE);
413 else if (unformat (input, "local-scope"))
414 appns_flags |= APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE;
415 else if (unformat (input, "global-scope"))
416 appns_flags |= APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE;
417 else if (unformat (input, "secret %lu", &appns_secret))
420 return clib_error_return (0, "unknown input `%U'",
421 format_unformat_error, input);
424 vnet_session_enable_disable (vm, 1 /* turn on TCP, etc. */ );
427 bsm->server_uri = (char *) format (0, "tcp://0.0.0.0/1234%c", 0);
429 rv = server_create (vm, appns_id, appns_flags, appns_secret);
436 return clib_error_return (0, "server_create returned %d", rv);
443 VLIB_CLI_COMMAND (server_create_command, static) =
445 .path = "test tcp server",
446 .short_help = "test tcp server [no echo][fifo-size <mbytes>] "
447 "[rcv-buf-size <bytes>][prealloc-fifos <count>]"
448 "[private-segment-count <count>][private-segment-size <bytes[m|g]>]"
449 "[uri <tcp://ip/port>]",
450 .function = server_create_command_fn,
455 builtin_tcp_server_main_init (vlib_main_t * vm)
457 builtin_server_main_t *bsm = &builtin_server_main;
458 bsm->my_client_index = ~0;
462 VLIB_INIT_FUNCTION (builtin_tcp_server_main_init);
465 * fd.io coding-style-patch-verification: ON
468 * eval: (c-set-style "gnu")